@workast/sdk 3.0.0 → 3.1.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 CHANGED
@@ -5,7 +5,7 @@ interface RequestOptions {
5
5
 
6
6
  /**
7
7
  * This file was generated by scripts/generate-types.mjs. Do not edit.
8
- * Source swagger SHA-256: be9f451bbac4f67dfe07c4aeca0574d2d7eb021b16ac465d15fdd91b76cfbccc
8
+ * Source swagger SHA-256: ffefeeb250be1f2cfa1b6cdd478c4547a1b003dd0e590924dfbecd6d2862164c
9
9
  */
10
10
 
11
11
  interface paths {
@@ -1264,7 +1264,36 @@ interface paths {
1264
1264
  }
1265
1265
  interface components {
1266
1266
  schemas: {
1267
- /** @description GET /calendar/events body. Each item is a Nylas event enriched by Meeting.enrichCalendarEventsForUser. */
1267
+ /**
1268
+ * @description GET /calendar/events body. Each item is a Nylas event enriched by Meeting.enrichCalendarEventsForUser.
1269
+ * @example {
1270
+ * "events": [
1271
+ * {
1272
+ * "busy": true,
1273
+ * "calendarId": "grace@example.com",
1274
+ * "createdAt": 1781850701,
1275
+ * "icalUid": "3b5ei15dmlrh6et2aqf7q07hbk@example.com",
1276
+ * "id": "3b5ei15dmlrh6et2aqf7q07hbk",
1277
+ * "organizer": {
1278
+ * "email": "grace@example.com",
1279
+ * "name": "Grace Hopper"
1280
+ * },
1281
+ * "participants": [],
1282
+ * "readOnly": false,
1283
+ * "status": "confirmed",
1284
+ * "title": "Standup",
1285
+ * "updatedAt": 1782098660,
1286
+ * "visibility": "default",
1287
+ * "when": {
1288
+ * "endDate": "2026-07-18",
1289
+ * "object": "datespan",
1290
+ * "startDate": "2026-06-27"
1291
+ * },
1292
+ * "meeting": null
1293
+ * }
1294
+ * ]
1295
+ * }
1296
+ */
1268
1297
  CalendarEvents: {
1269
1298
  /** @description Calendar events in the requested timeframe, excluding Workast task-backed events. */
1270
1299
  events: components["schemas"]["CalendarEvent"][];
@@ -1422,7 +1451,38 @@ interface components {
1422
1451
  */
1423
1452
  preferredListId?: string | null;
1424
1453
  };
1425
- /** @description Custom field. Built by Field.buildResource. */
1454
+ /**
1455
+ * @description Custom field. Built by Field.buildResource.
1456
+ * @example {
1457
+ * "id": "61a50f7ed892d94d8c9d285e",
1458
+ * "name": "Priority",
1459
+ * "description": "Ship v3",
1460
+ * "type": "options",
1461
+ * "useAsTaskColor": false,
1462
+ * "options": [
1463
+ * {
1464
+ * "id": "61a50f7ed892d94d8c9d285f",
1465
+ * "name": "Low",
1466
+ * "color": "#F2994A"
1467
+ * },
1468
+ * {
1469
+ * "id": "63ec2019d467b10e1de14f02",
1470
+ * "name": "Medium",
1471
+ * "color": "#20e48b"
1472
+ * },
1473
+ * {
1474
+ * "id": "63ec2019d467b10e1de14f03",
1475
+ * "name": "Normal",
1476
+ * "color": "#1156ff"
1477
+ * },
1478
+ * {
1479
+ * "id": "63ec2019d467b10e1de14f04",
1480
+ * "name": "High",
1481
+ * "color": "#f50c0c"
1482
+ * }
1483
+ * ]
1484
+ * }
1485
+ */
1426
1486
  CustomField: {
1427
1487
  /** @description The id of the custom field */
1428
1488
  id: string;
@@ -1514,7 +1574,24 @@ interface components {
1514
1574
  */
1515
1575
  value: string;
1516
1576
  }[];
1517
- /** @description GET /meeting/{meetingId}/recording body. Built by the getRecording handler. Both keys omitted when nil, so the body may be {}. */
1577
+ /**
1578
+ * @description GET /meeting/{meetingId}/recording body. Built by the getRecording handler. Both keys omitted when nil, so the body may be {}.
1579
+ * @example {
1580
+ * "transcript": {
1581
+ * "object": "transcript",
1582
+ * "type": "speaker_labelled",
1583
+ * "language": "es",
1584
+ * "transcript": [
1585
+ * {
1586
+ * "speaker": "Speaker A",
1587
+ * "start": 37850,
1588
+ * "end": 116040,
1589
+ * "text": "Standup"
1590
+ * }
1591
+ * ]
1592
+ * }
1593
+ * }
1594
+ */
1518
1595
  MeetingRecordingResource: {
1519
1596
  media?: components["schemas"]["MeetingRecordingMedia"];
1520
1597
  transcript?: components["schemas"]["MeetingTranscript"];
@@ -1563,7 +1640,77 @@ interface components {
1563
1640
  end?: number;
1564
1641
  text?: string;
1565
1642
  };
1566
- /** @description Paginated meetings from GET /meeting. Each item from Meeting.buildMinimalResource. */
1643
+ /**
1644
+ * @description Paginated meetings from GET /meeting. Each item from Meeting.buildMinimalResource.
1645
+ * @example {
1646
+ * "meetings": [
1647
+ * {
1648
+ * "id": "6a6840c6cc9ea3097a801627",
1649
+ * "summary": "Standup",
1650
+ * "eventId": "gobiji6ddnsgaausdrhftf2cb2_20260728T223000Z",
1651
+ * "isRecurrent": true,
1652
+ * "organizer": {
1653
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1654
+ * "name": "Grace Hopper",
1655
+ * "userName": "grace",
1656
+ * "email": "grace@example.com",
1657
+ * "platformDetails": {
1658
+ * "name": "slack",
1659
+ * "imChannel": "D3EEXS3J6",
1660
+ * "selfChannel": "D1HN843U3",
1661
+ * "userId": "U0HBQESA1",
1662
+ * "teamId": "T0HBUA0TC"
1663
+ * },
1664
+ * "confirmed": true,
1665
+ * "avatar": "https://cdn.workast.io/avatar.png",
1666
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1667
+ * },
1668
+ * "totalAttendees": 2,
1669
+ * "someAttendees": [
1670
+ * {
1671
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1672
+ * "name": "Grace Hopper",
1673
+ * "userName": "grace",
1674
+ * "email": "grace@example.com",
1675
+ * "platformDetails": {
1676
+ * "name": "slack",
1677
+ * "imChannel": "D3EEXS3J6",
1678
+ * "selfChannel": "D1HN843U3",
1679
+ * "userId": "U0HBQESA1",
1680
+ * "teamId": "T0HBUA0TC"
1681
+ * },
1682
+ * "confirmed": true,
1683
+ * "avatar": "https://cdn.workast.io/avatar.png",
1684
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1685
+ * },
1686
+ * {
1687
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
1688
+ * "name": "Katherine Johnson",
1689
+ * "userName": "katherine",
1690
+ * "email": "katherine@example.com",
1691
+ * "platformDetails": {
1692
+ * "name": "slack",
1693
+ * "imChannel": "D06JN8RT8KB",
1694
+ * "selfChannel": "D06HV290V6K",
1695
+ * "userId": "U06J9JSF6R0",
1696
+ * "teamId": "T0HBUA0TC"
1697
+ * },
1698
+ * "confirmed": false,
1699
+ * "avatar": "https://cdn.workast.io/avatar.png",
1700
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1701
+ * }
1702
+ * ],
1703
+ * "link": "https://app.workast.com/meeting/6a6840c6cc9ea3097a801627",
1704
+ * "start": "2026-07-31T00:30:00.000Z",
1705
+ * "end": "2026-07-31T02:00:00.000Z",
1706
+ * "allDay": false,
1707
+ * "totalTasks": 0,
1708
+ * "completedTasks": 0
1709
+ * }
1710
+ * ],
1711
+ * "nextPageToken": "eyJzdGFydCI6IjIwMjYtMDctMzFUMDA6MzA6MDAuMDAwWiIsImlkIjoiNmE2ODQwYzZjYzllYTMwOTdhODAxNjI3In0"
1712
+ * }
1713
+ */
1567
1714
  Meetings: {
1568
1715
  /** @description Meetings matching the filters, sorted by start then id. */
1569
1716
  meetings: components["schemas"]["MeetingMinimalResource"][];
@@ -1622,7 +1769,51 @@ interface components {
1622
1769
  * @example 2020-04-19T08:30:00-03:00
1623
1770
  */
1624
1771
  CalendarEventDate: string;
1625
- /** @description Meeting.buildResource. */
1772
+ /**
1773
+ * @description Meeting.buildResource.
1774
+ * @example {
1775
+ * "id": "6a844c4c6bc4270979c79d34",
1776
+ * "createdAt": "2026-08-18T12:13:00.327Z",
1777
+ * "updatedAt": "2026-08-18T12:13:00.327Z",
1778
+ * "summary": "Standup",
1779
+ * "status": "active",
1780
+ * "eventId": "2bi7qgtg2k615gsm4fom4oa2l8",
1781
+ * "isRecurrent": false,
1782
+ * "organizer": {
1783
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1784
+ * "name": "Grace Hopper",
1785
+ * "userName": "grace",
1786
+ * "email": "grace@example.com",
1787
+ * "platformDetails": {
1788
+ * "name": "slack",
1789
+ * "imChannel": "D3EEXS3J6",
1790
+ * "selfChannel": "D1HN843U3",
1791
+ * "userId": "U0HBQESA1",
1792
+ * "teamId": "T0HBUA0TC"
1793
+ * },
1794
+ * "confirmed": true,
1795
+ * "avatar": "https://cdn.workast.io/avatar.png",
1796
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1797
+ * },
1798
+ * "totalAttendees": 1,
1799
+ * "someAttendees": [],
1800
+ * "list": {
1801
+ * "id": "5a6ebde81519395731f90e2f",
1802
+ * "name": "Engineering",
1803
+ * "type": "group",
1804
+ * "status": "active",
1805
+ * "privacy": "private",
1806
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f"
1807
+ * },
1808
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/meeting/6a844c4c6bc4270979c79d34",
1809
+ * "notetaker": {
1810
+ * "enabled": false
1811
+ * },
1812
+ * "start": "2026-09-01T15:00:00.000Z",
1813
+ * "end": "2026-09-01T15:30:00.000Z",
1814
+ * "allDay": false
1815
+ * }
1816
+ */
1626
1817
  Meeting: {
1627
1818
  /**
1628
1819
  * @description The meeting ID.
@@ -1726,7 +1917,74 @@ interface components {
1726
1917
  /** @description User ID that requested the notetaker. Omitted when nil. */
1727
1918
  requestedBy?: string;
1728
1919
  };
1729
- /** @description GET /meeting/{meetingId} body. Meeting.buildResource plus optional legacy note. */
1920
+ /**
1921
+ * @description GET /meeting/{meetingId} body. Meeting.buildResource plus optional legacy note.
1922
+ * @example {
1923
+ * "id": "6a6840c6cc9ea3097a801627",
1924
+ * "createdAt": "2026-07-28T05:40:22.966Z",
1925
+ * "updatedAt": "2026-08-11T01:56:10.130Z",
1926
+ * "summary": "Standup",
1927
+ * "status": "active",
1928
+ * "eventId": "gobiji6ddnsgaausdrhftf2cb2_20260728T223000Z",
1929
+ * "isRecurrent": true,
1930
+ * "organizer": {
1931
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1932
+ * "name": "Grace Hopper",
1933
+ * "userName": "grace",
1934
+ * "email": "grace@example.com",
1935
+ * "platformDetails": {
1936
+ * "name": "slack",
1937
+ * "imChannel": "D3EEXS3J6",
1938
+ * "selfChannel": "D1HN843U3",
1939
+ * "userId": "U0HBQESA1",
1940
+ * "teamId": "T0HBUA0TC"
1941
+ * },
1942
+ * "confirmed": true,
1943
+ * "avatar": "https://cdn.workast.io/avatar.png",
1944
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1945
+ * },
1946
+ * "totalAttendees": 2,
1947
+ * "someAttendees": [
1948
+ * {
1949
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1950
+ * "name": "Grace Hopper",
1951
+ * "userName": "grace",
1952
+ * "email": "grace@example.com",
1953
+ * "platformDetails": {
1954
+ * "name": "slack",
1955
+ * "imChannel": "D3EEXS3J6",
1956
+ * "selfChannel": "D1HN843U3",
1957
+ * "userId": "U0HBQESA1",
1958
+ * "teamId": "T0HBUA0TC"
1959
+ * },
1960
+ * "confirmed": true,
1961
+ * "avatar": "https://cdn.workast.io/avatar.png",
1962
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1963
+ * }
1964
+ * ],
1965
+ * "list": {
1966
+ * "id": "5fc58f3d15ff9110b64ca426",
1967
+ * "type": "group",
1968
+ * "status": "active",
1969
+ * "privacy": "team",
1970
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
1971
+ * "name": "Product"
1972
+ * },
1973
+ * "link": "https://app.workast.com/meeting/6a6840c6cc9ea3097a801627",
1974
+ * "conferenceData": {
1975
+ * "joinUrl": "https://example.com/file",
1976
+ * "provider": "Google Meet"
1977
+ * },
1978
+ * "notetaker": {
1979
+ * "enabled": false
1980
+ * },
1981
+ * "start": "2026-07-31T00:30:00.000Z",
1982
+ * "end": "2026-07-31T02:00:00.000Z",
1983
+ * "allDay": false,
1984
+ * "totalTasks": 0,
1985
+ * "completedTasks": 0
1986
+ * }
1987
+ */
1730
1988
  MeetingDetail: components["schemas"]["Meeting"] & {
1731
1989
  note?: components["schemas"]["MeetingNote"];
1732
1990
  };
@@ -1827,7 +2085,11 @@ interface components {
1827
2085
  * @example https://cdn.workast.io/avatar.png
1828
2086
  */
1829
2087
  avatar: string;
1830
- costCenter: components["schemas"]["CostCenterMinimalResource"];
2088
+ /**
2089
+ * @description The cost center ID. Public user embeds do not populate the cost center.
2090
+ * @example 5c1b92b0a57d2b342c1a610e
2091
+ */
2092
+ costCenter: string;
1831
2093
  };
1832
2094
  /** @description Name-only user embed on a reaction (populate select -_id name). */
1833
2095
  ReactionUser: {
@@ -1837,7 +2099,19 @@ interface components {
1837
2099
  */
1838
2100
  name?: string;
1839
2101
  };
1840
- /** @description reactionSchema.buildResource */
2102
+ /**
2103
+ * @description reactionSchema.buildResource
2104
+ * @example {
2105
+ * "id": "6a844d5e6bc4270979c7a8ee",
2106
+ * "emoji": ":+1:",
2107
+ * "total": 1,
2108
+ * "users": [
2109
+ * {
2110
+ * "name": "Grace Hopper"
2111
+ * }
2112
+ * ]
2113
+ * }
2114
+ */
1841
2115
  ReactionReadOnly: {
1842
2116
  /**
1843
2117
  * @description The reaction ID
@@ -1970,19 +2244,61 @@ interface components {
1970
2244
  * @example false
1971
2245
  */
1972
2246
  createTaskDependencies: boolean;
1973
- storageLimit: {
1974
- /**
1975
- * @description The storage limit type.
1976
- * @example per_active_user
1977
- * @enum {string}
1978
- */
1979
- type: "fixed" | "per_active_user";
1980
- /**
1981
- * @description The storage limit size in bytes.
1982
- * @example 5368709120
1983
- */
1984
- sizeInBytes: number;
1985
- };
2247
+ /**
2248
+ * @description Storage limit in bytes (per user).
2249
+ * @example 5368709120
2250
+ */
2251
+ storageLimit: number;
2252
+ /**
2253
+ * @description Whether the creation of milestones is allowed or not.
2254
+ * @example false
2255
+ */
2256
+ createMilestones?: boolean;
2257
+ /**
2258
+ * @description Whether meetings are available or not.
2259
+ * @example false
2260
+ */
2261
+ accessMeetings?: boolean;
2262
+ /**
2263
+ * @description Whether calendar sync is allowed or not.
2264
+ * @example false
2265
+ */
2266
+ calendarSync?: boolean;
2267
+ /**
2268
+ * @description Whether downloading search results is allowed or not.
2269
+ * @example false
2270
+ */
2271
+ downloadSearch?: boolean;
2272
+ /**
2273
+ * @description Whether the creation of spaces is allowed or not.
2274
+ * @example false
2275
+ */
2276
+ createSpaces?: boolean;
2277
+ /**
2278
+ * @description Whether app login is allowed or not.
2279
+ * @example false
2280
+ */
2281
+ appLogin?: boolean;
2282
+ /**
2283
+ * @description Whether the creation of custom fields is allowed or not.
2284
+ * @example false
2285
+ */
2286
+ createFields?: boolean;
2287
+ /**
2288
+ * @description Whether the timeline view is available or not.
2289
+ * @example false
2290
+ */
2291
+ timelineView?: boolean;
2292
+ /**
2293
+ * @description Whether AI workflows are available or not.
2294
+ * @example false
2295
+ */
2296
+ aiWorkflows?: boolean;
2297
+ /**
2298
+ * @description Notetaker minutes included per month.
2299
+ * @example 600
2300
+ */
2301
+ notetakerMinutesPerMonth?: number;
1986
2302
  /**
1987
2303
  * @description Tasks visibility window in days. No limit if not present.
1988
2304
  * @example 30
@@ -2016,28 +2332,11 @@ interface components {
2016
2332
  * @example 9.99
2017
2333
  */
2018
2334
  salePrice?: number;
2019
- };
2020
- CostCenterMinimalResource: {
2021
- /**
2022
- * @description The cost center ID
2023
- * @example 5c13bcceecc21e130d77f393
2024
- */
2025
- id?: string;
2026
- /**
2027
- * @description The cost center name
2028
- * @example Marketing
2029
- */
2030
- name?: string;
2031
- /**
2032
- * @description The cost center account
2033
- * @example free
2034
- */
2035
- account?: string;
2036
2335
  /**
2037
- * @description Whether the cost center is the organization's default or not
2336
+ * @description Whether this plan is billed as a flat fee.
2038
2337
  * @example false
2039
2338
  */
2040
- isDefault?: boolean;
2339
+ flatFee?: boolean;
2041
2340
  };
2042
2341
  CostCenterResource: {
2043
2342
  /**
@@ -2065,7 +2364,11 @@ interface components {
2065
2364
  * @example free
2066
2365
  */
2067
2366
  account?: string;
2068
- createdBy?: components["schemas"]["User"];
2367
+ /**
2368
+ * @description The user ID that created the cost center. Public GET /user/me does not populate this user.
2369
+ * @example c51a9c1a2ddfbcefa7abf74036e0c616
2370
+ */
2371
+ createdBy?: string;
2069
2372
  product?: components["schemas"]["ProductRead"] & {
2070
2373
  /**
2071
2374
  * @description Whether this is a trial or not.
@@ -2190,6 +2493,56 @@ interface components {
2190
2493
  */
2191
2494
  author?: string;
2192
2495
  };
2496
+ /**
2497
+ * @example {
2498
+ * "id": "6a844d3965f82309911408ca",
2499
+ * "title": {
2500
+ * "text": "Ship v3"
2501
+ * },
2502
+ * "createdAt": "2026-08-18T12:16:57.347Z",
2503
+ * "updatedAt": "2026-08-18T12:16:57.347Z",
2504
+ * "user": {
2505
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2506
+ * "name": "Grace Hopper",
2507
+ * "userName": "grace",
2508
+ * "avatar": "https://cdn.workast.io/avatar.png",
2509
+ * "platformDetails": {
2510
+ * "name": "slack",
2511
+ * "imChannel": "D3EEXS3J6",
2512
+ * "selfChannel": "D1HN843U3",
2513
+ * "userId": "U0HBQESA1",
2514
+ * "teamId": "T0HBUA0TC"
2515
+ * }
2516
+ * },
2517
+ * "app": {
2518
+ * "id": "5d9a6b09269e415d36380d23",
2519
+ * "name": "Example App",
2520
+ * "description": "Ship v3",
2521
+ * "icon": "https://cdn.workast.io/avatar.png",
2522
+ * "createdAt": "2019-10-06T22:30:33.687Z",
2523
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
2524
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
2525
+ * "accessType": "user",
2526
+ * "developedByWorkast": true
2527
+ * },
2528
+ * "author": {
2529
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2530
+ * "name": "Grace Hopper",
2531
+ * "userName": "grace",
2532
+ * "email": "grace@example.com",
2533
+ * "platformDetails": {
2534
+ * "name": "slack",
2535
+ * "imChannel": "D3EEXS3J6",
2536
+ * "selfChannel": "D1HN843U3",
2537
+ * "userId": "U0HBQESA1",
2538
+ * "teamId": "T0HBUA0TC"
2539
+ * },
2540
+ * "confirmed": true,
2541
+ * "avatar": "https://cdn.workast.io/avatar.png",
2542
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2543
+ * }
2544
+ * }
2545
+ */
2193
2546
  Attachment: {
2194
2547
  /**
2195
2548
  * @description The unique attachment id
@@ -2211,7 +2564,40 @@ interface components {
2211
2564
  /** @description The attachment link. Present when the attachment has a file. */
2212
2565
  link?: string;
2213
2566
  };
2214
- /** @description Attachment.buildResource plus a signed fileUrl. Returned by GET /attachment/{attachmentId}/file. file, link, and fileUrl are always present because the handler 404s when the attachment has no file. */
2567
+ /**
2568
+ * @description Attachment.buildResource plus a signed fileUrl. Returned by GET /attachment/{attachmentId}/file. file, link, and fileUrl are always present because the handler 404s when the attachment has no file.
2569
+ * @example {
2570
+ * "id": "6a844fd765f8230991142151",
2571
+ * "createdAt": "2026-08-18T12:28:07.685Z",
2572
+ * "updatedAt": "2026-08-18T12:28:09.193Z",
2573
+ * "user": {
2574
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2575
+ * "virtualId": "c2xhY2svL1QwSEJVQTBUQzpVMEhCUUVTQTE=",
2576
+ * "name": "Grace Hopper",
2577
+ * "userName": "grace",
2578
+ * "avatar": "https://cdn.workast.io/avatar.png",
2579
+ * "platformDetails": {
2580
+ * "name": "slack",
2581
+ * "imChannel": "D3EEXS3J6",
2582
+ * "selfChannel": "D1HN843U3",
2583
+ * "userId": "U0HBQESA1",
2584
+ * "teamId": "T0HBUA0TC"
2585
+ * }
2586
+ * },
2587
+ * "file": {
2588
+ * "name": "avatar.png",
2589
+ * "type": "image/png",
2590
+ * "size": 17101,
2591
+ * "url": "/files/5dc40cff038a590f79c403c0/b9ca2e09-12e8-4c34-99dd-10dfaf345660",
2592
+ * "thumbnails": {
2593
+ * "250": "https://example.com/file",
2594
+ * "500": "https://example.com/file"
2595
+ * }
2596
+ * },
2597
+ * "link": "https://example.com/file",
2598
+ * "fileUrl": "https://example.com/file"
2599
+ * }
2600
+ */
2215
2601
  AttachmentFileUrl: components["schemas"]["Attachment"] & {
2216
2602
  /**
2217
2603
  * Format: uri
@@ -2245,7 +2631,31 @@ interface components {
2245
2631
  /** @description Lists to exclude from my-tasks search. Only lists the user participates in. */
2246
2632
  excludedLists?: components["schemas"]["ListHeader"][];
2247
2633
  };
2248
- /** @description Team user. Built by buildResource. */
2634
+ /**
2635
+ * @description Team user. Built by buildResource.
2636
+ * @example {
2637
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2638
+ * "createdAt": "2017-04-14T02:14:44.247Z",
2639
+ * "name": "Grace Hopper",
2640
+ * "userName": "grace",
2641
+ * "platformDetails": {
2642
+ * "name": "slack",
2643
+ * "imChannel": "D3EEXS3J6",
2644
+ * "selfChannel": "D1HN843U3",
2645
+ * "userId": "U0HBQESA1",
2646
+ * "teamId": "T0HBUA0TC"
2647
+ * },
2648
+ * "timezone": "Australia/Canberra",
2649
+ * "email": "grace@example.com",
2650
+ * "lastActive": "2026-08-18T11:29:00.207Z",
2651
+ * "role": "admin",
2652
+ * "status": "active",
2653
+ * "confirmed": true,
2654
+ * "profile": {},
2655
+ * "avatar": "https://cdn.workast.io/avatar.png",
2656
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2657
+ * }
2658
+ */
2249
2659
  UserDetail: {
2250
2660
  /**
2251
2661
  * @description The user ID
@@ -2308,9 +2718,169 @@ interface components {
2308
2718
  * @example https://avatars.slack-edge.com/2019-01-29/535865276113_da329b7dcbb39ea8e564_1024.png
2309
2719
  */
2310
2720
  avatar?: string;
2311
- costCenter?: components["schemas"]["CostCenterMinimalResource"];
2721
+ /**
2722
+ * @description The cost center ID. Public user embeds do not populate the cost center.
2723
+ * @example 5c1b92b0a57d2b342c1a610e
2724
+ */
2725
+ costCenter?: string;
2726
+ };
2727
+ /** @description GET /user/email/{email} body. UserDetail plus optional team. */
2728
+ UserDetailWithTeam: components["schemas"]["UserDetail"] & {
2729
+ team?: components["schemas"]["Team"];
2312
2730
  };
2313
- /** @description Logged-in user. Built by buildUserResource. */
2731
+ /**
2732
+ * @description Logged-in user. Built by buildUserResource.
2733
+ * @example {
2734
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2735
+ * "name": "Grace Hopper",
2736
+ * "email": "grace@example.com",
2737
+ * "userName": "grace",
2738
+ * "platformDetails": {
2739
+ * "name": "slack",
2740
+ * "imChannel": "D3EEXS3J6",
2741
+ * "selfChannel": "D1HN843U3",
2742
+ * "userId": "U0HBQESA1",
2743
+ * "teamId": "T0HBUA0TC"
2744
+ * },
2745
+ * "role": "admin",
2746
+ * "confirmed": true,
2747
+ * "avatar": "https://cdn.workast.io/avatar.png",
2748
+ * "personalListId": "5937861aa2470108bbf72e1d",
2749
+ * "team": {
2750
+ * "id": "ca19601b6bb816ca95386698b3385d49",
2751
+ * "name": "Example Team",
2752
+ * "url": "https://app.workast.com",
2753
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49",
2754
+ * "domain": "example",
2755
+ * "totalTasks": 54822,
2756
+ * "status": "active",
2757
+ * "createdAt": "2018-05-22T14:04:01.652Z",
2758
+ * "betaTester": true,
2759
+ * "platformDetails": {
2760
+ * "name": "slack",
2761
+ * "teamId": "T0HBUA0TC",
2762
+ * "url": "https://example.slack.com/",
2763
+ * "emailDomain": "example.com",
2764
+ * "teamSize": 76
2765
+ * },
2766
+ * "icon": "https://cdn.workast.io/list-avatar.png",
2767
+ * "activeUsers": 7
2768
+ * },
2769
+ * "organization": {
2770
+ * "id": "5c1b92b0a57d2b342c1a610d",
2771
+ * "name": "Example Organization",
2772
+ * "defaultCostCenter": "5c1b92b0a57d2b342c1a610e"
2773
+ * },
2774
+ * "costCenter": {
2775
+ * "id": "5c1b92b0a57d2b342c1a610e",
2776
+ * "createdAt": "2018-12-20T13:01:36.566Z",
2777
+ * "updatedAt": "2019-01-10T14:56:47.968Z",
2778
+ * "name": "Default",
2779
+ * "account": "premium",
2780
+ * "createdBy": "c51a9c1a2ddfbcefa7abf74036e0c616",
2781
+ * "product": {
2782
+ * "id": "5ddfe4b458ddf740a5393ae9",
2783
+ * "createdAt": "2019-11-28T15:16:04.653Z",
2784
+ * "updatedAt": "2020-07-30T14:55:46.510Z",
2785
+ * "name": "Professional",
2786
+ * "default": false,
2787
+ * "isPaid": true,
2788
+ * "features": {
2789
+ * "createSubtasks": true,
2790
+ * "createPrivateSpaces": true,
2791
+ * "createLists": true,
2792
+ * "createTags": true,
2793
+ * "importTemplates": true,
2794
+ * "createTemplates": true,
2795
+ * "createSearches": true,
2796
+ * "createTaskStatus": true,
2797
+ * "createGuestAccounts": true,
2798
+ * "createTaskDependencies": true,
2799
+ * "storageLimit": 5368709120,
2800
+ * "createMilestones": true,
2801
+ * "accessMeetings": true,
2802
+ * "calendarSync": true,
2803
+ * "downloadSearch": true,
2804
+ * "createSpaces": true,
2805
+ * "appLogin": true,
2806
+ * "createFields": true,
2807
+ * "timelineView": true,
2808
+ * "aiWorkflows": true,
2809
+ * "notetakerMinutesPerMonth": 600
2810
+ * },
2811
+ * "trialling": false,
2812
+ * "currentPlan": {
2813
+ * "id": "5ddfe4b458ddf740a5393aea",
2814
+ * "term": "annual",
2815
+ * "price": 9.95,
2816
+ * "flatFee": false
2817
+ * }
2818
+ * },
2819
+ * "storage": {
2820
+ * "used": 2315908683,
2821
+ * "total": 37580963840,
2822
+ * "usedPercentage": 6.16,
2823
+ * "freePercentage": 93.84
2824
+ * },
2825
+ * "isDefault": true,
2826
+ * "activeUsers": 7
2827
+ * },
2828
+ * "calendars": [],
2829
+ * "timezone": "Australia/Canberra",
2830
+ * "reminders": {
2831
+ * "channels": {
2832
+ * "slack": true,
2833
+ * "email": false
2834
+ * },
2835
+ * "days": [
2836
+ * 1,
2837
+ * 2,
2838
+ * 3,
2839
+ * 4,
2840
+ * 5
2841
+ * ],
2842
+ * "hour": 9,
2843
+ * "hourUTC": 23,
2844
+ * "taskAssignedToOthers": false,
2845
+ * "taskDueInTheFutureDays": 0
2846
+ * },
2847
+ * "notifications": {
2848
+ * "assignedToTasks": true,
2849
+ * "completedTasks": true,
2850
+ * "appAnnouncements": true,
2851
+ * "taskReminderMinutes": 30
2852
+ * },
2853
+ * "dateSettings": {
2854
+ * "startOfWeek": "monday",
2855
+ * "timeFormat": "HH",
2856
+ * "dateFormat": "M/D/Y"
2857
+ * },
2858
+ * "myTasksSearchSettings": {
2859
+ * "excludeAssignToOthers": true,
2860
+ * "excludedLists": [
2861
+ * {
2862
+ * "id": "5937861aa2470108bbf72e1d",
2863
+ * "name": "Personal tasks",
2864
+ * "type": "personal",
2865
+ * "privacy": "private"
2866
+ * },
2867
+ * {
2868
+ * "id": "59daaf15c7d6260e7f470356",
2869
+ * "name": "Product",
2870
+ * "type": "group",
2871
+ * "privacy": "team"
2872
+ * }
2873
+ * ]
2874
+ * },
2875
+ * "profile": {},
2876
+ * "storage": {
2877
+ * "used": 627473089,
2878
+ * "total": 5368709120,
2879
+ * "usedPercentage": 11.69,
2880
+ * "freePercentage": 88.31
2881
+ * }
2882
+ * }
2883
+ */
2314
2884
  UserResource: {
2315
2885
  /**
2316
2886
  * @description The user ID
@@ -2413,6 +2983,15 @@ interface components {
2413
2983
  myTasksSearchSettings?: components["schemas"]["MyTasksSearchSettings"];
2414
2984
  storage?: components["schemas"]["Storage"];
2415
2985
  };
2986
+ /**
2987
+ * @example {
2988
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2989
+ * "virtualId": "c2xhY2svL1QwSEJVQTBUQzpVMEhCUUVTQTE=",
2990
+ * "name": "Grace Hopper",
2991
+ * "userName": "grace",
2992
+ * "avatar": "https://cdn.workast.io/avatar.png"
2993
+ * }
2994
+ */
2416
2995
  User: {
2417
2996
  /** @description The user unique ID */
2418
2997
  id: string;
@@ -2426,6 +3005,27 @@ interface components {
2426
3005
  avatar?: string;
2427
3006
  platformDetails?: components["schemas"]["UserPlatformDetails"];
2428
3007
  };
3008
+ /**
3009
+ * @example {
3010
+ * "id": "ca19601b6bb816ca95386698b3385d49",
3011
+ * "name": "Example Team",
3012
+ * "url": "https://app.workast.com",
3013
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49",
3014
+ * "domain": "example",
3015
+ * "totalTasks": 54822,
3016
+ * "status": "active",
3017
+ * "createdAt": "2018-05-22T14:04:01.652Z",
3018
+ * "betaTester": true,
3019
+ * "platformDetails": {
3020
+ * "name": "slack",
3021
+ * "teamId": "T0HBUA0TC",
3022
+ * "url": "https://example.slack.com/",
3023
+ * "emailDomain": "example.com",
3024
+ * "teamSize": 76
3025
+ * },
3026
+ * "icon": "https://cdn.workast.io/list-avatar.png"
3027
+ * }
3028
+ */
2429
3029
  Team: {
2430
3030
  /**
2431
3031
  * @description The team unique ID.
@@ -2599,6 +3199,329 @@ interface components {
2599
3199
  */
2600
3200
  width?: number;
2601
3201
  };
3202
+ /**
3203
+ * @example {
3204
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3205
+ * "createdAt": "2022-01-10T12:12:46.308Z",
3206
+ * "createdBy": {
3207
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3208
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3209
+ * "name": "Ada Lovelace",
3210
+ * "userName": "ada",
3211
+ * "platformDetails": {
3212
+ * "name": "slack",
3213
+ * "imChannel": "D3F5RQA6B",
3214
+ * "selfChannel": "D1LGYBCFQ",
3215
+ * "userId": "U0JU26WRG",
3216
+ * "teamId": "T0HBUA0TC"
3217
+ * },
3218
+ * "timezone": "Australia/Canberra",
3219
+ * "email": "ada@example.com",
3220
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3221
+ * "role": "admin",
3222
+ * "status": "active",
3223
+ * "confirmed": true,
3224
+ * "profile": {},
3225
+ * "avatar": "https://cdn.workast.io/avatar.png",
3226
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3227
+ * },
3228
+ * "shortId": "T4GNY",
3229
+ * "text": "Ship v3",
3230
+ * "assignedTo": [
3231
+ * {
3232
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3233
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3234
+ * "name": "Ada Lovelace",
3235
+ * "userName": "ada",
3236
+ * "platformDetails": {
3237
+ * "name": "slack",
3238
+ * "imChannel": "D3F5RQA6B",
3239
+ * "selfChannel": "D1LGYBCFQ",
3240
+ * "userId": "U0JU26WRG",
3241
+ * "teamId": "T0HBUA0TC"
3242
+ * },
3243
+ * "timezone": "Australia/Canberra",
3244
+ * "email": "ada@example.com",
3245
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3246
+ * "role": "admin",
3247
+ * "status": "active",
3248
+ * "confirmed": true,
3249
+ * "profile": {},
3250
+ * "avatar": "https://cdn.workast.io/avatar.png",
3251
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3252
+ * }
3253
+ * ],
3254
+ * "subscribers": [
3255
+ * {
3256
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3257
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3258
+ * "name": "Ada Lovelace",
3259
+ * "userName": "ada",
3260
+ * "platformDetails": {
3261
+ * "name": "slack",
3262
+ * "imChannel": "D3F5RQA6B",
3263
+ * "selfChannel": "D1LGYBCFQ",
3264
+ * "userId": "U0JU26WRG",
3265
+ * "teamId": "T0HBUA0TC"
3266
+ * },
3267
+ * "timezone": "Australia/Canberra",
3268
+ * "email": "ada@example.com",
3269
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3270
+ * "role": "admin",
3271
+ * "status": "active",
3272
+ * "confirmed": true,
3273
+ * "profile": {},
3274
+ * "avatar": "https://cdn.workast.io/avatar.png",
3275
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3276
+ * },
3277
+ * {
3278
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3279
+ * "createdAt": "2017-04-14T02:14:44.247Z",
3280
+ * "name": "Grace Hopper",
3281
+ * "userName": "grace",
3282
+ * "platformDetails": {
3283
+ * "name": "slack",
3284
+ * "imChannel": "D3EEXS3J6",
3285
+ * "selfChannel": "D1HN843U3",
3286
+ * "userId": "U0HBQESA1",
3287
+ * "teamId": "T0HBUA0TC"
3288
+ * },
3289
+ * "timezone": "Australia/Canberra",
3290
+ * "email": "grace@example.com",
3291
+ * "lastActive": "2026-08-18T11:29:00.207Z",
3292
+ * "role": "admin",
3293
+ * "status": "active",
3294
+ * "confirmed": true,
3295
+ * "profile": {},
3296
+ * "avatar": "https://cdn.workast.io/avatar.png",
3297
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3298
+ * }
3299
+ * ],
3300
+ * "status": "pending",
3301
+ * "allDay": false,
3302
+ * "priority": 0,
3303
+ * "description": "Ship v3",
3304
+ * "listId": "603449f6f107b67c63e8cee9",
3305
+ * "list": {
3306
+ * "id": "603449f6f107b67c63e8cee9",
3307
+ * "hash": "fabc9069cda279d762400d53e2854266",
3308
+ * "name": "Product",
3309
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
3310
+ * "numberOfParticipants": 2,
3311
+ * "type": "group",
3312
+ * "privacy": "private",
3313
+ * "isArchived": false,
3314
+ * "platformDetails": {
3315
+ * "name": "slack",
3316
+ * "channelId": "G01NLRJ053L",
3317
+ * "channelName": "engineering",
3318
+ * "type": "group",
3319
+ * "teamId": "T0HBUA0TC"
3320
+ * },
3321
+ * "platformNotifications": {
3322
+ * "taskCreated": true,
3323
+ * "taskCompleted": true
3324
+ * },
3325
+ * "subLists": [
3326
+ * {
3327
+ * "id": "603449f6f107b67c63e8cee8",
3328
+ * "name": "To-do",
3329
+ * "listPosition": 100000,
3330
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3331
+ * },
3332
+ * {
3333
+ * "id": "610ffd8c7374d6331a4178d8",
3334
+ * "name": "In Progress",
3335
+ * "listPosition": 700000,
3336
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3337
+ * }
3338
+ * ],
3339
+ * "defaultSubList": "603449f6f107b67c63e8cee8",
3340
+ * "isParticipant": true,
3341
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9"
3342
+ * },
3343
+ * "listPosition": 99999,
3344
+ * "subList": {
3345
+ * "id": "610ffd8c7374d6331a4178d8",
3346
+ * "name": "To-do",
3347
+ * "listPosition": 700000,
3348
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3349
+ * },
3350
+ * "subListId": "610ffd8c7374d6331a4178d8",
3351
+ * "subTasks": [
3352
+ * {
3353
+ * "status": "pending",
3354
+ * "text": "Ship v3",
3355
+ * "shortId": "T4QMF",
3356
+ * "createdAt": "2022-01-10T12:15:13.627Z",
3357
+ * "updatedAt": "2022-01-10T12:19:50.379Z",
3358
+ * "listPosition": 100000,
3359
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/7cec8c8604790b391221049f28d5ba40",
3360
+ * "calendars": [
3361
+ * "b2956627fe26a2c1e4b6d5202413f779"
3362
+ * ],
3363
+ * "id": "7cec8c8604790b391221049f28d5ba40",
3364
+ * "list": {
3365
+ * "id": "603449f6f107b67c63e8cee9",
3366
+ * "name": "Product",
3367
+ * "type": "group",
3368
+ * "privacy": "private",
3369
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
3370
+ * "subLists": [
3371
+ * {
3372
+ * "id": "603449f6f107b67c63e8cee8",
3373
+ * "name": "To-do",
3374
+ * "listPosition": 100000,
3375
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3376
+ * },
3377
+ * {
3378
+ * "id": "610ffd8c7374d6331a4178d8",
3379
+ * "name": "In Progress",
3380
+ * "listPosition": 700000,
3381
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3382
+ * }
3383
+ * ]
3384
+ * },
3385
+ * "listId": "603449f6f107b67c63e8cee9",
3386
+ * "parent": {
3387
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3388
+ * "text": "Ship v3",
3389
+ * "shortId": "T4GNY",
3390
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69"
3391
+ * },
3392
+ * "assignedTo": [],
3393
+ * "subscribers": [
3394
+ * {
3395
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3396
+ * "name": "Ada Lovelace",
3397
+ * "userName": "ada",
3398
+ * "email": "ada@example.com",
3399
+ * "platformDetails": {
3400
+ * "name": "slack",
3401
+ * "imChannel": "D3F5RQA6B",
3402
+ * "selfChannel": "D1LGYBCFQ",
3403
+ * "userId": "U0JU26WRG",
3404
+ * "teamId": "T0HBUA0TC"
3405
+ * },
3406
+ * "confirmed": true,
3407
+ * "avatar": "https://cdn.workast.io/avatar.png",
3408
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3409
+ * }
3410
+ * ],
3411
+ * "allDay": false,
3412
+ * "createdBy": {
3413
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3414
+ * "name": "Ada Lovelace",
3415
+ * "userName": "ada",
3416
+ * "email": "ada@example.com",
3417
+ * "platformDetails": {
3418
+ * "name": "slack",
3419
+ * "imChannel": "D3F5RQA6B",
3420
+ * "selfChannel": "D1LGYBCFQ",
3421
+ * "userId": "U0JU26WRG",
3422
+ * "teamId": "T0HBUA0TC"
3423
+ * },
3424
+ * "confirmed": true,
3425
+ * "avatar": "https://cdn.workast.io/avatar.png",
3426
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3427
+ * },
3428
+ * "hasDescription": true,
3429
+ * "numberOfComments": 0,
3430
+ * "numberOfAttachments": 0,
3431
+ * "subTasks": [],
3432
+ * "isSubscribed": false,
3433
+ * "taskStatus": {
3434
+ * "id": "5c7184fa40721e2ed4175a6e",
3435
+ * "label": "Open",
3436
+ * "color": "#808080",
3437
+ * "createdAt": "2019-02-23T17:38:02.928Z",
3438
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
3439
+ * },
3440
+ * "inHome": false,
3441
+ * "fields": []
3442
+ * }
3443
+ * ],
3444
+ * "attachments": [],
3445
+ * "totalSubTasks": 1,
3446
+ * "completedSubTasks": 0,
3447
+ * "numberOfComments": 1,
3448
+ * "lastComment": {
3449
+ * "id": "686f7912fc2fef09733c6f58",
3450
+ * "type": "comment",
3451
+ * "value": "Ship v3",
3452
+ * "status": "active",
3453
+ * "createdAt": "2025-07-10T08:25:54.274Z",
3454
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
3455
+ * "mentions": [
3456
+ * {
3457
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3458
+ * "name": "Ada Lovelace",
3459
+ * "userName": "ada",
3460
+ * "email": "ada@example.com",
3461
+ * "platformDetails": {
3462
+ * "name": "slack",
3463
+ * "imChannel": "D3F5RQA6B",
3464
+ * "selfChannel": "D1LGYBCFQ",
3465
+ * "userId": "U0JU26WRG",
3466
+ * "teamId": "T0HBUA0TC"
3467
+ * },
3468
+ * "confirmed": true,
3469
+ * "avatar": "https://cdn.workast.io/avatar.png",
3470
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3471
+ * }
3472
+ * ],
3473
+ * "reactions": [],
3474
+ * "actor": {
3475
+ * "type": "User",
3476
+ * "data": {
3477
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3478
+ * "name": "Grace Hopper",
3479
+ * "userName": "grace",
3480
+ * "email": "grace@example.com",
3481
+ * "platformDetails": {
3482
+ * "name": "slack",
3483
+ * "imChannel": "D3EEXS3J6",
3484
+ * "selfChannel": "D1HN843U3",
3485
+ * "userId": "U0HBQESA1",
3486
+ * "teamId": "T0HBUA0TC"
3487
+ * },
3488
+ * "confirmed": true,
3489
+ * "avatar": "https://cdn.workast.io/avatar.png",
3490
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3491
+ * }
3492
+ * }
3493
+ * },
3494
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
3495
+ * "dependencies": [],
3496
+ * "milestones": [],
3497
+ * "inHome": false,
3498
+ * "fields": [
3499
+ * {
3500
+ * "id": "620120d5106d941d2ac206c7",
3501
+ * "name": "Priority",
3502
+ * "description": "Ship v3",
3503
+ * "type": "options",
3504
+ * "useAsTaskColor": false,
3505
+ * "options": [
3506
+ * {
3507
+ * "id": "620120d5106d941d2ac206c8",
3508
+ * "name": "Yes",
3509
+ * "color": "#2ef00d"
3510
+ * },
3511
+ * {
3512
+ * "id": "620120d5106d941d2ac206c9",
3513
+ * "name": "No",
3514
+ * "color": "#ee0551"
3515
+ * }
3516
+ * ],
3517
+ * "value": ""
3518
+ * }
3519
+ * ],
3520
+ * "calendars": [
3521
+ * "b2956627fe26a2c1e4b6d5202413f779"
3522
+ * ]
3523
+ * }
3524
+ */
2602
3525
  Task: components["schemas"]["TaskCommon"] & {
2603
3526
  createdBy?: components["schemas"]["UserDetail"];
2604
3527
  assignedTo?: components["schemas"]["UserDetail"][];
@@ -2709,7 +3632,185 @@ interface components {
2709
3632
  /** @description User IDs whose calendars include this task */
2710
3633
  calendars?: string[];
2711
3634
  };
2712
- /** @description The user's home screen tasks (favourites). */
3635
+ /**
3636
+ * @description The user's home screen tasks (favourites).
3637
+ * @example {
3638
+ * "tasks": [
3639
+ * {
3640
+ * "status": "pending",
3641
+ * "text": "Ship v3",
3642
+ * "shortId": "T4GNY",
3643
+ * "createdAt": "2022-01-10T12:12:46.308Z",
3644
+ * "updatedAt": "2025-07-10T08:25:54.460Z",
3645
+ * "listPosition": 99999,
3646
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
3647
+ * "calendars": [
3648
+ * "b2956627fe26a2c1e4b6d5202413f779"
3649
+ * ],
3650
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3651
+ * "list": {
3652
+ * "id": "603449f6f107b67c63e8cee9",
3653
+ * "name": "Product",
3654
+ * "type": "group",
3655
+ * "privacy": "private",
3656
+ * "subLists": [
3657
+ * {
3658
+ * "id": "603449f6f107b67c63e8cee8",
3659
+ * "name": "To-do",
3660
+ * "listPosition": 100000,
3661
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3662
+ * },
3663
+ * {
3664
+ * "id": "610ffd8c7374d6331a4178d8",
3665
+ * "name": "In Progress",
3666
+ * "listPosition": 700000,
3667
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3668
+ * }
3669
+ * ],
3670
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9"
3671
+ * },
3672
+ * "listId": "603449f6f107b67c63e8cee9",
3673
+ * "subListId": "610ffd8c7374d6331a4178d8",
3674
+ * "subList": {
3675
+ * "id": "610ffd8c7374d6331a4178d8",
3676
+ * "name": "To-do"
3677
+ * },
3678
+ * "assignedTo": [
3679
+ * {
3680
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3681
+ * "name": "Ada Lovelace",
3682
+ * "userName": "ada",
3683
+ * "email": "ada@example.com",
3684
+ * "platformDetails": {
3685
+ * "name": "slack",
3686
+ * "imChannel": "D3F5RQA6B",
3687
+ * "selfChannel": "D1LGYBCFQ",
3688
+ * "userId": "U0JU26WRG",
3689
+ * "teamId": "T0HBUA0TC"
3690
+ * },
3691
+ * "confirmed": true,
3692
+ * "avatar": "https://cdn.workast.io/avatar.png",
3693
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3694
+ * }
3695
+ * ],
3696
+ * "subscribers": [
3697
+ * {
3698
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3699
+ * "name": "Ada Lovelace",
3700
+ * "userName": "ada",
3701
+ * "email": "ada@example.com",
3702
+ * "platformDetails": {
3703
+ * "name": "slack",
3704
+ * "imChannel": "D3F5RQA6B",
3705
+ * "selfChannel": "D1LGYBCFQ",
3706
+ * "userId": "U0JU26WRG",
3707
+ * "teamId": "T0HBUA0TC"
3708
+ * },
3709
+ * "confirmed": true,
3710
+ * "avatar": "https://cdn.workast.io/avatar.png",
3711
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3712
+ * },
3713
+ * {
3714
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3715
+ * "name": "Grace Hopper",
3716
+ * "userName": "grace",
3717
+ * "email": "grace@example.com",
3718
+ * "platformDetails": {
3719
+ * "name": "slack",
3720
+ * "imChannel": "D3EEXS3J6",
3721
+ * "selfChannel": "D1HN843U3",
3722
+ * "userId": "U0HBQESA1",
3723
+ * "teamId": "T0HBUA0TC"
3724
+ * },
3725
+ * "confirmed": true,
3726
+ * "avatar": "https://cdn.workast.io/avatar.png",
3727
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3728
+ * }
3729
+ * ],
3730
+ * "allDay": false,
3731
+ * "createdBy": {
3732
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3733
+ * "name": "Ada Lovelace",
3734
+ * "userName": "ada",
3735
+ * "email": "ada@example.com",
3736
+ * "platformDetails": {
3737
+ * "name": "slack",
3738
+ * "imChannel": "D3F5RQA6B",
3739
+ * "selfChannel": "D1LGYBCFQ",
3740
+ * "userId": "U0JU26WRG",
3741
+ * "teamId": "T0HBUA0TC"
3742
+ * },
3743
+ * "confirmed": true,
3744
+ * "avatar": "https://cdn.workast.io/avatar.png",
3745
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3746
+ * },
3747
+ * "hasDescription": true,
3748
+ * "numberOfComments": 1,
3749
+ * "numberOfAttachments": 0,
3750
+ * "totalSubTasks": 1,
3751
+ * "completedSubTasks": 0,
3752
+ * "isSubscribed": true,
3753
+ * "lastComment": {
3754
+ * "id": "686f7912fc2fef09733c6f58",
3755
+ * "type": "comment",
3756
+ * "value": "Standup",
3757
+ * "status": "active",
3758
+ * "createdAt": "2025-07-10T08:25:54.274Z",
3759
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
3760
+ * "mentions": [
3761
+ * {
3762
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3763
+ * "name": "Ada Lovelace",
3764
+ * "userName": "ada",
3765
+ * "email": "ada@example.com",
3766
+ * "platformDetails": {
3767
+ * "name": "slack",
3768
+ * "imChannel": "D3F5RQA6B",
3769
+ * "selfChannel": "D1LGYBCFQ",
3770
+ * "userId": "U0JU26WRG",
3771
+ * "teamId": "T0HBUA0TC"
3772
+ * },
3773
+ * "confirmed": true,
3774
+ * "avatar": "https://cdn.workast.io/avatar.png",
3775
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3776
+ * }
3777
+ * ],
3778
+ * "reactions": [],
3779
+ * "actor": {
3780
+ * "type": "User",
3781
+ * "data": {
3782
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3783
+ * "name": "Grace Hopper",
3784
+ * "userName": "grace",
3785
+ * "email": "grace@example.com",
3786
+ * "platformDetails": {
3787
+ * "name": "slack",
3788
+ * "imChannel": "D3EEXS3J6",
3789
+ * "selfChannel": "D1HN843U3",
3790
+ * "userId": "U0HBQESA1",
3791
+ * "teamId": "T0HBUA0TC"
3792
+ * },
3793
+ * "confirmed": true,
3794
+ * "avatar": "https://cdn.workast.io/avatar.png",
3795
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3796
+ * }
3797
+ * }
3798
+ * },
3799
+ * "taskStatus": {
3800
+ * "id": "5c7184fa40721e2ed4175a6e",
3801
+ * "label": "Open",
3802
+ * "color": "#808080",
3803
+ * "createdAt": "2019-02-23T17:38:02.928Z",
3804
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
3805
+ * },
3806
+ * "milestones": [],
3807
+ * "inHome": true,
3808
+ * "fields": []
3809
+ * }
3810
+ * ],
3811
+ * "total": 1
3812
+ * }
3813
+ */
2713
3814
  HomeTasks: {
2714
3815
  tasks?: components["schemas"]["TaskListItem"][];
2715
3816
  /** @description Total number of home tasks. */
@@ -2923,7 +4024,152 @@ interface components {
2923
4024
  /** @description Users mentioned in a comment. */
2924
4025
  mentions?: components["schemas"]["UserMinimalResource"][];
2925
4026
  };
2926
- /** @description Paginated task activities from Activity.search, with each item from activity.buildResource (task, team, and list omitted) plus userFriendlyContent. */
4027
+ /**
4028
+ * @description Paginated task activities from Activity.search, with each item from activity.buildResource (task, team, and list omitted) plus userFriendlyContent.
4029
+ * @example {
4030
+ * "activities": [
4031
+ * {
4032
+ * "id": "61dc22bee45fbc0e26ca342d",
4033
+ * "type": "task_created",
4034
+ * "createdAt": "2022-01-10T12:12:46.500Z",
4035
+ * "updatedAt": "2022-01-10T12:12:46.500Z",
4036
+ * "mentions": [],
4037
+ * "actor": {
4038
+ * "type": "User",
4039
+ * "data": {
4040
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4041
+ * "name": "Ada Lovelace",
4042
+ * "userName": "ada",
4043
+ * "email": "ada@example.com",
4044
+ * "platformDetails": {
4045
+ * "name": "slack",
4046
+ * "imChannel": "D3F5RQA6B",
4047
+ * "selfChannel": "D1LGYBCFQ",
4048
+ * "userId": "U0JU26WRG",
4049
+ * "teamId": "T0HBUA0TC"
4050
+ * },
4051
+ * "confirmed": true,
4052
+ * "avatar": "https://cdn.workast.io/avatar.png",
4053
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4054
+ * }
4055
+ * },
4056
+ * "userFriendlyContent": {
4057
+ * "task": {
4058
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
4059
+ * "shortId": "T4GNY",
4060
+ * "status": "pending",
4061
+ * "subscribers": [
4062
+ * "b2956627fe26a2c1e4b6d5202413f779",
4063
+ * "4214932441cb21eebdb396bfe34a8340"
4064
+ * ],
4065
+ * "calendars": [
4066
+ * "b2956627fe26a2c1e4b6d5202413f779"
4067
+ * ],
4068
+ * "text": "Ship v3",
4069
+ * "description": "Ship v3",
4070
+ * "subListId": "610ffd8c7374d6331a4178d8",
4071
+ * "listId": "603449f6f107b67c63e8cee9",
4072
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
4073
+ * "allDay": false,
4074
+ * "createdBy": {
4075
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4076
+ * "createdAt": "2016-12-28T22:19:45.715Z",
4077
+ * "name": "Ada Lovelace",
4078
+ * "userName": "ada",
4079
+ * "platformDetails": {
4080
+ * "name": "slack",
4081
+ * "imChannel": "D3F5RQA6B",
4082
+ * "selfChannel": "D1LGYBCFQ",
4083
+ * "userId": "U0JU26WRG",
4084
+ * "teamId": "T0HBUA0TC"
4085
+ * },
4086
+ * "timezone": "Australia/Canberra",
4087
+ * "email": "ada@example.com",
4088
+ * "lastActive": "2025-07-10T01:22:15.814Z",
4089
+ * "role": "admin",
4090
+ * "status": "active",
4091
+ * "confirmed": true,
4092
+ * "profile": {},
4093
+ * "avatar": "https://cdn.workast.io/avatar.png",
4094
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4095
+ * },
4096
+ * "assignedTo": [
4097
+ * {
4098
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4099
+ * "createdAt": "2016-12-28T22:19:45.715Z",
4100
+ * "name": "Ada Lovelace",
4101
+ * "userName": "ada",
4102
+ * "platformDetails": {
4103
+ * "name": "slack",
4104
+ * "imChannel": "D3F5RQA6B",
4105
+ * "selfChannel": "D1LGYBCFQ",
4106
+ * "userId": "U0JU26WRG",
4107
+ * "teamId": "T0HBUA0TC"
4108
+ * },
4109
+ * "timezone": "Australia/Canberra",
4110
+ * "email": "ada@example.com",
4111
+ * "lastActive": "2025-07-10T01:22:15.814Z",
4112
+ * "role": "admin",
4113
+ * "status": "active",
4114
+ * "confirmed": true,
4115
+ * "profile": {},
4116
+ * "avatar": "https://cdn.workast.io/avatar.png",
4117
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4118
+ * }
4119
+ * ]
4120
+ * },
4121
+ * "list": {
4122
+ * "id": "603449f6f107b67c63e8cee9",
4123
+ * "name": "Product",
4124
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
4125
+ * "subLists": [
4126
+ * {
4127
+ * "id": "603449f6f107b67c63e8cee8",
4128
+ * "name": "To-do",
4129
+ * "listPosition": 100000,
4130
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
4131
+ * },
4132
+ * {
4133
+ * "id": "610ffd8c7374d6331a4178d8",
4134
+ * "name": "In Progress",
4135
+ * "listPosition": 700000,
4136
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
4137
+ * }
4138
+ * ],
4139
+ * "platformDetails": {
4140
+ * "name": "slack",
4141
+ * "channelId": "G01NLRJ053L",
4142
+ * "channelName": "engineering",
4143
+ * "type": "group",
4144
+ * "teamId": "T0HBUA0TC"
4145
+ * }
4146
+ * },
4147
+ * "actor": {
4148
+ * "type": "User",
4149
+ * "id": {
4150
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4151
+ * "name": "Ada Lovelace",
4152
+ * "userName": "ada",
4153
+ * "email": "ada@example.com",
4154
+ * "platformDetails": {
4155
+ * "name": "slack",
4156
+ * "imChannel": "D3F5RQA6B",
4157
+ * "selfChannel": "D1LGYBCFQ",
4158
+ * "userId": "U0JU26WRG",
4159
+ * "teamId": "T0HBUA0TC"
4160
+ * },
4161
+ * "confirmed": true,
4162
+ * "avatar": "https://cdn.workast.io/avatar.png",
4163
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4164
+ * }
4165
+ * },
4166
+ * "message": "{{actor}} created the task {{task}}"
4167
+ * }
4168
+ * }
4169
+ * ],
4170
+ * "total": 17
4171
+ * }
4172
+ */
2927
4173
  TaskActivities: {
2928
4174
  /**
2929
4175
  * @description The total amount of activities that matched the search criteria
@@ -3038,9 +4284,56 @@ interface components {
3038
4284
  * @description The kind of activity
3039
4285
  * @enum {string}
3040
4286
  */
3041
- SpaceActivity: "task_created" | "task_completed" | "list_created" | "list_updated" | "list_archived" | "list_unarchived" | "list_access_requested" | "comment" | "sublist_created" | "sublist_updated" | "sublist_removed" | "sublist_marked_as_default" | "list_comment";
3042
- ActivityType: components["schemas"]["SpaceActivity"] & ("task_updated" | "task_restored" | "task_reopened" | "task_removed" | "user_activated" | "user_deactivated" | "user_updated" | "user_invited" | "user_suspended" | "user_unsuspended" | "team_created" | "team_updated" | "team_deactivated" | "team_suspended" | "team_reactivated" | "cost_center_created" | "cost_center_updated" | "user_notification_created" | "user_notification_removed" | "user_notification_settings_updated" | "search_created" | "search_updated" | "search_removed" | "user_removed" | "cost_center_removed" | "user_home_tasks_updated" | "reaction_added" | "reaction_removed" | "meeting_created" | "meeting_updated" | "meeting_reminder" | "meeting_media_ready" | "field_created" | "field_updated" | "field_removed" | "tag_created" | "tag_updated" | "tag_removed");
3043
- /** @description CommentActivity.buildResource, omitting task and list. */
4287
+ ActivityType: "task_created" | "task_completed" | "list_created" | "list_updated" | "list_archived" | "list_unarchived" | "list_access_requested" | "comment" | "sublist_created" | "sublist_updated" | "sublist_removed" | "sublist_marked_as_default" | "list_comment" | "task_updated" | "task_restored" | "task_reopened" | "task_removed" | "user_activated" | "user_deactivated" | "user_updated" | "user_invited" | "user_suspended" | "user_unsuspended" | "team_created" | "team_updated" | "team_deactivated" | "team_suspended" | "team_reactivated" | "cost_center_created" | "cost_center_updated" | "user_notification_created" | "user_notification_removed" | "user_notification_settings_updated" | "search_created" | "search_updated" | "search_removed" | "user_removed" | "cost_center_removed" | "user_home_tasks_updated" | "reaction_added" | "reaction_removed" | "meeting_created" | "meeting_updated" | "meeting_reminder" | "meeting_media_ready" | "field_created" | "field_updated" | "field_removed" | "tag_created" | "tag_updated" | "tag_removed";
4288
+ /**
4289
+ * @description CommentActivity.buildResource, omitting task and list.
4290
+ * @example {
4291
+ * "id": "686f7912fc2fef09733c6f58",
4292
+ * "type": "comment",
4293
+ * "value": "Standup",
4294
+ * "status": "active",
4295
+ * "createdAt": "2025-07-10T08:25:54.274Z",
4296
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
4297
+ * "mentions": [
4298
+ * {
4299
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4300
+ * "name": "Ada Lovelace",
4301
+ * "userName": "ada",
4302
+ * "email": "ada@example.com",
4303
+ * "platformDetails": {
4304
+ * "name": "slack",
4305
+ * "imChannel": "D3F5RQA6B",
4306
+ * "selfChannel": "D1LGYBCFQ",
4307
+ * "userId": "U0JU26WRG",
4308
+ * "teamId": "T0HBUA0TC"
4309
+ * },
4310
+ * "confirmed": true,
4311
+ * "avatar": "https://cdn.workast.io/avatar.png",
4312
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4313
+ * }
4314
+ * ],
4315
+ * "reactions": [],
4316
+ * "actor": {
4317
+ * "type": "User",
4318
+ * "data": {
4319
+ * "id": "4214932441cb21eebdb396bfe34a8340",
4320
+ * "name": "Grace Hopper",
4321
+ * "userName": "grace",
4322
+ * "email": "grace@example.com",
4323
+ * "platformDetails": {
4324
+ * "name": "slack",
4325
+ * "imChannel": "D3EEXS3J6",
4326
+ * "selfChannel": "D1HN843U3",
4327
+ * "userId": "U0HBQESA1",
4328
+ * "teamId": "T0HBUA0TC"
4329
+ * },
4330
+ * "confirmed": true,
4331
+ * "avatar": "https://cdn.workast.io/avatar.png",
4332
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4333
+ * }
4334
+ * }
4335
+ * }
4336
+ */
3044
4337
  CommentActivity: {
3045
4338
  /**
3046
4339
  * @description The activity unique ID.
@@ -3151,7 +4444,129 @@ interface components {
3151
4444
  */
3152
4445
  updateDueDates?: number;
3153
4446
  };
3154
- /** @description Full list. Built by buildListDetailResource. */
4447
+ /**
4448
+ * @description Full list. Built by buildListDetailResource.
4449
+ * @example {
4450
+ * "id": "5a6ebde81519395731f90e2f",
4451
+ * "hash": "26873fa18b3a3c5bfd82f9d8e2dafa05",
4452
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
4453
+ * "name": "Engineering",
4454
+ * "numberOfParticipants": 2,
4455
+ * "type": "group",
4456
+ * "privacy": "private",
4457
+ * "platformDetails": {
4458
+ * "name": "slack",
4459
+ * "channelId": "G8TRB56E8",
4460
+ * "channelName": "engineering",
4461
+ * "type": "group",
4462
+ * "teamId": "T0HBUA0TC"
4463
+ * },
4464
+ * "isArchived": false,
4465
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779",
4466
+ * "participants": [
4467
+ * "4214932441cb21eebdb396bfe34a8340",
4468
+ * "c51a9c1a2ddfbcefa7abf74036e0c616",
4469
+ * "b2956627fe26a2c1e4b6d5202413f779"
4470
+ * ],
4471
+ * "platformNotifications": {
4472
+ * "taskCreated": true,
4473
+ * "taskCompleted": true
4474
+ * },
4475
+ * "apps": [
4476
+ * {
4477
+ * "id": "5af007dff36d2837eae6e56c",
4478
+ * "name": "Slack",
4479
+ * "description": "Ship v3",
4480
+ * "icon": "https://cdn.workast.io/integrations/Slack/icon.png",
4481
+ * "updatedAt": "2023-11-15T03:23:37.468Z",
4482
+ * "clientId": "nUsktT5eDzpbJE15WLfMejf9oJ",
4483
+ * "accessType": "user",
4484
+ * "developedByWorkast": true,
4485
+ * "integration": {
4486
+ * "spaceActions": [
4487
+ * {
4488
+ * "actionId": "SHOW_SETTINGS",
4489
+ * "label": "Slack"
4490
+ * }
4491
+ * ],
4492
+ * "taskActions": []
4493
+ * }
4494
+ * },
4495
+ * {
4496
+ * "id": "5b23da45e7179a589282a60c",
4497
+ * "name": "Email",
4498
+ * "description": "Ship v3",
4499
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
4500
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
4501
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
4502
+ * "accessType": "user",
4503
+ * "developedByWorkast": true,
4504
+ * "integration": {
4505
+ * "spaceActions": [
4506
+ * {
4507
+ * "actionId": "SHOW_SETTINGS",
4508
+ * "label": "Email"
4509
+ * }
4510
+ * ],
4511
+ * "taskActions": []
4512
+ * }
4513
+ * }
4514
+ * ],
4515
+ * "defaultSubList": "5a6ebde81519395731f90e30",
4516
+ * "subLists": [
4517
+ * {
4518
+ * "id": "5a6ebde81519395731f90e30",
4519
+ * "name": "To-do",
4520
+ * "listPosition": 100000,
4521
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4522
+ * }
4523
+ * ],
4524
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f",
4525
+ * "isParticipant": true,
4526
+ * "someParticipants": [
4527
+ * {
4528
+ * "id": "4214932441cb21eebdb396bfe34a8340",
4529
+ * "name": "Grace Hopper",
4530
+ * "userName": "grace",
4531
+ * "email": "grace@example.com",
4532
+ * "platformDetails": {
4533
+ * "name": "slack",
4534
+ * "imChannel": "D3EEXS3J6",
4535
+ * "selfChannel": "D1HN843U3",
4536
+ * "userId": "U0HBQESA1",
4537
+ * "teamId": "T0HBUA0TC"
4538
+ * },
4539
+ * "confirmed": true,
4540
+ * "avatar": "https://cdn.workast.io/avatar.png",
4541
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4542
+ * },
4543
+ * {
4544
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4545
+ * "name": "Ada Lovelace",
4546
+ * "userName": "ada",
4547
+ * "email": "ada@example.com",
4548
+ * "platformDetails": {
4549
+ * "name": "slack",
4550
+ * "imChannel": "D3F5RQA6B",
4551
+ * "selfChannel": "D1LGYBCFQ",
4552
+ * "userId": "U0JU26WRG",
4553
+ * "teamId": "T0HBUA0TC"
4554
+ * },
4555
+ * "confirmed": true,
4556
+ * "avatar": "https://cdn.workast.io/avatar.png",
4557
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4558
+ * }
4559
+ * ],
4560
+ * "columns": [
4561
+ * "assignedTo",
4562
+ * "dueDate",
4563
+ * "doneBy",
4564
+ * "doneAt"
4565
+ * ],
4566
+ * "groupBy": "subList",
4567
+ * "isBookmarked": false
4568
+ * }
4569
+ */
3155
4570
  List: {
3156
4571
  /** @description The list unique ID */
3157
4572
  id?: string;
@@ -3228,7 +4643,15 @@ interface components {
3228
4643
  */
3229
4644
  bgColor?: string;
3230
4645
  };
3231
- /** @description Sublist. Built by SubList.buildResource. */
4646
+ /**
4647
+ * @description Sublist. Built by SubList.buildResource.
4648
+ * @example {
4649
+ * "id": "5a6ebde81519395731f90e30",
4650
+ * "name": "To-do",
4651
+ * "listPosition": 100000,
4652
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4653
+ * }
4654
+ */
3232
4655
  SubList: {
3233
4656
  /** @description The sublist unique ID */
3234
4657
  id?: string;
@@ -3287,7 +4710,58 @@ interface components {
3287
4710
  subLists?: components["schemas"]["SubList"][];
3288
4711
  platformDetails?: components["schemas"]["ListPlatformDetails"];
3289
4712
  };
3290
- /** @description List as returned when searching lists. Built by buildListToEnumerateResource. */
4713
+ /**
4714
+ * @description List as returned when searching lists. Built by buildListToEnumerateResource.
4715
+ * @example {
4716
+ * "id": "5a6ebde81519395731f90e2f",
4717
+ * "hash": "26873fa18b3a3c5bfd82f9d8e2dafa05",
4718
+ * "name": "Engineering",
4719
+ * "createdAt": "2018-01-29T06:23:36.194Z",
4720
+ * "createdBy": {
4721
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4722
+ * "name": "Ada Lovelace",
4723
+ * "userName": "ada",
4724
+ * "email": "ada@example.com",
4725
+ * "platformDetails": {
4726
+ * "name": "slack",
4727
+ * "imChannel": "D3F5RQA6B",
4728
+ * "selfChannel": "D1LGYBCFQ",
4729
+ * "userId": "U0JU26WRG",
4730
+ * "teamId": "T0HBUA0TC"
4731
+ * },
4732
+ * "confirmed": true,
4733
+ * "avatar": "https://cdn.workast.io/avatar.png",
4734
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4735
+ * },
4736
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
4737
+ * "numberOfParticipants": 3,
4738
+ * "type": "group",
4739
+ * "privacy": "private",
4740
+ * "isArchived": false,
4741
+ * "platformDetails": {
4742
+ * "name": "slack",
4743
+ * "channelId": "G8TRB56E8",
4744
+ * "channelName": "engineering",
4745
+ * "type": "group",
4746
+ * "teamId": "T0HBUA0TC"
4747
+ * },
4748
+ * "platformNotifications": {
4749
+ * "taskCreated": true,
4750
+ * "taskCompleted": true
4751
+ * },
4752
+ * "subLists": [
4753
+ * {
4754
+ * "id": "5a6ebde81519395731f90e30",
4755
+ * "name": "To-do",
4756
+ * "listPosition": 100000,
4757
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4758
+ * }
4759
+ * ],
4760
+ * "defaultSubList": "5a6ebde81519395731f90e30",
4761
+ * "isParticipant": true,
4762
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f"
4763
+ * }
4764
+ */
3291
4765
  ListEnumerate: {
3292
4766
  /** @description The list unique ID */
3293
4767
  id?: string;
@@ -3368,7 +4842,14 @@ interface components {
3368
4842
  */
3369
4843
  link: string;
3370
4844
  };
3371
- /** @description Tag. Built by Tag.buildResource. */
4845
+ /**
4846
+ * @description Tag. Built by Tag.buildResource.
4847
+ * @example {
4848
+ * "id": "5a6227d69f0cec2676083529",
4849
+ * "name": "Feature",
4850
+ * "color": "#61bd4f"
4851
+ * }
4852
+ */
3372
4853
  Tag: {
3373
4854
  /** @description The tag's unique id */
3374
4855
  id: string;
@@ -3398,7 +4879,34 @@ interface components {
3398
4879
  * @enum {string}
3399
4880
  */
3400
4881
  NotificationType: "task_updated" | "task_status_updated" | "comment" | "reaction" | "task_assigned" | "list_invited" | "list_access_requested" | "user_role_changed" | "account_upgraded" | "task_due_soon" | "cost_center_joined" | "meeting_created" | "meeting_reminder" | "meeting_media_ready";
3401
- /** @description Paginated notifications from Notification.search. Each item from Notification.buildResource. */
4882
+ /**
4883
+ * @description Paginated notifications from Notification.search. Each item from Notification.buildResource.
4884
+ * @example {
4885
+ * "notifications": [
4886
+ * {
4887
+ * "id": "6a7ea6b48e9808acbda8914f",
4888
+ * "type": "meeting_media_ready",
4889
+ * "read": false,
4890
+ * "activityId": "6a7ea6b48e9808acbda89147",
4891
+ * "sentAt": "2026-08-14T05:25:08.472Z",
4892
+ * "createdAt": "2026-08-14T05:25:08.474Z",
4893
+ * "content": {
4894
+ * "actor": {
4895
+ * "type": "App",
4896
+ * "id": {
4897
+ * "id": "5ed17524aa2ab23bf71d324d",
4898
+ * "name": "Meetings",
4899
+ * "icon": "https://cdn.workast.io/avatar.png"
4900
+ * }
4901
+ * },
4902
+ * "message": "Standup"
4903
+ * },
4904
+ * "activityType": "meeting_media_ready"
4905
+ * }
4906
+ * ],
4907
+ * "total": 2244
4908
+ * }
4909
+ */
3402
4910
  Notifications: {
3403
4911
  /** @description Total number of matching notifications. */
3404
4912
  total: number;
@@ -3709,6 +5217,14 @@ interface components {
3709
5217
  value: string;
3710
5218
  }[];
3711
5219
  };
5220
+ /**
5221
+ * @example {
5222
+ * "modified": [
5223
+ * "3634dc043f0d415ec2d307284a3cfe69"
5224
+ * ],
5225
+ * "error": []
5226
+ * }
5227
+ */
3712
5228
  TaskBulkUpdateResult: {
3713
5229
  /** @description Task IDs that were updated */
3714
5230
  modified: string[];
@@ -3851,7 +5367,23 @@ interface components {
3851
5367
  /** @description Share on platform when a task is completed */
3852
5368
  taskCompleted?: boolean;
3853
5369
  };
3854
- /** @description Token authentication details from GET /me. app, user, and team are omitted when not on the token. */
5370
+ /**
5371
+ * @description Token authentication details from GET /me. app, user, and team are omitted when not on the token.
5372
+ * @example {
5373
+ * "app": {
5374
+ * "id": "5d9a6b09269e415d36380d23",
5375
+ * "name": "Example App"
5376
+ * },
5377
+ * "user": {
5378
+ * "id": "4214932441cb21eebdb396bfe34a8340",
5379
+ * "name": "Grace Hopper"
5380
+ * },
5381
+ * "team": {
5382
+ * "id": "ca19601b6bb816ca95386698b3385d49",
5383
+ * "name": "Example Team"
5384
+ * }
5385
+ * }
5386
+ */
3855
5387
  TokenDetails: {
3856
5388
  app?: components["schemas"]["TokenApp"];
3857
5389
  user?: components["schemas"]["TokenUser"];
@@ -4704,7 +6236,85 @@ interface components {
4704
6236
  SearchReminderSet: {
4705
6237
  repeat: components["schemas"]["RepeatSchema"];
4706
6238
  };
4707
- /** @description Full search resource. Built by Search.buildResource. */
6239
+ /**
6240
+ * @description Full search resource. Built by Search.buildResource.
6241
+ * @example {
6242
+ * "id": "5f0e23098d49422410c20540",
6243
+ * "custom": true,
6244
+ * "name": "Ship v3",
6245
+ * "payload": {
6246
+ * "sort": [
6247
+ * {
6248
+ * "direction": 1,
6249
+ * "field": "listName"
6250
+ * }
6251
+ * ],
6252
+ * "includeSubTasks": true,
6253
+ * "predicates": [
6254
+ * {
6255
+ * "value": "pending",
6256
+ * "comparison": "eq",
6257
+ * "attribute": "status",
6258
+ * "type": "status"
6259
+ * }
6260
+ * ],
6261
+ * "columns": [
6262
+ * "list"
6263
+ * ]
6264
+ * },
6265
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5f0e23098d49422410c20540",
6266
+ * "isPrimary": false,
6267
+ * "users": [],
6268
+ * "createdBy": {
6269
+ * "user": {
6270
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6271
+ * "name": "Grace Hopper",
6272
+ * "userName": "grace",
6273
+ * "email": "grace@example.com",
6274
+ * "platformDetails": {
6275
+ * "name": "slack",
6276
+ * "imChannel": "D3EEXS3J6",
6277
+ * "selfChannel": "D1HN843U3",
6278
+ * "userId": "U0HBQESA1",
6279
+ * "teamId": "T0HBUA0TC"
6280
+ * },
6281
+ * "confirmed": true,
6282
+ * "avatar": "https://cdn.workast.io/avatar.png",
6283
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6284
+ * }
6285
+ * },
6286
+ * "createdAt": "2020-07-14T21:26:33.254Z",
6287
+ * "updatedAt": "2023-05-31T23:15:19.277Z",
6288
+ * "values": {
6289
+ * "list": {
6290
+ * "5a99a7a58373fa652992e665": {
6291
+ * "id": "5a99a7a58373fa652992e665",
6292
+ * "type": "group",
6293
+ * "status": "active",
6294
+ * "privacy": "team",
6295
+ * "link": "https://app.workast.com/list/5a99a7a58373fa652992e665",
6296
+ * "name": "Engineering"
6297
+ * },
6298
+ * "5dc40cff038a590f79c403c0": {
6299
+ * "id": "5dc40cff038a590f79c403c0",
6300
+ * "type": "group",
6301
+ * "status": "active",
6302
+ * "privacy": "team",
6303
+ * "link": "https://app.workast.com/list/5dc40cff038a590f79c403c0",
6304
+ * "name": "Product"
6305
+ * },
6306
+ * "5fc58f3d15ff9110b64ca426": {
6307
+ * "id": "5fc58f3d15ff9110b64ca426",
6308
+ * "type": "group",
6309
+ * "status": "active",
6310
+ * "privacy": "team",
6311
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
6312
+ * "name": "Engineering"
6313
+ * }
6314
+ * }
6315
+ * }
6316
+ * }
6317
+ */
4708
6318
  Search: {
4709
6319
  /** @description The Search ID. */
4710
6320
  readonly id?: string;
@@ -4798,13 +6408,195 @@ interface components {
4798
6408
  [key: string]: components["schemas"]["UserMinimalResource"];
4799
6409
  };
4800
6410
  };
4801
- /** @description Paginated searches for the logged-in user. */
6411
+ /**
6412
+ * @description Paginated searches for the logged-in user.
6413
+ * @example {
6414
+ * "searches": [
6415
+ * {
6416
+ * "id": "5ddfeab45ff6d925d23c929e",
6417
+ * "name": "Ship v3",
6418
+ * "custom": true,
6419
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5ddfeab45ff6d925d23c929e",
6420
+ * "usersCount": 0,
6421
+ * "createdBy": {
6422
+ * "user": "4214932441cb21eebdb396bfe34a8340"
6423
+ * },
6424
+ * "createdAt": "2019-11-28T15:41:40.245Z",
6425
+ * "updatedAt": "2021-01-14T18:44:34.151Z"
6426
+ * }
6427
+ * ],
6428
+ * "total": 3
6429
+ * }
6430
+ */
4802
6431
  Searches: {
4803
6432
  /** @description SearchItem when home is false (default); Search when home is true. */
4804
6433
  searches?: (components["schemas"]["SearchItem"] | components["schemas"]["Search"])[];
4805
6434
  /** @description Total number of matching searches. */
4806
6435
  total?: number;
4807
6436
  };
6437
+ /**
6438
+ * @example {
6439
+ * "tasks": [
6440
+ * {
6441
+ * "status": "pending",
6442
+ * "text": "Ship v3",
6443
+ * "shortId": "T4GNY",
6444
+ * "createdAt": "2022-01-10T12:12:46.308Z",
6445
+ * "updatedAt": "2025-07-10T08:25:54.460Z",
6446
+ * "listPosition": 99999,
6447
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
6448
+ * "calendars": [
6449
+ * "b2956627fe26a2c1e4b6d5202413f779"
6450
+ * ],
6451
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
6452
+ * "list": {
6453
+ * "id": "603449f6f107b67c63e8cee9",
6454
+ * "name": "Product",
6455
+ * "type": "group",
6456
+ * "privacy": "private",
6457
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
6458
+ * "subLists": [
6459
+ * {
6460
+ * "id": "603449f6f107b67c63e8cee8",
6461
+ * "name": "To-do",
6462
+ * "listPosition": 100000,
6463
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6464
+ * },
6465
+ * {
6466
+ * "id": "610ffd8c7374d6331a4178d8",
6467
+ * "name": "In Progress",
6468
+ * "listPosition": 700000,
6469
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6470
+ * }
6471
+ * ]
6472
+ * },
6473
+ * "listId": "603449f6f107b67c63e8cee9",
6474
+ * "subListId": "610ffd8c7374d6331a4178d8",
6475
+ * "subList": {
6476
+ * "id": "610ffd8c7374d6331a4178d8",
6477
+ * "name": "To-do"
6478
+ * },
6479
+ * "assignedTo": [
6480
+ * {
6481
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6482
+ * "name": "Ada Lovelace",
6483
+ * "userName": "ada",
6484
+ * "email": "ada@example.com",
6485
+ * "platformDetails": {
6486
+ * "name": "slack",
6487
+ * "imChannel": "D3F5RQA6B",
6488
+ * "selfChannel": "D1LGYBCFQ",
6489
+ * "userId": "U0JU26WRG",
6490
+ * "teamId": "T0HBUA0TC"
6491
+ * },
6492
+ * "confirmed": true,
6493
+ * "avatar": "https://cdn.workast.io/avatar.png",
6494
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6495
+ * }
6496
+ * ],
6497
+ * "subscribers": [
6498
+ * {
6499
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6500
+ * "name": "Ada Lovelace",
6501
+ * "userName": "ada",
6502
+ * "email": "ada@example.com",
6503
+ * "platformDetails": {
6504
+ * "name": "slack",
6505
+ * "imChannel": "D3F5RQA6B",
6506
+ * "selfChannel": "D1LGYBCFQ",
6507
+ * "userId": "U0JU26WRG",
6508
+ * "teamId": "T0HBUA0TC"
6509
+ * },
6510
+ * "confirmed": true,
6511
+ * "avatar": "https://cdn.workast.io/avatar.png",
6512
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6513
+ * }
6514
+ * ],
6515
+ * "allDay": false,
6516
+ * "createdBy": {
6517
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6518
+ * "name": "Ada Lovelace",
6519
+ * "userName": "ada",
6520
+ * "email": "ada@example.com",
6521
+ * "platformDetails": {
6522
+ * "name": "slack",
6523
+ * "imChannel": "D3F5RQA6B",
6524
+ * "selfChannel": "D1LGYBCFQ",
6525
+ * "userId": "U0JU26WRG",
6526
+ * "teamId": "T0HBUA0TC"
6527
+ * },
6528
+ * "confirmed": true,
6529
+ * "avatar": "https://cdn.workast.io/avatar.png",
6530
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6531
+ * },
6532
+ * "hasDescription": true,
6533
+ * "numberOfComments": 1,
6534
+ * "numberOfAttachments": 0,
6535
+ * "totalSubTasks": 1,
6536
+ * "completedSubTasks": 0,
6537
+ * "isSubscribed": true,
6538
+ * "lastComment": {
6539
+ * "id": "686f7912fc2fef09733c6f58",
6540
+ * "type": "comment",
6541
+ * "value": "Standup",
6542
+ * "status": "active",
6543
+ * "createdAt": "2025-07-10T08:25:54.274Z",
6544
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
6545
+ * "mentions": [
6546
+ * {
6547
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6548
+ * "name": "Ada Lovelace",
6549
+ * "userName": "ada",
6550
+ * "email": "ada@example.com",
6551
+ * "platformDetails": {
6552
+ * "name": "slack",
6553
+ * "imChannel": "D3F5RQA6B",
6554
+ * "selfChannel": "D1LGYBCFQ",
6555
+ * "userId": "U0JU26WRG",
6556
+ * "teamId": "T0HBUA0TC"
6557
+ * },
6558
+ * "confirmed": true,
6559
+ * "avatar": "https://cdn.workast.io/avatar.png",
6560
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6561
+ * }
6562
+ * ],
6563
+ * "reactions": [],
6564
+ * "actor": {
6565
+ * "type": "User",
6566
+ * "data": {
6567
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6568
+ * "name": "Grace Hopper",
6569
+ * "userName": "grace",
6570
+ * "email": "grace@example.com",
6571
+ * "platformDetails": {
6572
+ * "name": "slack",
6573
+ * "imChannel": "D3EEXS3J6",
6574
+ * "selfChannel": "D1HN843U3",
6575
+ * "userId": "U0HBQESA1",
6576
+ * "teamId": "T0HBUA0TC"
6577
+ * },
6578
+ * "confirmed": true,
6579
+ * "avatar": "https://cdn.workast.io/avatar.png",
6580
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6581
+ * }
6582
+ * }
6583
+ * },
6584
+ * "taskStatus": {
6585
+ * "id": "5c7184fa40721e2ed4175a6e",
6586
+ * "label": "Open",
6587
+ * "color": "#808080",
6588
+ * "createdAt": "2019-02-23T17:38:02.928Z",
6589
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
6590
+ * },
6591
+ * "milestones": [],
6592
+ * "inHome": false,
6593
+ * "fields": []
6594
+ * }
6595
+ * ],
6596
+ * "total": 441,
6597
+ * "hiddenTasks": 0
6598
+ * }
6599
+ */
4808
6600
  SearchResults: {
4809
6601
  tasks?: components["schemas"]["TaskListItem"][];
4810
6602
  /** @description Total number of tasks in query. */
@@ -4812,12 +6604,445 @@ interface components {
4812
6604
  /** @description Number of hidden tasks in query. Only applies to cost centers whose product has this restriction. */
4813
6605
  hiddenTasks?: number;
4814
6606
  };
4815
- /** @description Search.buildResource plus optional task results when getTasks is set. */
6607
+ /**
6608
+ * @description Search.buildResource plus optional task results when getTasks is set.
6609
+ * @example {
6610
+ * "id": "5ddfeab45ff6d925d23c929e",
6611
+ * "custom": true,
6612
+ * "name": "Ship v3",
6613
+ * "payload": {
6614
+ * "includeSubTasks": true,
6615
+ * "predicates": [
6616
+ * {
6617
+ * "value": "pending",
6618
+ * "comparison": "eq",
6619
+ * "attribute": "status",
6620
+ * "type": "status"
6621
+ * },
6622
+ * {
6623
+ * "predicates": [
6624
+ * {
6625
+ * "value": "5a176b5aa67ba147e5057516",
6626
+ * "comparison": "eq",
6627
+ * "attribute": "listId",
6628
+ * "type": "list"
6629
+ * },
6630
+ * {
6631
+ * "value": "5d7be323c662860f7c97ba12",
6632
+ * "comparison": "eq",
6633
+ * "attribute": "listId",
6634
+ * "type": "list"
6635
+ * },
6636
+ * {
6637
+ * "value": "5de581bdf2cec034545231fb",
6638
+ * "comparison": "eq",
6639
+ * "attribute": "listId",
6640
+ * "type": "list"
6641
+ * },
6642
+ * {
6643
+ * "value": "5de5818df2cec034545231a2",
6644
+ * "comparison": "eq",
6645
+ * "attribute": "listId",
6646
+ * "type": "list"
6647
+ * },
6648
+ * {
6649
+ * "value": "5dc40cff038a590f79c403c0",
6650
+ * "comparison": "eq",
6651
+ * "attribute": "listId",
6652
+ * "type": "list"
6653
+ * },
6654
+ * {
6655
+ * "type": "list",
6656
+ * "attribute": "listId",
6657
+ * "comparison": "eq",
6658
+ * "value": "5e3d61b624e278106e8f6cf1"
6659
+ * },
6660
+ * {
6661
+ * "type": "list",
6662
+ * "attribute": "listId",
6663
+ * "comparison": "eq",
6664
+ * "value": "5f230805bf972326deafab16"
6665
+ * },
6666
+ * {
6667
+ * "type": "list",
6668
+ * "attribute": "listId",
6669
+ * "comparison": "eq",
6670
+ * "value": "5fc58f3d15ff9110b64ca426"
6671
+ * }
6672
+ * ],
6673
+ * "type": "or"
6674
+ * },
6675
+ * {
6676
+ * "value": "4214932441cb21eebdb396bfe34a8340",
6677
+ * "comparison": "eq",
6678
+ * "attribute": "assignedTo",
6679
+ * "type": "user"
6680
+ * }
6681
+ * ],
6682
+ * "sort": [
6683
+ * {
6684
+ * "field": "listName",
6685
+ * "direction": 1
6686
+ * }
6687
+ * ],
6688
+ * "columns": [
6689
+ * "list",
6690
+ * "subList",
6691
+ * "assignedTo",
6692
+ * "dueDate"
6693
+ * ]
6694
+ * },
6695
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5ddfeab45ff6d925d23c929e",
6696
+ * "isPrimary": false,
6697
+ * "users": [],
6698
+ * "createdBy": {
6699
+ * "user": {
6700
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6701
+ * "name": "Grace Hopper",
6702
+ * "userName": "grace",
6703
+ * "email": "grace@example.com",
6704
+ * "platformDetails": {
6705
+ * "name": "slack",
6706
+ * "imChannel": "D3EEXS3J6",
6707
+ * "selfChannel": "D1HN843U3",
6708
+ * "userId": "U0HBQESA1",
6709
+ * "teamId": "T0HBUA0TC"
6710
+ * },
6711
+ * "confirmed": true,
6712
+ * "avatar": "https://cdn.workast.io/avatar.png",
6713
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6714
+ * }
6715
+ * },
6716
+ * "createdAt": "2019-11-28T15:41:40.245Z",
6717
+ * "updatedAt": "2021-01-14T18:44:34.151Z",
6718
+ * "values": {
6719
+ * "list": {
6720
+ * "5a176b5aa67ba147e5057516": {
6721
+ * "id": "5a176b5aa67ba147e5057516",
6722
+ * "type": "group",
6723
+ * "status": "archived",
6724
+ * "privacy": "team",
6725
+ * "link": "https://app.workast.com/list/5a176b5aa67ba147e5057516",
6726
+ * "name": "Engineering"
6727
+ * },
6728
+ * "5d7be323c662860f7c97ba12": {
6729
+ * "id": "5d7be323c662860f7c97ba12",
6730
+ * "type": "group",
6731
+ * "status": "archived",
6732
+ * "privacy": "team",
6733
+ * "link": "https://app.workast.com/list/5d7be323c662860f7c97ba12",
6734
+ * "name": "Product"
6735
+ * },
6736
+ * "5dc40cff038a590f79c403c0": {
6737
+ * "id": "5dc40cff038a590f79c403c0",
6738
+ * "type": "group",
6739
+ * "status": "active",
6740
+ * "privacy": "team",
6741
+ * "link": "https://app.workast.com/list/5dc40cff038a590f79c403c0",
6742
+ * "name": "Product"
6743
+ * },
6744
+ * "5de5818df2cec034545231a2": {
6745
+ * "id": "5de5818df2cec034545231a2",
6746
+ * "type": "group",
6747
+ * "status": "archived",
6748
+ * "privacy": "team",
6749
+ * "link": "https://app.workast.com/list/5de5818df2cec034545231a2",
6750
+ * "name": "Product"
6751
+ * },
6752
+ * "5de581bdf2cec034545231fb": {
6753
+ * "id": "5de581bdf2cec034545231fb",
6754
+ * "type": "group",
6755
+ * "status": "archived",
6756
+ * "privacy": "team",
6757
+ * "link": "https://app.workast.com/list/5de581bdf2cec034545231fb",
6758
+ * "name": "Product"
6759
+ * },
6760
+ * "5e3d61b624e278106e8f6cf1": {
6761
+ * "id": "5e3d61b624e278106e8f6cf1",
6762
+ * "type": "group",
6763
+ * "status": "archived",
6764
+ * "privacy": "team",
6765
+ * "link": "https://app.workast.com/list/5e3d61b624e278106e8f6cf1",
6766
+ * "name": "Product"
6767
+ * },
6768
+ * "5f230805bf972326deafab16": {
6769
+ * "id": "5f230805bf972326deafab16",
6770
+ * "type": "group",
6771
+ * "status": "active",
6772
+ * "privacy": "team",
6773
+ * "link": "https://app.workast.com/list/5f230805bf972326deafab16",
6774
+ * "name": "Product"
6775
+ * },
6776
+ * "5fc58f3d15ff9110b64ca426": {
6777
+ * "id": "5fc58f3d15ff9110b64ca426",
6778
+ * "type": "group",
6779
+ * "status": "active",
6780
+ * "privacy": "team",
6781
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
6782
+ * "name": "Product"
6783
+ * }
6784
+ * },
6785
+ * "user": {
6786
+ * "4214932441cb21eebdb396bfe34a8340": {
6787
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6788
+ * "name": "Grace Hopper",
6789
+ * "userName": "grace",
6790
+ * "email": "grace@example.com",
6791
+ * "platformDetails": {
6792
+ * "name": "slack",
6793
+ * "imChannel": "D3EEXS3J6",
6794
+ * "selfChannel": "D1HN843U3",
6795
+ * "userId": "U0HBQESA1",
6796
+ * "teamId": "T0HBUA0TC"
6797
+ * },
6798
+ * "confirmed": true,
6799
+ * "avatar": "https://cdn.workast.io/avatar.png",
6800
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6801
+ * }
6802
+ * }
6803
+ * },
6804
+ * "results": {
6805
+ * "tasks": [
6806
+ * {
6807
+ * "status": "pending",
6808
+ * "text": "Ship v3",
6809
+ * "shortId": "TGNT8",
6810
+ * "createdAt": "2026-07-30T11:06:01.976Z",
6811
+ * "updatedAt": "2026-08-03T04:47:29.070Z",
6812
+ * "listPosition": -400001,
6813
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/11c933fd54aab8cfe9957ab46ccb401f",
6814
+ * "calendars": [
6815
+ * "4214932441cb21eebdb396bfe34a8340"
6816
+ * ],
6817
+ * "id": "11c933fd54aab8cfe9957ab46ccb401f",
6818
+ * "list": {
6819
+ * "id": "5dc40cff038a590f79c403c0",
6820
+ * "name": "Development Product",
6821
+ * "type": "group",
6822
+ * "privacy": "team",
6823
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/space/5dc40cff038a590f79c403c0",
6824
+ * "subLists": [
6825
+ * {
6826
+ * "id": "5dc40d3f7e802c0f93f20232",
6827
+ * "name": "Live testing",
6828
+ * "listPosition": 100000,
6829
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6830
+ * }
6831
+ * ]
6832
+ * },
6833
+ * "listId": "5dc40cff038a590f79c403c0",
6834
+ * "subListId": "5dc40d3f7e802c0f93f20232",
6835
+ * "subList": {
6836
+ * "id": "5dc40d3f7e802c0f93f20232",
6837
+ * "name": "Live testing"
6838
+ * },
6839
+ * "assignedTo": [
6840
+ * {
6841
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6842
+ * "name": "Grace Hopper",
6843
+ * "userName": "grace",
6844
+ * "email": "grace@example.com",
6845
+ * "platformDetails": {
6846
+ * "name": "slack",
6847
+ * "imChannel": "D3EEXS3J6",
6848
+ * "selfChannel": "D1HN843U3",
6849
+ * "userId": "U0HBQESA1",
6850
+ * "teamId": "T0HBUA0TC"
6851
+ * },
6852
+ * "confirmed": true,
6853
+ * "avatar": "https://cdn.workast.io/avatar.png",
6854
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6855
+ * }
6856
+ * ],
6857
+ * "subscribers": [
6858
+ * {
6859
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6860
+ * "name": "Grace Hopper",
6861
+ * "userName": "grace",
6862
+ * "email": "grace@example.com",
6863
+ * "platformDetails": {
6864
+ * "name": "slack",
6865
+ * "imChannel": "D3EEXS3J6",
6866
+ * "selfChannel": "D1HN843U3",
6867
+ * "userId": "U0HBQESA1",
6868
+ * "teamId": "T0HBUA0TC"
6869
+ * },
6870
+ * "confirmed": true,
6871
+ * "avatar": "https://cdn.workast.io/avatar.png",
6872
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6873
+ * }
6874
+ * ],
6875
+ * "allDay": false,
6876
+ * "createdBy": {
6877
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6878
+ * "name": "Grace Hopper",
6879
+ * "userName": "grace",
6880
+ * "email": "grace@example.com",
6881
+ * "platformDetails": {
6882
+ * "name": "slack",
6883
+ * "imChannel": "D3EEXS3J6",
6884
+ * "selfChannel": "D1HN843U3",
6885
+ * "userId": "U0HBQESA1",
6886
+ * "teamId": "T0HBUA0TC"
6887
+ * },
6888
+ * "confirmed": true,
6889
+ * "avatar": "https://cdn.workast.io/avatar.png",
6890
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6891
+ * },
6892
+ * "hasDescription": true,
6893
+ * "numberOfComments": 0,
6894
+ * "numberOfAttachments": 0,
6895
+ * "totalSubTasks": 2,
6896
+ * "completedSubTasks": 2,
6897
+ * "isSubscribed": true,
6898
+ * "taskStatus": {
6899
+ * "id": "5c7184fa40721e2ed4175a6e",
6900
+ * "label": "Open",
6901
+ * "color": "#808080",
6902
+ * "createdAt": "2019-02-23T17:38:02.928Z",
6903
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
6904
+ * },
6905
+ * "milestones": [],
6906
+ * "inHome": false,
6907
+ * "fields": []
6908
+ * }
6909
+ * ],
6910
+ * "total": 12,
6911
+ * "hiddenTasks": 0
6912
+ * }
6913
+ * }
6914
+ */
4816
6915
  SearchDetail: components["schemas"]["Search"] & {
4817
6916
  /** @description Matching tasks. Present when getTasks is set. */
4818
6917
  results?: components["schemas"]["SearchResults"];
4819
6918
  };
4820
- /** @description Paginated notes. Each item from Note.buildMinimalResource. */
6919
+ /**
6920
+ * @description Paginated notes. Each item from Note.buildMinimalResource.
6921
+ * @example {
6922
+ * "notes": [
6923
+ * {
6924
+ * "id": "6994a3e051b10d097caddd0f",
6925
+ * "title": "Ship v3",
6926
+ * "createdAt": "2026-02-17T17:22:40.359Z",
6927
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
6928
+ * "version": 58,
6929
+ * "list": {
6930
+ * "id": "6938534c1679f90979e5ccf4",
6931
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
6932
+ * "name": "Engineering",
6933
+ * "numberOfParticipants": 2,
6934
+ * "type": "group",
6935
+ * "slug": "engineering",
6936
+ * "privacy": "team",
6937
+ * "platformDetails": {
6938
+ * "type": "group"
6939
+ * },
6940
+ * "isArchived": false,
6941
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
6942
+ * "participants": [
6943
+ * "67c6206fc7cb0feb115113cdf71aa72d",
6944
+ * "4214932441cb21eebdb396bfe34a8340"
6945
+ * ],
6946
+ * "platformNotifications": {
6947
+ * "taskCreated": true,
6948
+ * "taskCompleted": true
6949
+ * },
6950
+ * "apps": [
6951
+ * {
6952
+ * "id": "5b23da45e7179a589282a60c",
6953
+ * "name": "Email",
6954
+ * "description": "Ship v3",
6955
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
6956
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
6957
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
6958
+ * "accessType": "user",
6959
+ * "developedByWorkast": true,
6960
+ * "integration": {
6961
+ * "spaceActions": [
6962
+ * {
6963
+ * "actionId": "SHOW_SETTINGS",
6964
+ * "label": "Email"
6965
+ * }
6966
+ * ],
6967
+ * "taskActions": []
6968
+ * }
6969
+ * },
6970
+ * {
6971
+ * "name": "Example App",
6972
+ * "description": "Ship v3",
6973
+ * "icon": "https://cdn.workast.io/avatar.png",
6974
+ * "createdAt": "2019-10-06T22:30:33.687Z",
6975
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
6976
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
6977
+ * "accessType": "user",
6978
+ * "developedByWorkast": true,
6979
+ * "id": "5d83a3de767119000151da7a"
6980
+ * }
6981
+ * ],
6982
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
6983
+ * "subLists": [
6984
+ * {
6985
+ * "id": "6938534c1679f90979e5ccf3",
6986
+ * "name": "To-do",
6987
+ * "listPosition": 100000,
6988
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
6989
+ * },
6990
+ * {
6991
+ * "id": "693853701679f90979e5d186",
6992
+ * "name": "In Progress",
6993
+ * "listPosition": 200000,
6994
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
6995
+ * }
6996
+ * ],
6997
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
6998
+ * "isParticipant": true,
6999
+ * "someParticipants": [
7000
+ * {
7001
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7002
+ * "name": "Katherine Johnson",
7003
+ * "userName": "katherine",
7004
+ * "email": "katherine@example.com",
7005
+ * "platformDetails": {
7006
+ * "name": "slack",
7007
+ * "imChannel": "D06JN8RT8KB",
7008
+ * "selfChannel": "D06HV290V6K",
7009
+ * "userId": "U06J9JSF6R0",
7010
+ * "teamId": "T0HBUA0TC"
7011
+ * },
7012
+ * "confirmed": false,
7013
+ * "avatar": "https://cdn.workast.io/avatar.png",
7014
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7015
+ * }
7016
+ * ],
7017
+ * "columns": [
7018
+ * "assignedTo",
7019
+ * "dueDate",
7020
+ * "doneBy",
7021
+ * "doneAt"
7022
+ * ],
7023
+ * "groupBy": "subList"
7024
+ * },
7025
+ * "createdBy": {
7026
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7027
+ * "name": "Katherine Johnson",
7028
+ * "userName": "katherine",
7029
+ * "email": "katherine@example.com",
7030
+ * "platformDetails": {
7031
+ * "name": "slack",
7032
+ * "imChannel": "D06JN8RT8KB",
7033
+ * "selfChannel": "D06HV290V6K",
7034
+ * "userId": "U06J9JSF6R0",
7035
+ * "teamId": "T0HBUA0TC"
7036
+ * },
7037
+ * "confirmed": false,
7038
+ * "avatar": "https://cdn.workast.io/avatar.png",
7039
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7040
+ * }
7041
+ * }
7042
+ * ],
7043
+ * "total": 168
7044
+ * }
7045
+ */
4821
7046
  Notes: {
4822
7047
  /**
4823
7048
  * @description Total records matched by the filters
@@ -4827,7 +7052,128 @@ interface components {
4827
7052
  /** @description Notes matching the filters */
4828
7053
  notes: components["schemas"]["Note"][];
4829
7054
  };
4830
- /** @description Minimal note. Built by Note.buildMinimalResource. */
7055
+ /**
7056
+ * @description Minimal note. Built by Note.buildMinimalResource.
7057
+ * @example {
7058
+ * "id": "6994a3e051b10d097caddd0f",
7059
+ * "title": "Ship v3",
7060
+ * "createdAt": "2026-02-17T17:22:40.359Z",
7061
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
7062
+ * "version": 58,
7063
+ * "list": {
7064
+ * "id": "6938534c1679f90979e5ccf4",
7065
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
7066
+ * "name": "Engineering",
7067
+ * "numberOfParticipants": 2,
7068
+ * "type": "group",
7069
+ * "slug": "engineering",
7070
+ * "privacy": "team",
7071
+ * "platformDetails": {
7072
+ * "type": "group"
7073
+ * },
7074
+ * "isArchived": false,
7075
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
7076
+ * "participants": [
7077
+ * "67c6206fc7cb0feb115113cdf71aa72d",
7078
+ * "4214932441cb21eebdb396bfe34a8340"
7079
+ * ],
7080
+ * "platformNotifications": {
7081
+ * "taskCreated": true,
7082
+ * "taskCompleted": true
7083
+ * },
7084
+ * "apps": [
7085
+ * {
7086
+ * "id": "5b23da45e7179a589282a60c",
7087
+ * "name": "Email",
7088
+ * "description": "Ship v3",
7089
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
7090
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7091
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
7092
+ * "accessType": "user",
7093
+ * "developedByWorkast": true,
7094
+ * "integration": {
7095
+ * "spaceActions": [
7096
+ * {
7097
+ * "actionId": "SHOW_SETTINGS",
7098
+ * "label": "Email"
7099
+ * }
7100
+ * ],
7101
+ * "taskActions": []
7102
+ * }
7103
+ * },
7104
+ * {
7105
+ * "name": "Example App",
7106
+ * "description": "Ship v3",
7107
+ * "icon": "https://cdn.workast.io/avatar.png",
7108
+ * "createdAt": "2019-10-06T22:30:33.687Z",
7109
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7110
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
7111
+ * "accessType": "user",
7112
+ * "developedByWorkast": true,
7113
+ * "id": "5d83a3de767119000151da7a"
7114
+ * }
7115
+ * ],
7116
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
7117
+ * "subLists": [
7118
+ * {
7119
+ * "id": "6938534c1679f90979e5ccf3",
7120
+ * "name": "To-do",
7121
+ * "listPosition": 100000,
7122
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7123
+ * },
7124
+ * {
7125
+ * "id": "693853701679f90979e5d186",
7126
+ * "name": "In Progress",
7127
+ * "listPosition": 200000,
7128
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7129
+ * }
7130
+ * ],
7131
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
7132
+ * "isParticipant": true,
7133
+ * "someParticipants": [
7134
+ * {
7135
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7136
+ * "name": "Katherine Johnson",
7137
+ * "userName": "katherine",
7138
+ * "email": "katherine@example.com",
7139
+ * "platformDetails": {
7140
+ * "name": "slack",
7141
+ * "imChannel": "D06JN8RT8KB",
7142
+ * "selfChannel": "D06HV290V6K",
7143
+ * "userId": "U06J9JSF6R0",
7144
+ * "teamId": "T0HBUA0TC"
7145
+ * },
7146
+ * "confirmed": false,
7147
+ * "avatar": "https://cdn.workast.io/avatar.png",
7148
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7149
+ * }
7150
+ * ],
7151
+ * "columns": [
7152
+ * "assignedTo",
7153
+ * "dueDate",
7154
+ * "doneBy",
7155
+ * "doneAt"
7156
+ * ],
7157
+ * "groupBy": "subList"
7158
+ * },
7159
+ * "createdBy": {
7160
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7161
+ * "name": "Katherine Johnson",
7162
+ * "userName": "katherine",
7163
+ * "email": "katherine@example.com",
7164
+ * "platformDetails": {
7165
+ * "name": "slack",
7166
+ * "imChannel": "D06JN8RT8KB",
7167
+ * "selfChannel": "D06HV290V6K",
7168
+ * "userId": "U06J9JSF6R0",
7169
+ * "teamId": "T0HBUA0TC"
7170
+ * },
7171
+ * "confirmed": false,
7172
+ * "avatar": "https://cdn.workast.io/avatar.png",
7173
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7174
+ * }
7175
+ * }
7176
+ */
4831
7177
  Note: {
4832
7178
  /** @description The note ID. */
4833
7179
  id?: string;
@@ -4850,7 +7196,129 @@ interface components {
4850
7196
  */
4851
7197
  updatedAt?: string;
4852
7198
  };
4853
- /** @description Full note. Built by Note.buildResource (buildMinimalResource plus body). */
7199
+ /**
7200
+ * @description Full note. Built by Note.buildResource (buildMinimalResource plus body).
7201
+ * @example {
7202
+ * "id": "6994a3e051b10d097caddd0f",
7203
+ * "title": "Ship v3",
7204
+ * "createdAt": "2026-02-17T17:22:40.359Z",
7205
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
7206
+ * "version": 58,
7207
+ * "list": {
7208
+ * "id": "6938534c1679f90979e5ccf4",
7209
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
7210
+ * "name": "Engineering",
7211
+ * "numberOfParticipants": 2,
7212
+ * "type": "group",
7213
+ * "slug": "engineering",
7214
+ * "privacy": "team",
7215
+ * "platformDetails": {
7216
+ * "type": "group"
7217
+ * },
7218
+ * "isArchived": false,
7219
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
7220
+ * "participants": [
7221
+ * "67c6206fc7cb0feb115113cdf71aa72d",
7222
+ * "4214932441cb21eebdb396bfe34a8340"
7223
+ * ],
7224
+ * "platformNotifications": {
7225
+ * "taskCreated": true,
7226
+ * "taskCompleted": true
7227
+ * },
7228
+ * "apps": [
7229
+ * {
7230
+ * "id": "5b23da45e7179a589282a60c",
7231
+ * "name": "Email",
7232
+ * "description": "Ship v3",
7233
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
7234
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7235
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
7236
+ * "accessType": "user",
7237
+ * "developedByWorkast": true,
7238
+ * "integration": {
7239
+ * "spaceActions": [
7240
+ * {
7241
+ * "actionId": "SHOW_SETTINGS",
7242
+ * "label": "Email"
7243
+ * }
7244
+ * ],
7245
+ * "taskActions": []
7246
+ * }
7247
+ * },
7248
+ * {
7249
+ * "name": "Example App",
7250
+ * "description": "Ship v3",
7251
+ * "icon": "https://cdn.workast.io/avatar.png",
7252
+ * "createdAt": "2019-10-06T22:30:33.687Z",
7253
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7254
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
7255
+ * "accessType": "user",
7256
+ * "developedByWorkast": true,
7257
+ * "id": "5d83a3de767119000151da7a"
7258
+ * }
7259
+ * ],
7260
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
7261
+ * "subLists": [
7262
+ * {
7263
+ * "id": "6938534c1679f90979e5ccf3",
7264
+ * "name": "To-do",
7265
+ * "listPosition": 100000,
7266
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7267
+ * },
7268
+ * {
7269
+ * "id": "693853701679f90979e5d186",
7270
+ * "name": "In Progress",
7271
+ * "listPosition": 200000,
7272
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7273
+ * }
7274
+ * ],
7275
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
7276
+ * "isParticipant": true,
7277
+ * "someParticipants": [
7278
+ * {
7279
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7280
+ * "name": "Katherine Johnson",
7281
+ * "userName": "katherine",
7282
+ * "email": "katherine@example.com",
7283
+ * "platformDetails": {
7284
+ * "name": "slack",
7285
+ * "imChannel": "D06JN8RT8KB",
7286
+ * "selfChannel": "D06HV290V6K",
7287
+ * "userId": "U06J9JSF6R0",
7288
+ * "teamId": "T0HBUA0TC"
7289
+ * },
7290
+ * "confirmed": false,
7291
+ * "avatar": "https://cdn.workast.io/avatar.png",
7292
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7293
+ * }
7294
+ * ],
7295
+ * "columns": [
7296
+ * "assignedTo",
7297
+ * "dueDate",
7298
+ * "doneBy",
7299
+ * "doneAt"
7300
+ * ],
7301
+ * "groupBy": "subList"
7302
+ * },
7303
+ * "createdBy": {
7304
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7305
+ * "name": "Katherine Johnson",
7306
+ * "userName": "katherine",
7307
+ * "email": "katherine@example.com",
7308
+ * "platformDetails": {
7309
+ * "name": "slack",
7310
+ * "imChannel": "D06JN8RT8KB",
7311
+ * "selfChannel": "D06HV290V6K",
7312
+ * "userId": "U06J9JSF6R0",
7313
+ * "teamId": "T0HBUA0TC"
7314
+ * },
7315
+ * "confirmed": false,
7316
+ * "avatar": "https://cdn.workast.io/avatar.png",
7317
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7318
+ * },
7319
+ * "body": "<p>Ship v3</p>"
7320
+ * }
7321
+ */
4854
7322
  NoteDetail: components["schemas"]["Note"] & {
4855
7323
  /** @description HTML note content. Empty string when version is 0 or the S3 file is missing. */
4856
7324
  body: string;
@@ -4871,14 +7339,61 @@ interface components {
4871
7339
  name?: string;
4872
7340
  };
4873
7341
  TaskColumns: ("assignedTo" | "dueDate" | "shortId" | "startDate" | "createdBy" | "createdAt" | "list" | "updatedAt" | "subList" | "doneBy" | "doneAt" | "duration" | "field:field_id")[];
4874
- /** @description Paginated workflows from GET /workflow. Each item from Workflow.buildResource. */
7342
+ /**
7343
+ * @description Paginated workflows from GET /workflow. Each item from Workflow.buildResource.
7344
+ * @example {
7345
+ * "workflows": [
7346
+ * {
7347
+ * "id": "673b14ef1231f8099d5c96a4",
7348
+ * "trigger": {
7349
+ * "name": "event",
7350
+ * "value": "task_created"
7351
+ * },
7352
+ * "prompt": "Ship v3",
7353
+ * "lists": [
7354
+ * {
7355
+ * "id": "673b0b7b1231f8099d5ba067",
7356
+ * "type": "group",
7357
+ * "status": "archived",
7358
+ * "privacy": "team",
7359
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7360
+ * "name": "Engineering"
7361
+ * }
7362
+ * ],
7363
+ * "status": "active"
7364
+ * }
7365
+ * ],
7366
+ * "total": 11
7367
+ * }
7368
+ */
4875
7369
  Workflows: {
4876
7370
  /** @description Workflows created by the logged-in user, excluding removed. */
4877
7371
  workflows: components["schemas"]["Workflow"][];
4878
7372
  /** @description Total number of matching workflows. */
4879
7373
  total: number;
4880
7374
  };
4881
- /** @description Workflow.buildResource. */
7375
+ /**
7376
+ * @description Workflow.buildResource.
7377
+ * @example {
7378
+ * "id": "673b14ef1231f8099d5c96a4",
7379
+ * "trigger": {
7380
+ * "name": "event",
7381
+ * "value": "task_created"
7382
+ * },
7383
+ * "prompt": "Ship v3",
7384
+ * "lists": [
7385
+ * {
7386
+ * "id": "673b0b7b1231f8099d5ba067",
7387
+ * "type": "group",
7388
+ * "status": "archived",
7389
+ * "privacy": "team",
7390
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7391
+ * "name": "Engineering"
7392
+ * }
7393
+ * ],
7394
+ * "status": "active"
7395
+ * }
7396
+ */
4882
7397
  Workflow: {
4883
7398
  /** @description The workflow ID. */
4884
7399
  id: string;
@@ -4926,7 +7441,45 @@ interface components {
4926
7441
  /** @description Cron expression. Applied when the workflow trigger is cron. Maps to trigger.value on the workflow. */
4927
7442
  trigger?: string;
4928
7443
  };
4929
- /** @description GET /workflow/{workflowId} body. Workflow.buildResource plus paginated runs from WorkflowRun.buildResource. */
7444
+ /**
7445
+ * @description GET /workflow/{workflowId} body. Workflow.buildResource plus paginated runs from WorkflowRun.buildResource.
7446
+ * @example {
7447
+ * "id": "673b14ef1231f8099d5c96a4",
7448
+ * "trigger": {
7449
+ * "name": "event",
7450
+ * "value": "task_created"
7451
+ * },
7452
+ * "prompt": "Ship v3",
7453
+ * "lists": [
7454
+ * {
7455
+ * "id": "673b0b7b1231f8099d5ba067",
7456
+ * "type": "group",
7457
+ * "status": "archived",
7458
+ * "privacy": "team",
7459
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7460
+ * "name": "Engineering"
7461
+ * }
7462
+ * ],
7463
+ * "status": "active",
7464
+ * "runs": [
7465
+ * {
7466
+ * "id": "673bffe012f608759e4bebca",
7467
+ * "result": "Ship v3",
7468
+ * "activity": {
7469
+ * "id": "673bffdc77ac5a0996dc537d",
7470
+ * "task": {
7471
+ * "id": "e1bb3fcad526680b6e7387e988fea1d9",
7472
+ * "text": "Ship v3",
7473
+ * "shortId": "T31UJ",
7474
+ * "link": "https://app.workast.com/task/e1bb3fcad526680b6e7387e988fea1d9"
7475
+ * }
7476
+ * },
7477
+ * "createdAt": "2024-11-19T03:02:56.261Z"
7478
+ * }
7479
+ * ],
7480
+ * "totalRuns": 4
7481
+ * }
7482
+ */
4930
7483
  WorkflowDetail: components["schemas"]["Workflow"] & {
4931
7484
  /** @description Workflow runs for this workflow. Each item from WorkflowRun.buildResource. */
4932
7485
  runs: components["schemas"]["WorkflowRun"][];
@@ -5332,9 +7885,7 @@ interface operations {
5332
7885
  [name: string]: unknown;
5333
7886
  };
5334
7887
  content: {
5335
- "application/json": components["schemas"]["UserDetail"] & {
5336
- team?: components["schemas"]["Team"];
5337
- };
7888
+ "application/json": components["schemas"]["UserDetailWithTeam"];
5338
7889
  };
5339
7890
  };
5340
7891
  /** @description Bad request */
@@ -12355,7 +14906,7 @@ interface operations {
12355
14906
 
12356
14907
  /**
12357
14908
  * This file was generated by scripts/generate-types.mjs. Do not edit.
12358
- * Source swagger SHA-256: be9f451bbac4f67dfe07c4aeca0574d2d7eb021b16ac465d15fdd91b76cfbccc
14909
+ * Source swagger SHA-256: ffefeeb250be1f2cfa1b6cdd478c4547a1b003dd0e590924dfbecd6d2862164c
12359
14910
  */
12360
14911
 
12361
14912
  type ActivityBody = components["schemas"]["ActivityBody"];
@@ -12435,6 +14986,7 @@ type TokenTeam = components["schemas"]["TokenTeam"];
12435
14986
  type TokenUser = components["schemas"]["TokenUser"];
12436
14987
  type User = components["schemas"]["User"];
12437
14988
  type UserDetail = components["schemas"]["UserDetail"];
14989
+ type UserDetailWithTeam = components["schemas"]["UserDetailWithTeam"];
12438
14990
  type UserInvite = components["schemas"]["UserInvite"];
12439
14991
  type UserResource = components["schemas"]["UserResource"];
12440
14992
  type Workflow = components["schemas"]["Workflow"];
@@ -13226,9 +15778,7 @@ declare class Users {
13226
15778
  * @example
13227
15779
  * const user = await workast.users.retrieveByEmail('ada@example.com');
13228
15780
  */
13229
- retrieveByEmail(email: string, query?: UserByEmailQuery, options?: RequestOptions): Promise<UserDetail & {
13230
- team?: Team;
13231
- }>;
15781
+ retrieveByEmail(email: string, query?: UserByEmailQuery, options?: RequestOptions): Promise<UserDetailWithTeam>;
13232
15782
  /**
13233
15783
  * Invite a user to the team.
13234
15784
  *
@@ -13358,4 +15908,4 @@ declare class ValidationError extends ApiError {
13358
15908
  constructor(message: string, status?: number, body?: unknown);
13359
15909
  }
13360
15910
 
13361
- export { type ActivityBody, ApiError, type Attachment, type AttachmentFileUrl, type AttachmentFileUrlQuery, AuthenticationError, type CalendarEvent, type CalendarEventSearchQuery, type CalendarEvents, type CommentActivity, type ConvertToSubtask, type CustomField, type CustomFieldCreate, type CustomFieldPatch, type CustomFieldSearchQuery, type Emoji, type HomeTasks, type ImportTemplate, type List, type ListCreate, type ListEnumerate, type ListParticipants, type ListPatch, type ListSearchQuery, type Meeting, type MeetingCreate, type MeetingCreateEvent, type MeetingDetail, type MeetingMinimalResource, type MeetingNotetakerEnable, type MeetingPatch, type MeetingRecordingResource, type MeetingSearchQuery, type Meetings, type NewAttachment, NotFoundError, type Note, type NoteDetail, type NotePatch, type NoteSearchQuery, type Notes, type Notification, type NotificationSearchQuery, type NotificationType, type Notifications, PermissionError, type ReactionCreate, type ReactionReadOnly, type ReactionUser, type Repeat, type RepeatSchema, type RequestOptions, type Search, type SearchCreate, type SearchDetail, type SearchFindQuery, type SearchItem, type SearchPatch, type SearchPayload, type SearchReminderSet, type SearchResults, type SearchRetrieveQuery, type SearchShare, type Searches, type SubList, type SubListCreate, type SubListPatch, type SubListSearchQuery, type SubtaskCreate, type Tag, type TagCreate, type TagPatch, type TagSearchQuery, type Task, type TaskActivities, type TaskActivityBody, type TaskActivitySearchQuery, type TaskAssignment, type TaskBulkCreate, type TaskBulkUpdate, type TaskBulkUpdateResult, type TaskCreate, type TaskFollow, type TaskMove, type TaskPatch, type TaskSearch, type TaskTag, type Team, type TokenApp, type TokenDetails, type TokenTeam, type TokenUser, type User, type UserByEmailQuery, type UserDetail, type UserInvite, type UserResource, type UserSearchQuery, ValidationError, Workast, type WorkastAuth, type WorkastOptions, type Workflow, type WorkflowCreate, type WorkflowDetail, type WorkflowPatch, type WorkflowRun, type WorkflowRunActivity, type WorkflowSearchQuery, type WorkflowTrigger, type Workflows };
15911
+ export { type ActivityBody, ApiError, type Attachment, type AttachmentFileUrl, type AttachmentFileUrlQuery, AuthenticationError, type CalendarEvent, type CalendarEventSearchQuery, type CalendarEvents, type CommentActivity, type ConvertToSubtask, type CustomField, type CustomFieldCreate, type CustomFieldPatch, type CustomFieldSearchQuery, type Emoji, type HomeTasks, type ImportTemplate, type List, type ListCreate, type ListEnumerate, type ListParticipants, type ListPatch, type ListSearchQuery, type Meeting, type MeetingCreate, type MeetingCreateEvent, type MeetingDetail, type MeetingMinimalResource, type MeetingNotetakerEnable, type MeetingPatch, type MeetingRecordingResource, type MeetingSearchQuery, type Meetings, type NewAttachment, NotFoundError, type Note, type NoteDetail, type NotePatch, type NoteSearchQuery, type Notes, type Notification, type NotificationSearchQuery, type NotificationType, type Notifications, PermissionError, type ReactionCreate, type ReactionReadOnly, type ReactionUser, type Repeat, type RepeatSchema, type RequestOptions, type Search, type SearchCreate, type SearchDetail, type SearchFindQuery, type SearchItem, type SearchPatch, type SearchPayload, type SearchReminderSet, type SearchResults, type SearchRetrieveQuery, type SearchShare, type Searches, type SubList, type SubListCreate, type SubListPatch, type SubListSearchQuery, type SubtaskCreate, type Tag, type TagCreate, type TagPatch, type TagSearchQuery, type Task, type TaskActivities, type TaskActivityBody, type TaskActivitySearchQuery, type TaskAssignment, type TaskBulkCreate, type TaskBulkUpdate, type TaskBulkUpdateResult, type TaskCreate, type TaskFollow, type TaskMove, type TaskPatch, type TaskSearch, type TaskTag, type Team, type TokenApp, type TokenDetails, type TokenTeam, type TokenUser, type User, type UserByEmailQuery, type UserDetail, type UserDetailWithTeam, type UserInvite, type UserResource, type UserSearchQuery, ValidationError, Workast, type WorkastAuth, type WorkastOptions, type Workflow, type WorkflowCreate, type WorkflowDetail, type WorkflowPatch, type WorkflowRun, type WorkflowRunActivity, type WorkflowSearchQuery, type WorkflowTrigger, type Workflows };