@workast/sdk 3.0.0 → 3.2.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.ts 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: 960f8629333a3f09cac00abc7fc8fb7d68c165cac7a216639e536d9c6af24c04
9
9
  */
10
10
 
11
11
  interface paths {
@@ -471,6 +471,26 @@ interface paths {
471
471
  patch?: never;
472
472
  trace?: never;
473
473
  };
474
+ "/search/home": {
475
+ parameters: {
476
+ query?: never;
477
+ header?: never;
478
+ path?: never;
479
+ cookie?: never;
480
+ };
481
+ /**
482
+ * List searches pinned on the home screen.
483
+ * @description Returns the acting user's home searches (user.homeSearches).
484
+ */
485
+ get: operations["findHomeSearches"];
486
+ put?: never;
487
+ post?: never;
488
+ delete?: never;
489
+ options?: never;
490
+ head?: never;
491
+ patch?: never;
492
+ trace?: never;
493
+ };
474
494
  "/search/{searchId}": {
475
495
  parameters: {
476
496
  query?: never;
@@ -714,6 +734,26 @@ interface paths {
714
734
  patch?: never;
715
735
  trace?: never;
716
736
  };
737
+ "/list/personal/task": {
738
+ parameters: {
739
+ query?: never;
740
+ header?: never;
741
+ path?: never;
742
+ cookie?: never;
743
+ };
744
+ get?: never;
745
+ put?: never;
746
+ /**
747
+ * Creates a new task in the personal list
748
+ * @description Creates a new task in the authenticated user's personal list. The personal list is created if it does not exist.
749
+ */
750
+ post: operations["createPersonalListTask"];
751
+ delete?: never;
752
+ options?: never;
753
+ head?: never;
754
+ patch?: never;
755
+ trace?: never;
756
+ };
717
757
  "/list/{listId}/participant": {
718
758
  parameters: {
719
759
  query?: never;
@@ -858,6 +898,23 @@ interface paths {
858
898
  patch?: never;
859
899
  trace?: never;
860
900
  };
901
+ "/list/{listId}/note": {
902
+ parameters: {
903
+ query?: never;
904
+ header?: never;
905
+ path?: never;
906
+ cookie?: never;
907
+ };
908
+ get?: never;
909
+ put?: never;
910
+ /** Create a Note */
911
+ post: operations["createNote"];
912
+ delete?: never;
913
+ options?: never;
914
+ head?: never;
915
+ patch?: never;
916
+ trace?: never;
917
+ };
861
918
  "/note": {
862
919
  parameters: {
863
920
  query?: never;
@@ -1264,7 +1321,36 @@ interface paths {
1264
1321
  }
1265
1322
  interface components {
1266
1323
  schemas: {
1267
- /** @description GET /calendar/events body. Each item is a Nylas event enriched by Meeting.enrichCalendarEventsForUser. */
1324
+ /**
1325
+ * @description GET /calendar/events body. Each item is a Nylas event enriched by Meeting.enrichCalendarEventsForUser.
1326
+ * @example {
1327
+ * "events": [
1328
+ * {
1329
+ * "busy": true,
1330
+ * "calendarId": "grace@example.com",
1331
+ * "createdAt": 1781850701,
1332
+ * "icalUid": "3b5ei15dmlrh6et2aqf7q07hbk@example.com",
1333
+ * "id": "3b5ei15dmlrh6et2aqf7q07hbk",
1334
+ * "organizer": {
1335
+ * "email": "grace@example.com",
1336
+ * "name": "Grace Hopper"
1337
+ * },
1338
+ * "participants": [],
1339
+ * "readOnly": false,
1340
+ * "status": "confirmed",
1341
+ * "title": "Standup",
1342
+ * "updatedAt": 1782098660,
1343
+ * "visibility": "default",
1344
+ * "when": {
1345
+ * "endDate": "2026-07-18",
1346
+ * "object": "datespan",
1347
+ * "startDate": "2026-06-27"
1348
+ * },
1349
+ * "meeting": null
1350
+ * }
1351
+ * ]
1352
+ * }
1353
+ */
1268
1354
  CalendarEvents: {
1269
1355
  /** @description Calendar events in the requested timeframe, excluding Workast task-backed events. */
1270
1356
  events: components["schemas"]["CalendarEvent"][];
@@ -1422,7 +1508,38 @@ interface components {
1422
1508
  */
1423
1509
  preferredListId?: string | null;
1424
1510
  };
1425
- /** @description Custom field. Built by Field.buildResource. */
1511
+ /**
1512
+ * @description Custom field. Built by Field.buildResource.
1513
+ * @example {
1514
+ * "id": "61a50f7ed892d94d8c9d285e",
1515
+ * "name": "Priority",
1516
+ * "description": "Ship v3",
1517
+ * "type": "options",
1518
+ * "useAsTaskColor": false,
1519
+ * "options": [
1520
+ * {
1521
+ * "id": "61a50f7ed892d94d8c9d285f",
1522
+ * "name": "Low",
1523
+ * "color": "#F2994A"
1524
+ * },
1525
+ * {
1526
+ * "id": "63ec2019d467b10e1de14f02",
1527
+ * "name": "Medium",
1528
+ * "color": "#20e48b"
1529
+ * },
1530
+ * {
1531
+ * "id": "63ec2019d467b10e1de14f03",
1532
+ * "name": "Normal",
1533
+ * "color": "#1156ff"
1534
+ * },
1535
+ * {
1536
+ * "id": "63ec2019d467b10e1de14f04",
1537
+ * "name": "High",
1538
+ * "color": "#f50c0c"
1539
+ * }
1540
+ * ]
1541
+ * }
1542
+ */
1426
1543
  CustomField: {
1427
1544
  /** @description The id of the custom field */
1428
1545
  id: string;
@@ -1514,7 +1631,24 @@ interface components {
1514
1631
  */
1515
1632
  value: string;
1516
1633
  }[];
1517
- /** @description GET /meeting/{meetingId}/recording body. Built by the getRecording handler. Both keys omitted when nil, so the body may be {}. */
1634
+ /**
1635
+ * @description GET /meeting/{meetingId}/recording body. Built by the getRecording handler. Both keys omitted when nil, so the body may be {}.
1636
+ * @example {
1637
+ * "transcript": {
1638
+ * "object": "transcript",
1639
+ * "type": "speaker_labelled",
1640
+ * "language": "es",
1641
+ * "transcript": [
1642
+ * {
1643
+ * "speaker": "Speaker A",
1644
+ * "start": 37850,
1645
+ * "end": 116040,
1646
+ * "text": "Standup"
1647
+ * }
1648
+ * ]
1649
+ * }
1650
+ * }
1651
+ */
1518
1652
  MeetingRecordingResource: {
1519
1653
  media?: components["schemas"]["MeetingRecordingMedia"];
1520
1654
  transcript?: components["schemas"]["MeetingTranscript"];
@@ -1563,7 +1697,77 @@ interface components {
1563
1697
  end?: number;
1564
1698
  text?: string;
1565
1699
  };
1566
- /** @description Paginated meetings from GET /meeting. Each item from Meeting.buildMinimalResource. */
1700
+ /**
1701
+ * @description Paginated meetings from GET /meeting. Each item from Meeting.buildMinimalResource.
1702
+ * @example {
1703
+ * "meetings": [
1704
+ * {
1705
+ * "id": "6a6840c6cc9ea3097a801627",
1706
+ * "summary": "Standup",
1707
+ * "eventId": "gobiji6ddnsgaausdrhftf2cb2_20260728T223000Z",
1708
+ * "isRecurrent": true,
1709
+ * "organizer": {
1710
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1711
+ * "name": "Grace Hopper",
1712
+ * "userName": "grace",
1713
+ * "email": "grace@example.com",
1714
+ * "platformDetails": {
1715
+ * "name": "slack",
1716
+ * "imChannel": "D3EEXS3J6",
1717
+ * "selfChannel": "D1HN843U3",
1718
+ * "userId": "U0HBQESA1",
1719
+ * "teamId": "T0HBUA0TC"
1720
+ * },
1721
+ * "confirmed": true,
1722
+ * "avatar": "https://cdn.workast.io/avatar.png",
1723
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1724
+ * },
1725
+ * "totalAttendees": 2,
1726
+ * "someAttendees": [
1727
+ * {
1728
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1729
+ * "name": "Grace Hopper",
1730
+ * "userName": "grace",
1731
+ * "email": "grace@example.com",
1732
+ * "platformDetails": {
1733
+ * "name": "slack",
1734
+ * "imChannel": "D3EEXS3J6",
1735
+ * "selfChannel": "D1HN843U3",
1736
+ * "userId": "U0HBQESA1",
1737
+ * "teamId": "T0HBUA0TC"
1738
+ * },
1739
+ * "confirmed": true,
1740
+ * "avatar": "https://cdn.workast.io/avatar.png",
1741
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1742
+ * },
1743
+ * {
1744
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
1745
+ * "name": "Katherine Johnson",
1746
+ * "userName": "katherine",
1747
+ * "email": "katherine@example.com",
1748
+ * "platformDetails": {
1749
+ * "name": "slack",
1750
+ * "imChannel": "D06JN8RT8KB",
1751
+ * "selfChannel": "D06HV290V6K",
1752
+ * "userId": "U06J9JSF6R0",
1753
+ * "teamId": "T0HBUA0TC"
1754
+ * },
1755
+ * "confirmed": false,
1756
+ * "avatar": "https://cdn.workast.io/avatar.png",
1757
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1758
+ * }
1759
+ * ],
1760
+ * "link": "https://app.workast.com/meeting/6a6840c6cc9ea3097a801627",
1761
+ * "start": "2026-07-31T00:30:00.000Z",
1762
+ * "end": "2026-07-31T02:00:00.000Z",
1763
+ * "allDay": false,
1764
+ * "totalTasks": 0,
1765
+ * "completedTasks": 0
1766
+ * }
1767
+ * ],
1768
+ * "nextPageToken": "eyJzdGFydCI6IjIwMjYtMDctMzFUMDA6MzA6MDAuMDAwWiIsImlkIjoiNmE2ODQwYzZjYzllYTMwOTdhODAxNjI3In0"
1769
+ * }
1770
+ */
1567
1771
  Meetings: {
1568
1772
  /** @description Meetings matching the filters, sorted by start then id. */
1569
1773
  meetings: components["schemas"]["MeetingMinimalResource"][];
@@ -1622,7 +1826,51 @@ interface components {
1622
1826
  * @example 2020-04-19T08:30:00-03:00
1623
1827
  */
1624
1828
  CalendarEventDate: string;
1625
- /** @description Meeting.buildResource. */
1829
+ /**
1830
+ * @description Meeting.buildResource.
1831
+ * @example {
1832
+ * "id": "6a844c4c6bc4270979c79d34",
1833
+ * "createdAt": "2026-08-18T12:13:00.327Z",
1834
+ * "updatedAt": "2026-08-18T12:13:00.327Z",
1835
+ * "summary": "Standup",
1836
+ * "status": "active",
1837
+ * "eventId": "2bi7qgtg2k615gsm4fom4oa2l8",
1838
+ * "isRecurrent": false,
1839
+ * "organizer": {
1840
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1841
+ * "name": "Grace Hopper",
1842
+ * "userName": "grace",
1843
+ * "email": "grace@example.com",
1844
+ * "platformDetails": {
1845
+ * "name": "slack",
1846
+ * "imChannel": "D3EEXS3J6",
1847
+ * "selfChannel": "D1HN843U3",
1848
+ * "userId": "U0HBQESA1",
1849
+ * "teamId": "T0HBUA0TC"
1850
+ * },
1851
+ * "confirmed": true,
1852
+ * "avatar": "https://cdn.workast.io/avatar.png",
1853
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
1854
+ * },
1855
+ * "totalAttendees": 1,
1856
+ * "someAttendees": [],
1857
+ * "list": {
1858
+ * "id": "5a6ebde81519395731f90e2f",
1859
+ * "name": "Engineering",
1860
+ * "type": "group",
1861
+ * "status": "active",
1862
+ * "privacy": "private",
1863
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f"
1864
+ * },
1865
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/meeting/6a844c4c6bc4270979c79d34",
1866
+ * "notetaker": {
1867
+ * "enabled": false
1868
+ * },
1869
+ * "start": "2026-09-01T15:00:00.000Z",
1870
+ * "end": "2026-09-01T15:30:00.000Z",
1871
+ * "allDay": false
1872
+ * }
1873
+ */
1626
1874
  Meeting: {
1627
1875
  /**
1628
1876
  * @description The meeting ID.
@@ -1726,7 +1974,74 @@ interface components {
1726
1974
  /** @description User ID that requested the notetaker. Omitted when nil. */
1727
1975
  requestedBy?: string;
1728
1976
  };
1729
- /** @description GET /meeting/{meetingId} body. Meeting.buildResource plus optional legacy note. */
1977
+ /**
1978
+ * @description GET /meeting/{meetingId} body. Meeting.buildResource plus optional legacy note.
1979
+ * @example {
1980
+ * "id": "6a6840c6cc9ea3097a801627",
1981
+ * "createdAt": "2026-07-28T05:40:22.966Z",
1982
+ * "updatedAt": "2026-08-11T01:56:10.130Z",
1983
+ * "summary": "Standup",
1984
+ * "status": "active",
1985
+ * "eventId": "gobiji6ddnsgaausdrhftf2cb2_20260728T223000Z",
1986
+ * "isRecurrent": true,
1987
+ * "organizer": {
1988
+ * "id": "4214932441cb21eebdb396bfe34a8340",
1989
+ * "name": "Grace Hopper",
1990
+ * "userName": "grace",
1991
+ * "email": "grace@example.com",
1992
+ * "platformDetails": {
1993
+ * "name": "slack",
1994
+ * "imChannel": "D3EEXS3J6",
1995
+ * "selfChannel": "D1HN843U3",
1996
+ * "userId": "U0HBQESA1",
1997
+ * "teamId": "T0HBUA0TC"
1998
+ * },
1999
+ * "confirmed": true,
2000
+ * "avatar": "https://cdn.workast.io/avatar.png",
2001
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2002
+ * },
2003
+ * "totalAttendees": 2,
2004
+ * "someAttendees": [
2005
+ * {
2006
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2007
+ * "name": "Grace Hopper",
2008
+ * "userName": "grace",
2009
+ * "email": "grace@example.com",
2010
+ * "platformDetails": {
2011
+ * "name": "slack",
2012
+ * "imChannel": "D3EEXS3J6",
2013
+ * "selfChannel": "D1HN843U3",
2014
+ * "userId": "U0HBQESA1",
2015
+ * "teamId": "T0HBUA0TC"
2016
+ * },
2017
+ * "confirmed": true,
2018
+ * "avatar": "https://cdn.workast.io/avatar.png",
2019
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2020
+ * }
2021
+ * ],
2022
+ * "list": {
2023
+ * "id": "5fc58f3d15ff9110b64ca426",
2024
+ * "type": "group",
2025
+ * "status": "active",
2026
+ * "privacy": "team",
2027
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
2028
+ * "name": "Product"
2029
+ * },
2030
+ * "link": "https://app.workast.com/meeting/6a6840c6cc9ea3097a801627",
2031
+ * "conferenceData": {
2032
+ * "joinUrl": "https://example.com/file",
2033
+ * "provider": "Google Meet"
2034
+ * },
2035
+ * "notetaker": {
2036
+ * "enabled": false
2037
+ * },
2038
+ * "start": "2026-07-31T00:30:00.000Z",
2039
+ * "end": "2026-07-31T02:00:00.000Z",
2040
+ * "allDay": false,
2041
+ * "totalTasks": 0,
2042
+ * "completedTasks": 0
2043
+ * }
2044
+ */
1730
2045
  MeetingDetail: components["schemas"]["Meeting"] & {
1731
2046
  note?: components["schemas"]["MeetingNote"];
1732
2047
  };
@@ -1827,7 +2142,11 @@ interface components {
1827
2142
  * @example https://cdn.workast.io/avatar.png
1828
2143
  */
1829
2144
  avatar: string;
1830
- costCenter: components["schemas"]["CostCenterMinimalResource"];
2145
+ /**
2146
+ * @description The cost center ID. Public user embeds do not populate the cost center.
2147
+ * @example 5c1b92b0a57d2b342c1a610e
2148
+ */
2149
+ costCenter: string;
1831
2150
  };
1832
2151
  /** @description Name-only user embed on a reaction (populate select -_id name). */
1833
2152
  ReactionUser: {
@@ -1837,7 +2156,19 @@ interface components {
1837
2156
  */
1838
2157
  name?: string;
1839
2158
  };
1840
- /** @description reactionSchema.buildResource */
2159
+ /**
2160
+ * @description reactionSchema.buildResource
2161
+ * @example {
2162
+ * "id": "6a844d5e6bc4270979c7a8ee",
2163
+ * "emoji": ":+1:",
2164
+ * "total": 1,
2165
+ * "users": [
2166
+ * {
2167
+ * "name": "Grace Hopper"
2168
+ * }
2169
+ * ]
2170
+ * }
2171
+ */
1841
2172
  ReactionReadOnly: {
1842
2173
  /**
1843
2174
  * @description The reaction ID
@@ -1970,19 +2301,61 @@ interface components {
1970
2301
  * @example false
1971
2302
  */
1972
2303
  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
- };
2304
+ /**
2305
+ * @description Storage limit in bytes (per user).
2306
+ * @example 5368709120
2307
+ */
2308
+ storageLimit: number;
2309
+ /**
2310
+ * @description Whether the creation of milestones is allowed or not.
2311
+ * @example false
2312
+ */
2313
+ createMilestones?: boolean;
2314
+ /**
2315
+ * @description Whether meetings are available or not.
2316
+ * @example false
2317
+ */
2318
+ accessMeetings?: boolean;
2319
+ /**
2320
+ * @description Whether calendar sync is allowed or not.
2321
+ * @example false
2322
+ */
2323
+ calendarSync?: boolean;
2324
+ /**
2325
+ * @description Whether downloading search results is allowed or not.
2326
+ * @example false
2327
+ */
2328
+ downloadSearch?: boolean;
2329
+ /**
2330
+ * @description Whether the creation of spaces is allowed or not.
2331
+ * @example false
2332
+ */
2333
+ createSpaces?: boolean;
2334
+ /**
2335
+ * @description Whether app login is allowed or not.
2336
+ * @example false
2337
+ */
2338
+ appLogin?: boolean;
2339
+ /**
2340
+ * @description Whether the creation of custom fields is allowed or not.
2341
+ * @example false
2342
+ */
2343
+ createFields?: boolean;
2344
+ /**
2345
+ * @description Whether the timeline view is available or not.
2346
+ * @example false
2347
+ */
2348
+ timelineView?: boolean;
2349
+ /**
2350
+ * @description Whether AI workflows are available or not.
2351
+ * @example false
2352
+ */
2353
+ aiWorkflows?: boolean;
2354
+ /**
2355
+ * @description Notetaker minutes included per month.
2356
+ * @example 600
2357
+ */
2358
+ notetakerMinutesPerMonth?: number;
1986
2359
  /**
1987
2360
  * @description Tasks visibility window in days. No limit if not present.
1988
2361
  * @example 30
@@ -2016,28 +2389,11 @@ interface components {
2016
2389
  * @example 9.99
2017
2390
  */
2018
2391
  salePrice?: number;
2019
- };
2020
- CostCenterMinimalResource: {
2021
2392
  /**
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
- /**
2037
- * @description Whether the cost center is the organization's default or not
2393
+ * @description Whether this plan is billed as a flat fee.
2038
2394
  * @example false
2039
2395
  */
2040
- isDefault?: boolean;
2396
+ flatFee?: boolean;
2041
2397
  };
2042
2398
  CostCenterResource: {
2043
2399
  /**
@@ -2065,7 +2421,11 @@ interface components {
2065
2421
  * @example free
2066
2422
  */
2067
2423
  account?: string;
2068
- createdBy?: components["schemas"]["User"];
2424
+ /**
2425
+ * @description The user ID that created the cost center. Public GET /user/me does not populate this user.
2426
+ * @example c51a9c1a2ddfbcefa7abf74036e0c616
2427
+ */
2428
+ createdBy?: string;
2069
2429
  product?: components["schemas"]["ProductRead"] & {
2070
2430
  /**
2071
2431
  * @description Whether this is a trial or not.
@@ -2190,6 +2550,56 @@ interface components {
2190
2550
  */
2191
2551
  author?: string;
2192
2552
  };
2553
+ /**
2554
+ * @example {
2555
+ * "id": "6a844d3965f82309911408ca",
2556
+ * "title": {
2557
+ * "text": "Ship v3"
2558
+ * },
2559
+ * "createdAt": "2026-08-18T12:16:57.347Z",
2560
+ * "updatedAt": "2026-08-18T12:16:57.347Z",
2561
+ * "user": {
2562
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2563
+ * "name": "Grace Hopper",
2564
+ * "userName": "grace",
2565
+ * "avatar": "https://cdn.workast.io/avatar.png",
2566
+ * "platformDetails": {
2567
+ * "name": "slack",
2568
+ * "imChannel": "D3EEXS3J6",
2569
+ * "selfChannel": "D1HN843U3",
2570
+ * "userId": "U0HBQESA1",
2571
+ * "teamId": "T0HBUA0TC"
2572
+ * }
2573
+ * },
2574
+ * "app": {
2575
+ * "id": "5d9a6b09269e415d36380d23",
2576
+ * "name": "Example App",
2577
+ * "description": "Ship v3",
2578
+ * "icon": "https://cdn.workast.io/avatar.png",
2579
+ * "createdAt": "2019-10-06T22:30:33.687Z",
2580
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
2581
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
2582
+ * "accessType": "user",
2583
+ * "developedByWorkast": true
2584
+ * },
2585
+ * "author": {
2586
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2587
+ * "name": "Grace Hopper",
2588
+ * "userName": "grace",
2589
+ * "email": "grace@example.com",
2590
+ * "platformDetails": {
2591
+ * "name": "slack",
2592
+ * "imChannel": "D3EEXS3J6",
2593
+ * "selfChannel": "D1HN843U3",
2594
+ * "userId": "U0HBQESA1",
2595
+ * "teamId": "T0HBUA0TC"
2596
+ * },
2597
+ * "confirmed": true,
2598
+ * "avatar": "https://cdn.workast.io/avatar.png",
2599
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2600
+ * }
2601
+ * }
2602
+ */
2193
2603
  Attachment: {
2194
2604
  /**
2195
2605
  * @description The unique attachment id
@@ -2211,7 +2621,40 @@ interface components {
2211
2621
  /** @description The attachment link. Present when the attachment has a file. */
2212
2622
  link?: string;
2213
2623
  };
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. */
2624
+ /**
2625
+ * @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.
2626
+ * @example {
2627
+ * "id": "6a844fd765f8230991142151",
2628
+ * "createdAt": "2026-08-18T12:28:07.685Z",
2629
+ * "updatedAt": "2026-08-18T12:28:09.193Z",
2630
+ * "user": {
2631
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2632
+ * "virtualId": "c2xhY2svL1QwSEJVQTBUQzpVMEhCUUVTQTE=",
2633
+ * "name": "Grace Hopper",
2634
+ * "userName": "grace",
2635
+ * "avatar": "https://cdn.workast.io/avatar.png",
2636
+ * "platformDetails": {
2637
+ * "name": "slack",
2638
+ * "imChannel": "D3EEXS3J6",
2639
+ * "selfChannel": "D1HN843U3",
2640
+ * "userId": "U0HBQESA1",
2641
+ * "teamId": "T0HBUA0TC"
2642
+ * }
2643
+ * },
2644
+ * "file": {
2645
+ * "name": "avatar.png",
2646
+ * "type": "image/png",
2647
+ * "size": 17101,
2648
+ * "url": "/files/5dc40cff038a590f79c403c0/b9ca2e09-12e8-4c34-99dd-10dfaf345660",
2649
+ * "thumbnails": {
2650
+ * "250": "https://example.com/file",
2651
+ * "500": "https://example.com/file"
2652
+ * }
2653
+ * },
2654
+ * "link": "https://example.com/file",
2655
+ * "fileUrl": "https://example.com/file"
2656
+ * }
2657
+ */
2215
2658
  AttachmentFileUrl: components["schemas"]["Attachment"] & {
2216
2659
  /**
2217
2660
  * Format: uri
@@ -2245,7 +2688,31 @@ interface components {
2245
2688
  /** @description Lists to exclude from my-tasks search. Only lists the user participates in. */
2246
2689
  excludedLists?: components["schemas"]["ListHeader"][];
2247
2690
  };
2248
- /** @description Team user. Built by buildResource. */
2691
+ /**
2692
+ * @description Team user. Built by buildResource.
2693
+ * @example {
2694
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2695
+ * "createdAt": "2017-04-14T02:14:44.247Z",
2696
+ * "name": "Grace Hopper",
2697
+ * "userName": "grace",
2698
+ * "platformDetails": {
2699
+ * "name": "slack",
2700
+ * "imChannel": "D3EEXS3J6",
2701
+ * "selfChannel": "D1HN843U3",
2702
+ * "userId": "U0HBQESA1",
2703
+ * "teamId": "T0HBUA0TC"
2704
+ * },
2705
+ * "timezone": "Australia/Canberra",
2706
+ * "email": "grace@example.com",
2707
+ * "lastActive": "2026-08-18T11:29:00.207Z",
2708
+ * "role": "admin",
2709
+ * "status": "active",
2710
+ * "confirmed": true,
2711
+ * "profile": {},
2712
+ * "avatar": "https://cdn.workast.io/avatar.png",
2713
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
2714
+ * }
2715
+ */
2249
2716
  UserDetail: {
2250
2717
  /**
2251
2718
  * @description The user ID
@@ -2308,9 +2775,169 @@ interface components {
2308
2775
  * @example https://avatars.slack-edge.com/2019-01-29/535865276113_da329b7dcbb39ea8e564_1024.png
2309
2776
  */
2310
2777
  avatar?: string;
2311
- costCenter?: components["schemas"]["CostCenterMinimalResource"];
2778
+ /**
2779
+ * @description The cost center ID. Public user embeds do not populate the cost center.
2780
+ * @example 5c1b92b0a57d2b342c1a610e
2781
+ */
2782
+ costCenter?: string;
2312
2783
  };
2313
- /** @description Logged-in user. Built by buildUserResource. */
2784
+ /** @description GET /user/email/{email} body. UserDetail plus optional team. */
2785
+ UserDetailWithTeam: components["schemas"]["UserDetail"] & {
2786
+ team?: components["schemas"]["Team"];
2787
+ };
2788
+ /**
2789
+ * @description Logged-in user. Built by buildUserResource.
2790
+ * @example {
2791
+ * "id": "4214932441cb21eebdb396bfe34a8340",
2792
+ * "name": "Grace Hopper",
2793
+ * "email": "grace@example.com",
2794
+ * "userName": "grace",
2795
+ * "platformDetails": {
2796
+ * "name": "slack",
2797
+ * "imChannel": "D3EEXS3J6",
2798
+ * "selfChannel": "D1HN843U3",
2799
+ * "userId": "U0HBQESA1",
2800
+ * "teamId": "T0HBUA0TC"
2801
+ * },
2802
+ * "role": "admin",
2803
+ * "confirmed": true,
2804
+ * "avatar": "https://cdn.workast.io/avatar.png",
2805
+ * "personalListId": "5937861aa2470108bbf72e1d",
2806
+ * "team": {
2807
+ * "id": "ca19601b6bb816ca95386698b3385d49",
2808
+ * "name": "Example Team",
2809
+ * "url": "https://app.workast.com",
2810
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49",
2811
+ * "domain": "example",
2812
+ * "totalTasks": 54822,
2813
+ * "status": "active",
2814
+ * "createdAt": "2018-05-22T14:04:01.652Z",
2815
+ * "betaTester": true,
2816
+ * "platformDetails": {
2817
+ * "name": "slack",
2818
+ * "teamId": "T0HBUA0TC",
2819
+ * "url": "https://example.slack.com/",
2820
+ * "emailDomain": "example.com",
2821
+ * "teamSize": 76
2822
+ * },
2823
+ * "icon": "https://cdn.workast.io/list-avatar.png",
2824
+ * "activeUsers": 7
2825
+ * },
2826
+ * "organization": {
2827
+ * "id": "5c1b92b0a57d2b342c1a610d",
2828
+ * "name": "Example Organization",
2829
+ * "defaultCostCenter": "5c1b92b0a57d2b342c1a610e"
2830
+ * },
2831
+ * "costCenter": {
2832
+ * "id": "5c1b92b0a57d2b342c1a610e",
2833
+ * "createdAt": "2018-12-20T13:01:36.566Z",
2834
+ * "updatedAt": "2019-01-10T14:56:47.968Z",
2835
+ * "name": "Default",
2836
+ * "account": "premium",
2837
+ * "createdBy": "c51a9c1a2ddfbcefa7abf74036e0c616",
2838
+ * "product": {
2839
+ * "id": "5ddfe4b458ddf740a5393ae9",
2840
+ * "createdAt": "2019-11-28T15:16:04.653Z",
2841
+ * "updatedAt": "2020-07-30T14:55:46.510Z",
2842
+ * "name": "Professional",
2843
+ * "default": false,
2844
+ * "isPaid": true,
2845
+ * "features": {
2846
+ * "createSubtasks": true,
2847
+ * "createPrivateSpaces": true,
2848
+ * "createLists": true,
2849
+ * "createTags": true,
2850
+ * "importTemplates": true,
2851
+ * "createTemplates": true,
2852
+ * "createSearches": true,
2853
+ * "createTaskStatus": true,
2854
+ * "createGuestAccounts": true,
2855
+ * "createTaskDependencies": true,
2856
+ * "storageLimit": 5368709120,
2857
+ * "createMilestones": true,
2858
+ * "accessMeetings": true,
2859
+ * "calendarSync": true,
2860
+ * "downloadSearch": true,
2861
+ * "createSpaces": true,
2862
+ * "appLogin": true,
2863
+ * "createFields": true,
2864
+ * "timelineView": true,
2865
+ * "aiWorkflows": true,
2866
+ * "notetakerMinutesPerMonth": 600
2867
+ * },
2868
+ * "trialling": false,
2869
+ * "currentPlan": {
2870
+ * "id": "5ddfe4b458ddf740a5393aea",
2871
+ * "term": "annual",
2872
+ * "price": 9.95,
2873
+ * "flatFee": false
2874
+ * }
2875
+ * },
2876
+ * "storage": {
2877
+ * "used": 2315908683,
2878
+ * "total": 37580963840,
2879
+ * "usedPercentage": 6.16,
2880
+ * "freePercentage": 93.84
2881
+ * },
2882
+ * "isDefault": true,
2883
+ * "activeUsers": 7
2884
+ * },
2885
+ * "calendars": [],
2886
+ * "timezone": "Australia/Canberra",
2887
+ * "reminders": {
2888
+ * "channels": {
2889
+ * "slack": true,
2890
+ * "email": false
2891
+ * },
2892
+ * "days": [
2893
+ * 1,
2894
+ * 2,
2895
+ * 3,
2896
+ * 4,
2897
+ * 5
2898
+ * ],
2899
+ * "hour": 9,
2900
+ * "hourUTC": 23,
2901
+ * "taskAssignedToOthers": false,
2902
+ * "taskDueInTheFutureDays": 0
2903
+ * },
2904
+ * "notifications": {
2905
+ * "assignedToTasks": true,
2906
+ * "completedTasks": true,
2907
+ * "appAnnouncements": true,
2908
+ * "taskReminderMinutes": 30
2909
+ * },
2910
+ * "dateSettings": {
2911
+ * "startOfWeek": "monday",
2912
+ * "timeFormat": "HH",
2913
+ * "dateFormat": "M/D/Y"
2914
+ * },
2915
+ * "myTasksSearchSettings": {
2916
+ * "excludeAssignToOthers": true,
2917
+ * "excludedLists": [
2918
+ * {
2919
+ * "id": "5937861aa2470108bbf72e1d",
2920
+ * "name": "Personal tasks",
2921
+ * "type": "personal",
2922
+ * "privacy": "private"
2923
+ * },
2924
+ * {
2925
+ * "id": "59daaf15c7d6260e7f470356",
2926
+ * "name": "Product",
2927
+ * "type": "group",
2928
+ * "privacy": "team"
2929
+ * }
2930
+ * ]
2931
+ * },
2932
+ * "profile": {},
2933
+ * "storage": {
2934
+ * "used": 627473089,
2935
+ * "total": 5368709120,
2936
+ * "usedPercentage": 11.69,
2937
+ * "freePercentage": 88.31
2938
+ * }
2939
+ * }
2940
+ */
2314
2941
  UserResource: {
2315
2942
  /**
2316
2943
  * @description The user ID
@@ -2413,6 +3040,15 @@ interface components {
2413
3040
  myTasksSearchSettings?: components["schemas"]["MyTasksSearchSettings"];
2414
3041
  storage?: components["schemas"]["Storage"];
2415
3042
  };
3043
+ /**
3044
+ * @example {
3045
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3046
+ * "virtualId": "c2xhY2svL1QwSEJVQTBUQzpVMEhCUUVTQTE=",
3047
+ * "name": "Grace Hopper",
3048
+ * "userName": "grace",
3049
+ * "avatar": "https://cdn.workast.io/avatar.png"
3050
+ * }
3051
+ */
2416
3052
  User: {
2417
3053
  /** @description The user unique ID */
2418
3054
  id: string;
@@ -2426,6 +3062,27 @@ interface components {
2426
3062
  avatar?: string;
2427
3063
  platformDetails?: components["schemas"]["UserPlatformDetails"];
2428
3064
  };
3065
+ /**
3066
+ * @example {
3067
+ * "id": "ca19601b6bb816ca95386698b3385d49",
3068
+ * "name": "Example Team",
3069
+ * "url": "https://app.workast.com",
3070
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49",
3071
+ * "domain": "example",
3072
+ * "totalTasks": 54822,
3073
+ * "status": "active",
3074
+ * "createdAt": "2018-05-22T14:04:01.652Z",
3075
+ * "betaTester": true,
3076
+ * "platformDetails": {
3077
+ * "name": "slack",
3078
+ * "teamId": "T0HBUA0TC",
3079
+ * "url": "https://example.slack.com/",
3080
+ * "emailDomain": "example.com",
3081
+ * "teamSize": 76
3082
+ * },
3083
+ * "icon": "https://cdn.workast.io/list-avatar.png"
3084
+ * }
3085
+ */
2429
3086
  Team: {
2430
3087
  /**
2431
3088
  * @description The team unique ID.
@@ -2599,6 +3256,329 @@ interface components {
2599
3256
  */
2600
3257
  width?: number;
2601
3258
  };
3259
+ /**
3260
+ * @example {
3261
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3262
+ * "createdAt": "2022-01-10T12:12:46.308Z",
3263
+ * "createdBy": {
3264
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3265
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3266
+ * "name": "Ada Lovelace",
3267
+ * "userName": "ada",
3268
+ * "platformDetails": {
3269
+ * "name": "slack",
3270
+ * "imChannel": "D3F5RQA6B",
3271
+ * "selfChannel": "D1LGYBCFQ",
3272
+ * "userId": "U0JU26WRG",
3273
+ * "teamId": "T0HBUA0TC"
3274
+ * },
3275
+ * "timezone": "Australia/Canberra",
3276
+ * "email": "ada@example.com",
3277
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3278
+ * "role": "admin",
3279
+ * "status": "active",
3280
+ * "confirmed": true,
3281
+ * "profile": {},
3282
+ * "avatar": "https://cdn.workast.io/avatar.png",
3283
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3284
+ * },
3285
+ * "shortId": "T4GNY",
3286
+ * "text": "Ship v3",
3287
+ * "assignedTo": [
3288
+ * {
3289
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3290
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3291
+ * "name": "Ada Lovelace",
3292
+ * "userName": "ada",
3293
+ * "platformDetails": {
3294
+ * "name": "slack",
3295
+ * "imChannel": "D3F5RQA6B",
3296
+ * "selfChannel": "D1LGYBCFQ",
3297
+ * "userId": "U0JU26WRG",
3298
+ * "teamId": "T0HBUA0TC"
3299
+ * },
3300
+ * "timezone": "Australia/Canberra",
3301
+ * "email": "ada@example.com",
3302
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3303
+ * "role": "admin",
3304
+ * "status": "active",
3305
+ * "confirmed": true,
3306
+ * "profile": {},
3307
+ * "avatar": "https://cdn.workast.io/avatar.png",
3308
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3309
+ * }
3310
+ * ],
3311
+ * "subscribers": [
3312
+ * {
3313
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3314
+ * "createdAt": "2016-12-28T22:19:45.715Z",
3315
+ * "name": "Ada Lovelace",
3316
+ * "userName": "ada",
3317
+ * "platformDetails": {
3318
+ * "name": "slack",
3319
+ * "imChannel": "D3F5RQA6B",
3320
+ * "selfChannel": "D1LGYBCFQ",
3321
+ * "userId": "U0JU26WRG",
3322
+ * "teamId": "T0HBUA0TC"
3323
+ * },
3324
+ * "timezone": "Australia/Canberra",
3325
+ * "email": "ada@example.com",
3326
+ * "lastActive": "2025-07-10T01:22:15.814Z",
3327
+ * "role": "admin",
3328
+ * "status": "active",
3329
+ * "confirmed": true,
3330
+ * "profile": {},
3331
+ * "avatar": "https://cdn.workast.io/avatar.png",
3332
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3333
+ * },
3334
+ * {
3335
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3336
+ * "createdAt": "2017-04-14T02:14:44.247Z",
3337
+ * "name": "Grace Hopper",
3338
+ * "userName": "grace",
3339
+ * "platformDetails": {
3340
+ * "name": "slack",
3341
+ * "imChannel": "D3EEXS3J6",
3342
+ * "selfChannel": "D1HN843U3",
3343
+ * "userId": "U0HBQESA1",
3344
+ * "teamId": "T0HBUA0TC"
3345
+ * },
3346
+ * "timezone": "Australia/Canberra",
3347
+ * "email": "grace@example.com",
3348
+ * "lastActive": "2026-08-18T11:29:00.207Z",
3349
+ * "role": "admin",
3350
+ * "status": "active",
3351
+ * "confirmed": true,
3352
+ * "profile": {},
3353
+ * "avatar": "https://cdn.workast.io/avatar.png",
3354
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3355
+ * }
3356
+ * ],
3357
+ * "status": "pending",
3358
+ * "allDay": false,
3359
+ * "priority": 0,
3360
+ * "description": "Ship v3",
3361
+ * "listId": "603449f6f107b67c63e8cee9",
3362
+ * "list": {
3363
+ * "id": "603449f6f107b67c63e8cee9",
3364
+ * "hash": "fabc9069cda279d762400d53e2854266",
3365
+ * "name": "Product",
3366
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
3367
+ * "numberOfParticipants": 2,
3368
+ * "type": "group",
3369
+ * "privacy": "private",
3370
+ * "isArchived": false,
3371
+ * "platformDetails": {
3372
+ * "name": "slack",
3373
+ * "channelId": "G01NLRJ053L",
3374
+ * "channelName": "engineering",
3375
+ * "type": "group",
3376
+ * "teamId": "T0HBUA0TC"
3377
+ * },
3378
+ * "platformNotifications": {
3379
+ * "taskCreated": true,
3380
+ * "taskCompleted": true
3381
+ * },
3382
+ * "subLists": [
3383
+ * {
3384
+ * "id": "603449f6f107b67c63e8cee8",
3385
+ * "name": "To-do",
3386
+ * "listPosition": 100000,
3387
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3388
+ * },
3389
+ * {
3390
+ * "id": "610ffd8c7374d6331a4178d8",
3391
+ * "name": "In Progress",
3392
+ * "listPosition": 700000,
3393
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3394
+ * }
3395
+ * ],
3396
+ * "defaultSubList": "603449f6f107b67c63e8cee8",
3397
+ * "isParticipant": true,
3398
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9"
3399
+ * },
3400
+ * "listPosition": 99999,
3401
+ * "subList": {
3402
+ * "id": "610ffd8c7374d6331a4178d8",
3403
+ * "name": "To-do",
3404
+ * "listPosition": 700000,
3405
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3406
+ * },
3407
+ * "subListId": "610ffd8c7374d6331a4178d8",
3408
+ * "subTasks": [
3409
+ * {
3410
+ * "status": "pending",
3411
+ * "text": "Ship v3",
3412
+ * "shortId": "T4QMF",
3413
+ * "createdAt": "2022-01-10T12:15:13.627Z",
3414
+ * "updatedAt": "2022-01-10T12:19:50.379Z",
3415
+ * "listPosition": 100000,
3416
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/7cec8c8604790b391221049f28d5ba40",
3417
+ * "calendars": [
3418
+ * "b2956627fe26a2c1e4b6d5202413f779"
3419
+ * ],
3420
+ * "id": "7cec8c8604790b391221049f28d5ba40",
3421
+ * "list": {
3422
+ * "id": "603449f6f107b67c63e8cee9",
3423
+ * "name": "Product",
3424
+ * "type": "group",
3425
+ * "privacy": "private",
3426
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
3427
+ * "subLists": [
3428
+ * {
3429
+ * "id": "603449f6f107b67c63e8cee8",
3430
+ * "name": "To-do",
3431
+ * "listPosition": 100000,
3432
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3433
+ * },
3434
+ * {
3435
+ * "id": "610ffd8c7374d6331a4178d8",
3436
+ * "name": "In Progress",
3437
+ * "listPosition": 700000,
3438
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3439
+ * }
3440
+ * ]
3441
+ * },
3442
+ * "listId": "603449f6f107b67c63e8cee9",
3443
+ * "parent": {
3444
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3445
+ * "text": "Ship v3",
3446
+ * "shortId": "T4GNY",
3447
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69"
3448
+ * },
3449
+ * "assignedTo": [],
3450
+ * "subscribers": [
3451
+ * {
3452
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3453
+ * "name": "Ada Lovelace",
3454
+ * "userName": "ada",
3455
+ * "email": "ada@example.com",
3456
+ * "platformDetails": {
3457
+ * "name": "slack",
3458
+ * "imChannel": "D3F5RQA6B",
3459
+ * "selfChannel": "D1LGYBCFQ",
3460
+ * "userId": "U0JU26WRG",
3461
+ * "teamId": "T0HBUA0TC"
3462
+ * },
3463
+ * "confirmed": true,
3464
+ * "avatar": "https://cdn.workast.io/avatar.png",
3465
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3466
+ * }
3467
+ * ],
3468
+ * "allDay": false,
3469
+ * "createdBy": {
3470
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3471
+ * "name": "Ada Lovelace",
3472
+ * "userName": "ada",
3473
+ * "email": "ada@example.com",
3474
+ * "platformDetails": {
3475
+ * "name": "slack",
3476
+ * "imChannel": "D3F5RQA6B",
3477
+ * "selfChannel": "D1LGYBCFQ",
3478
+ * "userId": "U0JU26WRG",
3479
+ * "teamId": "T0HBUA0TC"
3480
+ * },
3481
+ * "confirmed": true,
3482
+ * "avatar": "https://cdn.workast.io/avatar.png",
3483
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3484
+ * },
3485
+ * "hasDescription": true,
3486
+ * "numberOfComments": 0,
3487
+ * "numberOfAttachments": 0,
3488
+ * "subTasks": [],
3489
+ * "isSubscribed": false,
3490
+ * "taskStatus": {
3491
+ * "id": "5c7184fa40721e2ed4175a6e",
3492
+ * "label": "Open",
3493
+ * "color": "#808080",
3494
+ * "createdAt": "2019-02-23T17:38:02.928Z",
3495
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
3496
+ * },
3497
+ * "inHome": false,
3498
+ * "fields": []
3499
+ * }
3500
+ * ],
3501
+ * "attachments": [],
3502
+ * "totalSubTasks": 1,
3503
+ * "completedSubTasks": 0,
3504
+ * "numberOfComments": 1,
3505
+ * "lastComment": {
3506
+ * "id": "686f7912fc2fef09733c6f58",
3507
+ * "type": "comment",
3508
+ * "value": "Ship v3",
3509
+ * "status": "active",
3510
+ * "createdAt": "2025-07-10T08:25:54.274Z",
3511
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
3512
+ * "mentions": [
3513
+ * {
3514
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3515
+ * "name": "Ada Lovelace",
3516
+ * "userName": "ada",
3517
+ * "email": "ada@example.com",
3518
+ * "platformDetails": {
3519
+ * "name": "slack",
3520
+ * "imChannel": "D3F5RQA6B",
3521
+ * "selfChannel": "D1LGYBCFQ",
3522
+ * "userId": "U0JU26WRG",
3523
+ * "teamId": "T0HBUA0TC"
3524
+ * },
3525
+ * "confirmed": true,
3526
+ * "avatar": "https://cdn.workast.io/avatar.png",
3527
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3528
+ * }
3529
+ * ],
3530
+ * "reactions": [],
3531
+ * "actor": {
3532
+ * "type": "User",
3533
+ * "data": {
3534
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3535
+ * "name": "Grace Hopper",
3536
+ * "userName": "grace",
3537
+ * "email": "grace@example.com",
3538
+ * "platformDetails": {
3539
+ * "name": "slack",
3540
+ * "imChannel": "D3EEXS3J6",
3541
+ * "selfChannel": "D1HN843U3",
3542
+ * "userId": "U0HBQESA1",
3543
+ * "teamId": "T0HBUA0TC"
3544
+ * },
3545
+ * "confirmed": true,
3546
+ * "avatar": "https://cdn.workast.io/avatar.png",
3547
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3548
+ * }
3549
+ * }
3550
+ * },
3551
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
3552
+ * "dependencies": [],
3553
+ * "milestones": [],
3554
+ * "inHome": false,
3555
+ * "fields": [
3556
+ * {
3557
+ * "id": "620120d5106d941d2ac206c7",
3558
+ * "name": "Priority",
3559
+ * "description": "Ship v3",
3560
+ * "type": "options",
3561
+ * "useAsTaskColor": false,
3562
+ * "options": [
3563
+ * {
3564
+ * "id": "620120d5106d941d2ac206c8",
3565
+ * "name": "Yes",
3566
+ * "color": "#2ef00d"
3567
+ * },
3568
+ * {
3569
+ * "id": "620120d5106d941d2ac206c9",
3570
+ * "name": "No",
3571
+ * "color": "#ee0551"
3572
+ * }
3573
+ * ],
3574
+ * "value": ""
3575
+ * }
3576
+ * ],
3577
+ * "calendars": [
3578
+ * "b2956627fe26a2c1e4b6d5202413f779"
3579
+ * ]
3580
+ * }
3581
+ */
2602
3582
  Task: components["schemas"]["TaskCommon"] & {
2603
3583
  createdBy?: components["schemas"]["UserDetail"];
2604
3584
  assignedTo?: components["schemas"]["UserDetail"][];
@@ -2709,7 +3689,185 @@ interface components {
2709
3689
  /** @description User IDs whose calendars include this task */
2710
3690
  calendars?: string[];
2711
3691
  };
2712
- /** @description The user's home screen tasks (favourites). */
3692
+ /**
3693
+ * @description The user's home screen tasks (favourites).
3694
+ * @example {
3695
+ * "tasks": [
3696
+ * {
3697
+ * "status": "pending",
3698
+ * "text": "Ship v3",
3699
+ * "shortId": "T4GNY",
3700
+ * "createdAt": "2022-01-10T12:12:46.308Z",
3701
+ * "updatedAt": "2025-07-10T08:25:54.460Z",
3702
+ * "listPosition": 99999,
3703
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
3704
+ * "calendars": [
3705
+ * "b2956627fe26a2c1e4b6d5202413f779"
3706
+ * ],
3707
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
3708
+ * "list": {
3709
+ * "id": "603449f6f107b67c63e8cee9",
3710
+ * "name": "Product",
3711
+ * "type": "group",
3712
+ * "privacy": "private",
3713
+ * "subLists": [
3714
+ * {
3715
+ * "id": "603449f6f107b67c63e8cee8",
3716
+ * "name": "To-do",
3717
+ * "listPosition": 100000,
3718
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3719
+ * },
3720
+ * {
3721
+ * "id": "610ffd8c7374d6331a4178d8",
3722
+ * "name": "In Progress",
3723
+ * "listPosition": 700000,
3724
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
3725
+ * }
3726
+ * ],
3727
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9"
3728
+ * },
3729
+ * "listId": "603449f6f107b67c63e8cee9",
3730
+ * "subListId": "610ffd8c7374d6331a4178d8",
3731
+ * "subList": {
3732
+ * "id": "610ffd8c7374d6331a4178d8",
3733
+ * "name": "To-do"
3734
+ * },
3735
+ * "assignedTo": [
3736
+ * {
3737
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3738
+ * "name": "Ada Lovelace",
3739
+ * "userName": "ada",
3740
+ * "email": "ada@example.com",
3741
+ * "platformDetails": {
3742
+ * "name": "slack",
3743
+ * "imChannel": "D3F5RQA6B",
3744
+ * "selfChannel": "D1LGYBCFQ",
3745
+ * "userId": "U0JU26WRG",
3746
+ * "teamId": "T0HBUA0TC"
3747
+ * },
3748
+ * "confirmed": true,
3749
+ * "avatar": "https://cdn.workast.io/avatar.png",
3750
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3751
+ * }
3752
+ * ],
3753
+ * "subscribers": [
3754
+ * {
3755
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3756
+ * "name": "Ada Lovelace",
3757
+ * "userName": "ada",
3758
+ * "email": "ada@example.com",
3759
+ * "platformDetails": {
3760
+ * "name": "slack",
3761
+ * "imChannel": "D3F5RQA6B",
3762
+ * "selfChannel": "D1LGYBCFQ",
3763
+ * "userId": "U0JU26WRG",
3764
+ * "teamId": "T0HBUA0TC"
3765
+ * },
3766
+ * "confirmed": true,
3767
+ * "avatar": "https://cdn.workast.io/avatar.png",
3768
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3769
+ * },
3770
+ * {
3771
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3772
+ * "name": "Grace Hopper",
3773
+ * "userName": "grace",
3774
+ * "email": "grace@example.com",
3775
+ * "platformDetails": {
3776
+ * "name": "slack",
3777
+ * "imChannel": "D3EEXS3J6",
3778
+ * "selfChannel": "D1HN843U3",
3779
+ * "userId": "U0HBQESA1",
3780
+ * "teamId": "T0HBUA0TC"
3781
+ * },
3782
+ * "confirmed": true,
3783
+ * "avatar": "https://cdn.workast.io/avatar.png",
3784
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3785
+ * }
3786
+ * ],
3787
+ * "allDay": false,
3788
+ * "createdBy": {
3789
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3790
+ * "name": "Ada Lovelace",
3791
+ * "userName": "ada",
3792
+ * "email": "ada@example.com",
3793
+ * "platformDetails": {
3794
+ * "name": "slack",
3795
+ * "imChannel": "D3F5RQA6B",
3796
+ * "selfChannel": "D1LGYBCFQ",
3797
+ * "userId": "U0JU26WRG",
3798
+ * "teamId": "T0HBUA0TC"
3799
+ * },
3800
+ * "confirmed": true,
3801
+ * "avatar": "https://cdn.workast.io/avatar.png",
3802
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3803
+ * },
3804
+ * "hasDescription": true,
3805
+ * "numberOfComments": 1,
3806
+ * "numberOfAttachments": 0,
3807
+ * "totalSubTasks": 1,
3808
+ * "completedSubTasks": 0,
3809
+ * "isSubscribed": true,
3810
+ * "lastComment": {
3811
+ * "id": "686f7912fc2fef09733c6f58",
3812
+ * "type": "comment",
3813
+ * "value": "Standup",
3814
+ * "status": "active",
3815
+ * "createdAt": "2025-07-10T08:25:54.274Z",
3816
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
3817
+ * "mentions": [
3818
+ * {
3819
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
3820
+ * "name": "Ada Lovelace",
3821
+ * "userName": "ada",
3822
+ * "email": "ada@example.com",
3823
+ * "platformDetails": {
3824
+ * "name": "slack",
3825
+ * "imChannel": "D3F5RQA6B",
3826
+ * "selfChannel": "D1LGYBCFQ",
3827
+ * "userId": "U0JU26WRG",
3828
+ * "teamId": "T0HBUA0TC"
3829
+ * },
3830
+ * "confirmed": true,
3831
+ * "avatar": "https://cdn.workast.io/avatar.png",
3832
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3833
+ * }
3834
+ * ],
3835
+ * "reactions": [],
3836
+ * "actor": {
3837
+ * "type": "User",
3838
+ * "data": {
3839
+ * "id": "4214932441cb21eebdb396bfe34a8340",
3840
+ * "name": "Grace Hopper",
3841
+ * "userName": "grace",
3842
+ * "email": "grace@example.com",
3843
+ * "platformDetails": {
3844
+ * "name": "slack",
3845
+ * "imChannel": "D3EEXS3J6",
3846
+ * "selfChannel": "D1HN843U3",
3847
+ * "userId": "U0HBQESA1",
3848
+ * "teamId": "T0HBUA0TC"
3849
+ * },
3850
+ * "confirmed": true,
3851
+ * "avatar": "https://cdn.workast.io/avatar.png",
3852
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
3853
+ * }
3854
+ * }
3855
+ * },
3856
+ * "taskStatus": {
3857
+ * "id": "5c7184fa40721e2ed4175a6e",
3858
+ * "label": "Open",
3859
+ * "color": "#808080",
3860
+ * "createdAt": "2019-02-23T17:38:02.928Z",
3861
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
3862
+ * },
3863
+ * "milestones": [],
3864
+ * "inHome": true,
3865
+ * "fields": []
3866
+ * }
3867
+ * ],
3868
+ * "total": 1
3869
+ * }
3870
+ */
2713
3871
  HomeTasks: {
2714
3872
  tasks?: components["schemas"]["TaskListItem"][];
2715
3873
  /** @description Total number of home tasks. */
@@ -2923,7 +4081,152 @@ interface components {
2923
4081
  /** @description Users mentioned in a comment. */
2924
4082
  mentions?: components["schemas"]["UserMinimalResource"][];
2925
4083
  };
2926
- /** @description Paginated task activities from Activity.search, with each item from activity.buildResource (task, team, and list omitted) plus userFriendlyContent. */
4084
+ /**
4085
+ * @description Paginated task activities from Activity.search, with each item from activity.buildResource (task, team, and list omitted) plus userFriendlyContent.
4086
+ * @example {
4087
+ * "activities": [
4088
+ * {
4089
+ * "id": "61dc22bee45fbc0e26ca342d",
4090
+ * "type": "task_created",
4091
+ * "createdAt": "2022-01-10T12:12:46.500Z",
4092
+ * "updatedAt": "2022-01-10T12:12:46.500Z",
4093
+ * "mentions": [],
4094
+ * "actor": {
4095
+ * "type": "User",
4096
+ * "data": {
4097
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4098
+ * "name": "Ada Lovelace",
4099
+ * "userName": "ada",
4100
+ * "email": "ada@example.com",
4101
+ * "platformDetails": {
4102
+ * "name": "slack",
4103
+ * "imChannel": "D3F5RQA6B",
4104
+ * "selfChannel": "D1LGYBCFQ",
4105
+ * "userId": "U0JU26WRG",
4106
+ * "teamId": "T0HBUA0TC"
4107
+ * },
4108
+ * "confirmed": true,
4109
+ * "avatar": "https://cdn.workast.io/avatar.png",
4110
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4111
+ * }
4112
+ * },
4113
+ * "userFriendlyContent": {
4114
+ * "task": {
4115
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
4116
+ * "shortId": "T4GNY",
4117
+ * "status": "pending",
4118
+ * "subscribers": [
4119
+ * "b2956627fe26a2c1e4b6d5202413f779",
4120
+ * "4214932441cb21eebdb396bfe34a8340"
4121
+ * ],
4122
+ * "calendars": [
4123
+ * "b2956627fe26a2c1e4b6d5202413f779"
4124
+ * ],
4125
+ * "text": "Ship v3",
4126
+ * "description": "Ship v3",
4127
+ * "subListId": "610ffd8c7374d6331a4178d8",
4128
+ * "listId": "603449f6f107b67c63e8cee9",
4129
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
4130
+ * "allDay": false,
4131
+ * "createdBy": {
4132
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4133
+ * "createdAt": "2016-12-28T22:19:45.715Z",
4134
+ * "name": "Ada Lovelace",
4135
+ * "userName": "ada",
4136
+ * "platformDetails": {
4137
+ * "name": "slack",
4138
+ * "imChannel": "D3F5RQA6B",
4139
+ * "selfChannel": "D1LGYBCFQ",
4140
+ * "userId": "U0JU26WRG",
4141
+ * "teamId": "T0HBUA0TC"
4142
+ * },
4143
+ * "timezone": "Australia/Canberra",
4144
+ * "email": "ada@example.com",
4145
+ * "lastActive": "2025-07-10T01:22:15.814Z",
4146
+ * "role": "admin",
4147
+ * "status": "active",
4148
+ * "confirmed": true,
4149
+ * "profile": {},
4150
+ * "avatar": "https://cdn.workast.io/avatar.png",
4151
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4152
+ * },
4153
+ * "assignedTo": [
4154
+ * {
4155
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4156
+ * "createdAt": "2016-12-28T22:19:45.715Z",
4157
+ * "name": "Ada Lovelace",
4158
+ * "userName": "ada",
4159
+ * "platformDetails": {
4160
+ * "name": "slack",
4161
+ * "imChannel": "D3F5RQA6B",
4162
+ * "selfChannel": "D1LGYBCFQ",
4163
+ * "userId": "U0JU26WRG",
4164
+ * "teamId": "T0HBUA0TC"
4165
+ * },
4166
+ * "timezone": "Australia/Canberra",
4167
+ * "email": "ada@example.com",
4168
+ * "lastActive": "2025-07-10T01:22:15.814Z",
4169
+ * "role": "admin",
4170
+ * "status": "active",
4171
+ * "confirmed": true,
4172
+ * "profile": {},
4173
+ * "avatar": "https://cdn.workast.io/avatar.png",
4174
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4175
+ * }
4176
+ * ]
4177
+ * },
4178
+ * "list": {
4179
+ * "id": "603449f6f107b67c63e8cee9",
4180
+ * "name": "Product",
4181
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
4182
+ * "subLists": [
4183
+ * {
4184
+ * "id": "603449f6f107b67c63e8cee8",
4185
+ * "name": "To-do",
4186
+ * "listPosition": 100000,
4187
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
4188
+ * },
4189
+ * {
4190
+ * "id": "610ffd8c7374d6331a4178d8",
4191
+ * "name": "In Progress",
4192
+ * "listPosition": 700000,
4193
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
4194
+ * }
4195
+ * ],
4196
+ * "platformDetails": {
4197
+ * "name": "slack",
4198
+ * "channelId": "G01NLRJ053L",
4199
+ * "channelName": "engineering",
4200
+ * "type": "group",
4201
+ * "teamId": "T0HBUA0TC"
4202
+ * }
4203
+ * },
4204
+ * "actor": {
4205
+ * "type": "User",
4206
+ * "id": {
4207
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4208
+ * "name": "Ada Lovelace",
4209
+ * "userName": "ada",
4210
+ * "email": "ada@example.com",
4211
+ * "platformDetails": {
4212
+ * "name": "slack",
4213
+ * "imChannel": "D3F5RQA6B",
4214
+ * "selfChannel": "D1LGYBCFQ",
4215
+ * "userId": "U0JU26WRG",
4216
+ * "teamId": "T0HBUA0TC"
4217
+ * },
4218
+ * "confirmed": true,
4219
+ * "avatar": "https://cdn.workast.io/avatar.png",
4220
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4221
+ * }
4222
+ * },
4223
+ * "message": "{{actor}} created the task {{task}}"
4224
+ * }
4225
+ * }
4226
+ * ],
4227
+ * "total": 17
4228
+ * }
4229
+ */
2927
4230
  TaskActivities: {
2928
4231
  /**
2929
4232
  * @description The total amount of activities that matched the search criteria
@@ -3038,9 +4341,56 @@ interface components {
3038
4341
  * @description The kind of activity
3039
4342
  * @enum {string}
3040
4343
  */
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. */
4344
+ 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";
4345
+ /**
4346
+ * @description CommentActivity.buildResource, omitting task and list.
4347
+ * @example {
4348
+ * "id": "686f7912fc2fef09733c6f58",
4349
+ * "type": "comment",
4350
+ * "value": "Standup",
4351
+ * "status": "active",
4352
+ * "createdAt": "2025-07-10T08:25:54.274Z",
4353
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
4354
+ * "mentions": [
4355
+ * {
4356
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4357
+ * "name": "Ada Lovelace",
4358
+ * "userName": "ada",
4359
+ * "email": "ada@example.com",
4360
+ * "platformDetails": {
4361
+ * "name": "slack",
4362
+ * "imChannel": "D3F5RQA6B",
4363
+ * "selfChannel": "D1LGYBCFQ",
4364
+ * "userId": "U0JU26WRG",
4365
+ * "teamId": "T0HBUA0TC"
4366
+ * },
4367
+ * "confirmed": true,
4368
+ * "avatar": "https://cdn.workast.io/avatar.png",
4369
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4370
+ * }
4371
+ * ],
4372
+ * "reactions": [],
4373
+ * "actor": {
4374
+ * "type": "User",
4375
+ * "data": {
4376
+ * "id": "4214932441cb21eebdb396bfe34a8340",
4377
+ * "name": "Grace Hopper",
4378
+ * "userName": "grace",
4379
+ * "email": "grace@example.com",
4380
+ * "platformDetails": {
4381
+ * "name": "slack",
4382
+ * "imChannel": "D3EEXS3J6",
4383
+ * "selfChannel": "D1HN843U3",
4384
+ * "userId": "U0HBQESA1",
4385
+ * "teamId": "T0HBUA0TC"
4386
+ * },
4387
+ * "confirmed": true,
4388
+ * "avatar": "https://cdn.workast.io/avatar.png",
4389
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4390
+ * }
4391
+ * }
4392
+ * }
4393
+ */
3044
4394
  CommentActivity: {
3045
4395
  /**
3046
4396
  * @description The activity unique ID.
@@ -3151,7 +4501,129 @@ interface components {
3151
4501
  */
3152
4502
  updateDueDates?: number;
3153
4503
  };
3154
- /** @description Full list. Built by buildListDetailResource. */
4504
+ /**
4505
+ * @description Full list. Built by buildListDetailResource.
4506
+ * @example {
4507
+ * "id": "5a6ebde81519395731f90e2f",
4508
+ * "hash": "26873fa18b3a3c5bfd82f9d8e2dafa05",
4509
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
4510
+ * "name": "Engineering",
4511
+ * "numberOfParticipants": 2,
4512
+ * "type": "group",
4513
+ * "privacy": "private",
4514
+ * "platformDetails": {
4515
+ * "name": "slack",
4516
+ * "channelId": "G8TRB56E8",
4517
+ * "channelName": "engineering",
4518
+ * "type": "group",
4519
+ * "teamId": "T0HBUA0TC"
4520
+ * },
4521
+ * "isArchived": false,
4522
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779",
4523
+ * "participants": [
4524
+ * "4214932441cb21eebdb396bfe34a8340",
4525
+ * "c51a9c1a2ddfbcefa7abf74036e0c616",
4526
+ * "b2956627fe26a2c1e4b6d5202413f779"
4527
+ * ],
4528
+ * "platformNotifications": {
4529
+ * "taskCreated": true,
4530
+ * "taskCompleted": true
4531
+ * },
4532
+ * "apps": [
4533
+ * {
4534
+ * "id": "5af007dff36d2837eae6e56c",
4535
+ * "name": "Slack",
4536
+ * "description": "Ship v3",
4537
+ * "icon": "https://cdn.workast.io/integrations/Slack/icon.png",
4538
+ * "updatedAt": "2023-11-15T03:23:37.468Z",
4539
+ * "clientId": "nUsktT5eDzpbJE15WLfMejf9oJ",
4540
+ * "accessType": "user",
4541
+ * "developedByWorkast": true,
4542
+ * "integration": {
4543
+ * "spaceActions": [
4544
+ * {
4545
+ * "actionId": "SHOW_SETTINGS",
4546
+ * "label": "Slack"
4547
+ * }
4548
+ * ],
4549
+ * "taskActions": []
4550
+ * }
4551
+ * },
4552
+ * {
4553
+ * "id": "5b23da45e7179a589282a60c",
4554
+ * "name": "Email",
4555
+ * "description": "Ship v3",
4556
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
4557
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
4558
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
4559
+ * "accessType": "user",
4560
+ * "developedByWorkast": true,
4561
+ * "integration": {
4562
+ * "spaceActions": [
4563
+ * {
4564
+ * "actionId": "SHOW_SETTINGS",
4565
+ * "label": "Email"
4566
+ * }
4567
+ * ],
4568
+ * "taskActions": []
4569
+ * }
4570
+ * }
4571
+ * ],
4572
+ * "defaultSubList": "5a6ebde81519395731f90e30",
4573
+ * "subLists": [
4574
+ * {
4575
+ * "id": "5a6ebde81519395731f90e30",
4576
+ * "name": "To-do",
4577
+ * "listPosition": 100000,
4578
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4579
+ * }
4580
+ * ],
4581
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f",
4582
+ * "isParticipant": true,
4583
+ * "someParticipants": [
4584
+ * {
4585
+ * "id": "4214932441cb21eebdb396bfe34a8340",
4586
+ * "name": "Grace Hopper",
4587
+ * "userName": "grace",
4588
+ * "email": "grace@example.com",
4589
+ * "platformDetails": {
4590
+ * "name": "slack",
4591
+ * "imChannel": "D3EEXS3J6",
4592
+ * "selfChannel": "D1HN843U3",
4593
+ * "userId": "U0HBQESA1",
4594
+ * "teamId": "T0HBUA0TC"
4595
+ * },
4596
+ * "confirmed": true,
4597
+ * "avatar": "https://cdn.workast.io/avatar.png",
4598
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4599
+ * },
4600
+ * {
4601
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4602
+ * "name": "Ada Lovelace",
4603
+ * "userName": "ada",
4604
+ * "email": "ada@example.com",
4605
+ * "platformDetails": {
4606
+ * "name": "slack",
4607
+ * "imChannel": "D3F5RQA6B",
4608
+ * "selfChannel": "D1LGYBCFQ",
4609
+ * "userId": "U0JU26WRG",
4610
+ * "teamId": "T0HBUA0TC"
4611
+ * },
4612
+ * "confirmed": true,
4613
+ * "avatar": "https://cdn.workast.io/avatar.png",
4614
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4615
+ * }
4616
+ * ],
4617
+ * "columns": [
4618
+ * "assignedTo",
4619
+ * "dueDate",
4620
+ * "doneBy",
4621
+ * "doneAt"
4622
+ * ],
4623
+ * "groupBy": "subList",
4624
+ * "isBookmarked": false
4625
+ * }
4626
+ */
3155
4627
  List: {
3156
4628
  /** @description The list unique ID */
3157
4629
  id?: string;
@@ -3228,7 +4700,15 @@ interface components {
3228
4700
  */
3229
4701
  bgColor?: string;
3230
4702
  };
3231
- /** @description Sublist. Built by SubList.buildResource. */
4703
+ /**
4704
+ * @description Sublist. Built by SubList.buildResource.
4705
+ * @example {
4706
+ * "id": "5a6ebde81519395731f90e30",
4707
+ * "name": "To-do",
4708
+ * "listPosition": 100000,
4709
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4710
+ * }
4711
+ */
3232
4712
  SubList: {
3233
4713
  /** @description The sublist unique ID */
3234
4714
  id?: string;
@@ -3287,7 +4767,58 @@ interface components {
3287
4767
  subLists?: components["schemas"]["SubList"][];
3288
4768
  platformDetails?: components["schemas"]["ListPlatformDetails"];
3289
4769
  };
3290
- /** @description List as returned when searching lists. Built by buildListToEnumerateResource. */
4770
+ /**
4771
+ * @description List as returned when searching lists. Built by buildListToEnumerateResource.
4772
+ * @example {
4773
+ * "id": "5a6ebde81519395731f90e2f",
4774
+ * "hash": "26873fa18b3a3c5bfd82f9d8e2dafa05",
4775
+ * "name": "Engineering",
4776
+ * "createdAt": "2018-01-29T06:23:36.194Z",
4777
+ * "createdBy": {
4778
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
4779
+ * "name": "Ada Lovelace",
4780
+ * "userName": "ada",
4781
+ * "email": "ada@example.com",
4782
+ * "platformDetails": {
4783
+ * "name": "slack",
4784
+ * "imChannel": "D3F5RQA6B",
4785
+ * "selfChannel": "D1LGYBCFQ",
4786
+ * "userId": "U0JU26WRG",
4787
+ * "teamId": "T0HBUA0TC"
4788
+ * },
4789
+ * "confirmed": true,
4790
+ * "avatar": "https://cdn.workast.io/avatar.png",
4791
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
4792
+ * },
4793
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
4794
+ * "numberOfParticipants": 3,
4795
+ * "type": "group",
4796
+ * "privacy": "private",
4797
+ * "isArchived": false,
4798
+ * "platformDetails": {
4799
+ * "name": "slack",
4800
+ * "channelId": "G8TRB56E8",
4801
+ * "channelName": "engineering",
4802
+ * "type": "group",
4803
+ * "teamId": "T0HBUA0TC"
4804
+ * },
4805
+ * "platformNotifications": {
4806
+ * "taskCreated": true,
4807
+ * "taskCompleted": true
4808
+ * },
4809
+ * "subLists": [
4810
+ * {
4811
+ * "id": "5a6ebde81519395731f90e30",
4812
+ * "name": "To-do",
4813
+ * "listPosition": 100000,
4814
+ * "createdBy": "b2956627fe26a2c1e4b6d5202413f779"
4815
+ * }
4816
+ * ],
4817
+ * "defaultSubList": "5a6ebde81519395731f90e30",
4818
+ * "isParticipant": true,
4819
+ * "link": "https://app.workast.com/list/5a6ebde81519395731f90e2f"
4820
+ * }
4821
+ */
3291
4822
  ListEnumerate: {
3292
4823
  /** @description The list unique ID */
3293
4824
  id?: string;
@@ -3368,7 +4899,14 @@ interface components {
3368
4899
  */
3369
4900
  link: string;
3370
4901
  };
3371
- /** @description Tag. Built by Tag.buildResource. */
4902
+ /**
4903
+ * @description Tag. Built by Tag.buildResource.
4904
+ * @example {
4905
+ * "id": "5a6227d69f0cec2676083529",
4906
+ * "name": "Feature",
4907
+ * "color": "#61bd4f"
4908
+ * }
4909
+ */
3372
4910
  Tag: {
3373
4911
  /** @description The tag's unique id */
3374
4912
  id: string;
@@ -3398,7 +4936,34 @@ interface components {
3398
4936
  * @enum {string}
3399
4937
  */
3400
4938
  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. */
4939
+ /**
4940
+ * @description Paginated notifications from Notification.search. Each item from Notification.buildResource.
4941
+ * @example {
4942
+ * "notifications": [
4943
+ * {
4944
+ * "id": "6a7ea6b48e9808acbda8914f",
4945
+ * "type": "meeting_media_ready",
4946
+ * "read": false,
4947
+ * "activityId": "6a7ea6b48e9808acbda89147",
4948
+ * "sentAt": "2026-08-14T05:25:08.472Z",
4949
+ * "createdAt": "2026-08-14T05:25:08.474Z",
4950
+ * "content": {
4951
+ * "actor": {
4952
+ * "type": "App",
4953
+ * "id": {
4954
+ * "id": "5ed17524aa2ab23bf71d324d",
4955
+ * "name": "Meetings",
4956
+ * "icon": "https://cdn.workast.io/avatar.png"
4957
+ * }
4958
+ * },
4959
+ * "message": "Standup"
4960
+ * },
4961
+ * "activityType": "meeting_media_ready"
4962
+ * }
4963
+ * ],
4964
+ * "total": 2244
4965
+ * }
4966
+ */
3402
4967
  Notifications: {
3403
4968
  /** @description Total number of matching notifications. */
3404
4969
  total: number;
@@ -3709,6 +5274,14 @@ interface components {
3709
5274
  value: string;
3710
5275
  }[];
3711
5276
  };
5277
+ /**
5278
+ * @example {
5279
+ * "modified": [
5280
+ * "3634dc043f0d415ec2d307284a3cfe69"
5281
+ * ],
5282
+ * "error": []
5283
+ * }
5284
+ */
3712
5285
  TaskBulkUpdateResult: {
3713
5286
  /** @description Task IDs that were updated */
3714
5287
  modified: string[];
@@ -3851,7 +5424,23 @@ interface components {
3851
5424
  /** @description Share on platform when a task is completed */
3852
5425
  taskCompleted?: boolean;
3853
5426
  };
3854
- /** @description Token authentication details from GET /me. app, user, and team are omitted when not on the token. */
5427
+ /**
5428
+ * @description Token authentication details from GET /me. app, user, and team are omitted when not on the token.
5429
+ * @example {
5430
+ * "app": {
5431
+ * "id": "5d9a6b09269e415d36380d23",
5432
+ * "name": "Example App"
5433
+ * },
5434
+ * "user": {
5435
+ * "id": "4214932441cb21eebdb396bfe34a8340",
5436
+ * "name": "Grace Hopper"
5437
+ * },
5438
+ * "team": {
5439
+ * "id": "ca19601b6bb816ca95386698b3385d49",
5440
+ * "name": "Example Team"
5441
+ * }
5442
+ * }
5443
+ */
3855
5444
  TokenDetails: {
3856
5445
  app?: components["schemas"]["TokenApp"];
3857
5446
  user?: components["schemas"]["TokenUser"];
@@ -4704,7 +6293,85 @@ interface components {
4704
6293
  SearchReminderSet: {
4705
6294
  repeat: components["schemas"]["RepeatSchema"];
4706
6295
  };
4707
- /** @description Full search resource. Built by Search.buildResource. */
6296
+ /**
6297
+ * @description Full search resource. Built by Search.buildResource.
6298
+ * @example {
6299
+ * "id": "5f0e23098d49422410c20540",
6300
+ * "custom": true,
6301
+ * "name": "Ship v3",
6302
+ * "payload": {
6303
+ * "sort": [
6304
+ * {
6305
+ * "direction": 1,
6306
+ * "field": "listName"
6307
+ * }
6308
+ * ],
6309
+ * "includeSubTasks": true,
6310
+ * "predicates": [
6311
+ * {
6312
+ * "value": "pending",
6313
+ * "comparison": "eq",
6314
+ * "attribute": "status",
6315
+ * "type": "status"
6316
+ * }
6317
+ * ],
6318
+ * "columns": [
6319
+ * "list"
6320
+ * ]
6321
+ * },
6322
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5f0e23098d49422410c20540",
6323
+ * "isPrimary": false,
6324
+ * "users": [],
6325
+ * "createdBy": {
6326
+ * "user": {
6327
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6328
+ * "name": "Grace Hopper",
6329
+ * "userName": "grace",
6330
+ * "email": "grace@example.com",
6331
+ * "platformDetails": {
6332
+ * "name": "slack",
6333
+ * "imChannel": "D3EEXS3J6",
6334
+ * "selfChannel": "D1HN843U3",
6335
+ * "userId": "U0HBQESA1",
6336
+ * "teamId": "T0HBUA0TC"
6337
+ * },
6338
+ * "confirmed": true,
6339
+ * "avatar": "https://cdn.workast.io/avatar.png",
6340
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6341
+ * }
6342
+ * },
6343
+ * "createdAt": "2020-07-14T21:26:33.254Z",
6344
+ * "updatedAt": "2023-05-31T23:15:19.277Z",
6345
+ * "values": {
6346
+ * "list": {
6347
+ * "5a99a7a58373fa652992e665": {
6348
+ * "id": "5a99a7a58373fa652992e665",
6349
+ * "type": "group",
6350
+ * "status": "active",
6351
+ * "privacy": "team",
6352
+ * "link": "https://app.workast.com/list/5a99a7a58373fa652992e665",
6353
+ * "name": "Engineering"
6354
+ * },
6355
+ * "5dc40cff038a590f79c403c0": {
6356
+ * "id": "5dc40cff038a590f79c403c0",
6357
+ * "type": "group",
6358
+ * "status": "active",
6359
+ * "privacy": "team",
6360
+ * "link": "https://app.workast.com/list/5dc40cff038a590f79c403c0",
6361
+ * "name": "Product"
6362
+ * },
6363
+ * "5fc58f3d15ff9110b64ca426": {
6364
+ * "id": "5fc58f3d15ff9110b64ca426",
6365
+ * "type": "group",
6366
+ * "status": "active",
6367
+ * "privacy": "team",
6368
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
6369
+ * "name": "Engineering"
6370
+ * }
6371
+ * }
6372
+ * }
6373
+ * }
6374
+ */
4708
6375
  Search: {
4709
6376
  /** @description The Search ID. */
4710
6377
  readonly id?: string;
@@ -4798,13 +6465,195 @@ interface components {
4798
6465
  [key: string]: components["schemas"]["UserMinimalResource"];
4799
6466
  };
4800
6467
  };
4801
- /** @description Paginated searches for the logged-in user. */
6468
+ /**
6469
+ * @description Paginated searches for the logged-in user.
6470
+ * @example {
6471
+ * "searches": [
6472
+ * {
6473
+ * "id": "5ddfeab45ff6d925d23c929e",
6474
+ * "name": "Ship v3",
6475
+ * "custom": true,
6476
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5ddfeab45ff6d925d23c929e",
6477
+ * "usersCount": 0,
6478
+ * "createdBy": {
6479
+ * "user": "4214932441cb21eebdb396bfe34a8340"
6480
+ * },
6481
+ * "createdAt": "2019-11-28T15:41:40.245Z",
6482
+ * "updatedAt": "2021-01-14T18:44:34.151Z"
6483
+ * }
6484
+ * ],
6485
+ * "total": 3
6486
+ * }
6487
+ */
4802
6488
  Searches: {
4803
6489
  /** @description SearchItem when home is false (default); Search when home is true. */
4804
6490
  searches?: (components["schemas"]["SearchItem"] | components["schemas"]["Search"])[];
4805
6491
  /** @description Total number of matching searches. */
4806
6492
  total?: number;
4807
6493
  };
6494
+ /**
6495
+ * @example {
6496
+ * "tasks": [
6497
+ * {
6498
+ * "status": "pending",
6499
+ * "text": "Ship v3",
6500
+ * "shortId": "T4GNY",
6501
+ * "createdAt": "2022-01-10T12:12:46.308Z",
6502
+ * "updatedAt": "2025-07-10T08:25:54.460Z",
6503
+ * "listPosition": 99999,
6504
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/3634dc043f0d415ec2d307284a3cfe69",
6505
+ * "calendars": [
6506
+ * "b2956627fe26a2c1e4b6d5202413f779"
6507
+ * ],
6508
+ * "id": "3634dc043f0d415ec2d307284a3cfe69",
6509
+ * "list": {
6510
+ * "id": "603449f6f107b67c63e8cee9",
6511
+ * "name": "Product",
6512
+ * "type": "group",
6513
+ * "privacy": "private",
6514
+ * "link": "https://app.workast.com/list/603449f6f107b67c63e8cee9",
6515
+ * "subLists": [
6516
+ * {
6517
+ * "id": "603449f6f107b67c63e8cee8",
6518
+ * "name": "To-do",
6519
+ * "listPosition": 100000,
6520
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6521
+ * },
6522
+ * {
6523
+ * "id": "610ffd8c7374d6331a4178d8",
6524
+ * "name": "In Progress",
6525
+ * "listPosition": 700000,
6526
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6527
+ * }
6528
+ * ]
6529
+ * },
6530
+ * "listId": "603449f6f107b67c63e8cee9",
6531
+ * "subListId": "610ffd8c7374d6331a4178d8",
6532
+ * "subList": {
6533
+ * "id": "610ffd8c7374d6331a4178d8",
6534
+ * "name": "To-do"
6535
+ * },
6536
+ * "assignedTo": [
6537
+ * {
6538
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6539
+ * "name": "Ada Lovelace",
6540
+ * "userName": "ada",
6541
+ * "email": "ada@example.com",
6542
+ * "platformDetails": {
6543
+ * "name": "slack",
6544
+ * "imChannel": "D3F5RQA6B",
6545
+ * "selfChannel": "D1LGYBCFQ",
6546
+ * "userId": "U0JU26WRG",
6547
+ * "teamId": "T0HBUA0TC"
6548
+ * },
6549
+ * "confirmed": true,
6550
+ * "avatar": "https://cdn.workast.io/avatar.png",
6551
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6552
+ * }
6553
+ * ],
6554
+ * "subscribers": [
6555
+ * {
6556
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6557
+ * "name": "Ada Lovelace",
6558
+ * "userName": "ada",
6559
+ * "email": "ada@example.com",
6560
+ * "platformDetails": {
6561
+ * "name": "slack",
6562
+ * "imChannel": "D3F5RQA6B",
6563
+ * "selfChannel": "D1LGYBCFQ",
6564
+ * "userId": "U0JU26WRG",
6565
+ * "teamId": "T0HBUA0TC"
6566
+ * },
6567
+ * "confirmed": true,
6568
+ * "avatar": "https://cdn.workast.io/avatar.png",
6569
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6570
+ * }
6571
+ * ],
6572
+ * "allDay": false,
6573
+ * "createdBy": {
6574
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6575
+ * "name": "Ada Lovelace",
6576
+ * "userName": "ada",
6577
+ * "email": "ada@example.com",
6578
+ * "platformDetails": {
6579
+ * "name": "slack",
6580
+ * "imChannel": "D3F5RQA6B",
6581
+ * "selfChannel": "D1LGYBCFQ",
6582
+ * "userId": "U0JU26WRG",
6583
+ * "teamId": "T0HBUA0TC"
6584
+ * },
6585
+ * "confirmed": true,
6586
+ * "avatar": "https://cdn.workast.io/avatar.png",
6587
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6588
+ * },
6589
+ * "hasDescription": true,
6590
+ * "numberOfComments": 1,
6591
+ * "numberOfAttachments": 0,
6592
+ * "totalSubTasks": 1,
6593
+ * "completedSubTasks": 0,
6594
+ * "isSubscribed": true,
6595
+ * "lastComment": {
6596
+ * "id": "686f7912fc2fef09733c6f58",
6597
+ * "type": "comment",
6598
+ * "value": "Standup",
6599
+ * "status": "active",
6600
+ * "createdAt": "2025-07-10T08:25:54.274Z",
6601
+ * "updatedAt": "2025-07-10T08:25:54.274Z",
6602
+ * "mentions": [
6603
+ * {
6604
+ * "id": "b2956627fe26a2c1e4b6d5202413f779",
6605
+ * "name": "Ada Lovelace",
6606
+ * "userName": "ada",
6607
+ * "email": "ada@example.com",
6608
+ * "platformDetails": {
6609
+ * "name": "slack",
6610
+ * "imChannel": "D3F5RQA6B",
6611
+ * "selfChannel": "D1LGYBCFQ",
6612
+ * "userId": "U0JU26WRG",
6613
+ * "teamId": "T0HBUA0TC"
6614
+ * },
6615
+ * "confirmed": true,
6616
+ * "avatar": "https://cdn.workast.io/avatar.png",
6617
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6618
+ * }
6619
+ * ],
6620
+ * "reactions": [],
6621
+ * "actor": {
6622
+ * "type": "User",
6623
+ * "data": {
6624
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6625
+ * "name": "Grace Hopper",
6626
+ * "userName": "grace",
6627
+ * "email": "grace@example.com",
6628
+ * "platformDetails": {
6629
+ * "name": "slack",
6630
+ * "imChannel": "D3EEXS3J6",
6631
+ * "selfChannel": "D1HN843U3",
6632
+ * "userId": "U0HBQESA1",
6633
+ * "teamId": "T0HBUA0TC"
6634
+ * },
6635
+ * "confirmed": true,
6636
+ * "avatar": "https://cdn.workast.io/avatar.png",
6637
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6638
+ * }
6639
+ * }
6640
+ * },
6641
+ * "taskStatus": {
6642
+ * "id": "5c7184fa40721e2ed4175a6e",
6643
+ * "label": "Open",
6644
+ * "color": "#808080",
6645
+ * "createdAt": "2019-02-23T17:38:02.928Z",
6646
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
6647
+ * },
6648
+ * "milestones": [],
6649
+ * "inHome": false,
6650
+ * "fields": []
6651
+ * }
6652
+ * ],
6653
+ * "total": 441,
6654
+ * "hiddenTasks": 0
6655
+ * }
6656
+ */
4808
6657
  SearchResults: {
4809
6658
  tasks?: components["schemas"]["TaskListItem"][];
4810
6659
  /** @description Total number of tasks in query. */
@@ -4812,12 +6661,445 @@ interface components {
4812
6661
  /** @description Number of hidden tasks in query. Only applies to cost centers whose product has this restriction. */
4813
6662
  hiddenTasks?: number;
4814
6663
  };
4815
- /** @description Search.buildResource plus optional task results when getTasks is set. */
6664
+ /**
6665
+ * @description Search.buildResource plus optional task results when getTasks is set.
6666
+ * @example {
6667
+ * "id": "5ddfeab45ff6d925d23c929e",
6668
+ * "custom": true,
6669
+ * "name": "Ship v3",
6670
+ * "payload": {
6671
+ * "includeSubTasks": true,
6672
+ * "predicates": [
6673
+ * {
6674
+ * "value": "pending",
6675
+ * "comparison": "eq",
6676
+ * "attribute": "status",
6677
+ * "type": "status"
6678
+ * },
6679
+ * {
6680
+ * "predicates": [
6681
+ * {
6682
+ * "value": "5a176b5aa67ba147e5057516",
6683
+ * "comparison": "eq",
6684
+ * "attribute": "listId",
6685
+ * "type": "list"
6686
+ * },
6687
+ * {
6688
+ * "value": "5d7be323c662860f7c97ba12",
6689
+ * "comparison": "eq",
6690
+ * "attribute": "listId",
6691
+ * "type": "list"
6692
+ * },
6693
+ * {
6694
+ * "value": "5de581bdf2cec034545231fb",
6695
+ * "comparison": "eq",
6696
+ * "attribute": "listId",
6697
+ * "type": "list"
6698
+ * },
6699
+ * {
6700
+ * "value": "5de5818df2cec034545231a2",
6701
+ * "comparison": "eq",
6702
+ * "attribute": "listId",
6703
+ * "type": "list"
6704
+ * },
6705
+ * {
6706
+ * "value": "5dc40cff038a590f79c403c0",
6707
+ * "comparison": "eq",
6708
+ * "attribute": "listId",
6709
+ * "type": "list"
6710
+ * },
6711
+ * {
6712
+ * "type": "list",
6713
+ * "attribute": "listId",
6714
+ * "comparison": "eq",
6715
+ * "value": "5e3d61b624e278106e8f6cf1"
6716
+ * },
6717
+ * {
6718
+ * "type": "list",
6719
+ * "attribute": "listId",
6720
+ * "comparison": "eq",
6721
+ * "value": "5f230805bf972326deafab16"
6722
+ * },
6723
+ * {
6724
+ * "type": "list",
6725
+ * "attribute": "listId",
6726
+ * "comparison": "eq",
6727
+ * "value": "5fc58f3d15ff9110b64ca426"
6728
+ * }
6729
+ * ],
6730
+ * "type": "or"
6731
+ * },
6732
+ * {
6733
+ * "value": "4214932441cb21eebdb396bfe34a8340",
6734
+ * "comparison": "eq",
6735
+ * "attribute": "assignedTo",
6736
+ * "type": "user"
6737
+ * }
6738
+ * ],
6739
+ * "sort": [
6740
+ * {
6741
+ * "field": "listName",
6742
+ * "direction": 1
6743
+ * }
6744
+ * ],
6745
+ * "columns": [
6746
+ * "list",
6747
+ * "subList",
6748
+ * "assignedTo",
6749
+ * "dueDate"
6750
+ * ]
6751
+ * },
6752
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/search/5ddfeab45ff6d925d23c929e",
6753
+ * "isPrimary": false,
6754
+ * "users": [],
6755
+ * "createdBy": {
6756
+ * "user": {
6757
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6758
+ * "name": "Grace Hopper",
6759
+ * "userName": "grace",
6760
+ * "email": "grace@example.com",
6761
+ * "platformDetails": {
6762
+ * "name": "slack",
6763
+ * "imChannel": "D3EEXS3J6",
6764
+ * "selfChannel": "D1HN843U3",
6765
+ * "userId": "U0HBQESA1",
6766
+ * "teamId": "T0HBUA0TC"
6767
+ * },
6768
+ * "confirmed": true,
6769
+ * "avatar": "https://cdn.workast.io/avatar.png",
6770
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6771
+ * }
6772
+ * },
6773
+ * "createdAt": "2019-11-28T15:41:40.245Z",
6774
+ * "updatedAt": "2021-01-14T18:44:34.151Z",
6775
+ * "values": {
6776
+ * "list": {
6777
+ * "5a176b5aa67ba147e5057516": {
6778
+ * "id": "5a176b5aa67ba147e5057516",
6779
+ * "type": "group",
6780
+ * "status": "archived",
6781
+ * "privacy": "team",
6782
+ * "link": "https://app.workast.com/list/5a176b5aa67ba147e5057516",
6783
+ * "name": "Engineering"
6784
+ * },
6785
+ * "5d7be323c662860f7c97ba12": {
6786
+ * "id": "5d7be323c662860f7c97ba12",
6787
+ * "type": "group",
6788
+ * "status": "archived",
6789
+ * "privacy": "team",
6790
+ * "link": "https://app.workast.com/list/5d7be323c662860f7c97ba12",
6791
+ * "name": "Product"
6792
+ * },
6793
+ * "5dc40cff038a590f79c403c0": {
6794
+ * "id": "5dc40cff038a590f79c403c0",
6795
+ * "type": "group",
6796
+ * "status": "active",
6797
+ * "privacy": "team",
6798
+ * "link": "https://app.workast.com/list/5dc40cff038a590f79c403c0",
6799
+ * "name": "Product"
6800
+ * },
6801
+ * "5de5818df2cec034545231a2": {
6802
+ * "id": "5de5818df2cec034545231a2",
6803
+ * "type": "group",
6804
+ * "status": "archived",
6805
+ * "privacy": "team",
6806
+ * "link": "https://app.workast.com/list/5de5818df2cec034545231a2",
6807
+ * "name": "Product"
6808
+ * },
6809
+ * "5de581bdf2cec034545231fb": {
6810
+ * "id": "5de581bdf2cec034545231fb",
6811
+ * "type": "group",
6812
+ * "status": "archived",
6813
+ * "privacy": "team",
6814
+ * "link": "https://app.workast.com/list/5de581bdf2cec034545231fb",
6815
+ * "name": "Product"
6816
+ * },
6817
+ * "5e3d61b624e278106e8f6cf1": {
6818
+ * "id": "5e3d61b624e278106e8f6cf1",
6819
+ * "type": "group",
6820
+ * "status": "archived",
6821
+ * "privacy": "team",
6822
+ * "link": "https://app.workast.com/list/5e3d61b624e278106e8f6cf1",
6823
+ * "name": "Product"
6824
+ * },
6825
+ * "5f230805bf972326deafab16": {
6826
+ * "id": "5f230805bf972326deafab16",
6827
+ * "type": "group",
6828
+ * "status": "active",
6829
+ * "privacy": "team",
6830
+ * "link": "https://app.workast.com/list/5f230805bf972326deafab16",
6831
+ * "name": "Product"
6832
+ * },
6833
+ * "5fc58f3d15ff9110b64ca426": {
6834
+ * "id": "5fc58f3d15ff9110b64ca426",
6835
+ * "type": "group",
6836
+ * "status": "active",
6837
+ * "privacy": "team",
6838
+ * "link": "https://app.workast.com/list/5fc58f3d15ff9110b64ca426",
6839
+ * "name": "Product"
6840
+ * }
6841
+ * },
6842
+ * "user": {
6843
+ * "4214932441cb21eebdb396bfe34a8340": {
6844
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6845
+ * "name": "Grace Hopper",
6846
+ * "userName": "grace",
6847
+ * "email": "grace@example.com",
6848
+ * "platformDetails": {
6849
+ * "name": "slack",
6850
+ * "imChannel": "D3EEXS3J6",
6851
+ * "selfChannel": "D1HN843U3",
6852
+ * "userId": "U0HBQESA1",
6853
+ * "teamId": "T0HBUA0TC"
6854
+ * },
6855
+ * "confirmed": true,
6856
+ * "avatar": "https://cdn.workast.io/avatar.png",
6857
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6858
+ * }
6859
+ * }
6860
+ * },
6861
+ * "results": {
6862
+ * "tasks": [
6863
+ * {
6864
+ * "status": "pending",
6865
+ * "text": "Ship v3",
6866
+ * "shortId": "TGNT8",
6867
+ * "createdAt": "2026-07-30T11:06:01.976Z",
6868
+ * "updatedAt": "2026-08-03T04:47:29.070Z",
6869
+ * "listPosition": -400001,
6870
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/task/11c933fd54aab8cfe9957ab46ccb401f",
6871
+ * "calendars": [
6872
+ * "4214932441cb21eebdb396bfe34a8340"
6873
+ * ],
6874
+ * "id": "11c933fd54aab8cfe9957ab46ccb401f",
6875
+ * "list": {
6876
+ * "id": "5dc40cff038a590f79c403c0",
6877
+ * "name": "Development Product",
6878
+ * "type": "group",
6879
+ * "privacy": "team",
6880
+ * "link": "https://open.workast.app/ca19601b6bb816ca95386698b3385d49/space/5dc40cff038a590f79c403c0",
6881
+ * "subLists": [
6882
+ * {
6883
+ * "id": "5dc40d3f7e802c0f93f20232",
6884
+ * "name": "Live testing",
6885
+ * "listPosition": 100000,
6886
+ * "createdBy": "4214932441cb21eebdb396bfe34a8340"
6887
+ * }
6888
+ * ]
6889
+ * },
6890
+ * "listId": "5dc40cff038a590f79c403c0",
6891
+ * "subListId": "5dc40d3f7e802c0f93f20232",
6892
+ * "subList": {
6893
+ * "id": "5dc40d3f7e802c0f93f20232",
6894
+ * "name": "Live testing"
6895
+ * },
6896
+ * "assignedTo": [
6897
+ * {
6898
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6899
+ * "name": "Grace Hopper",
6900
+ * "userName": "grace",
6901
+ * "email": "grace@example.com",
6902
+ * "platformDetails": {
6903
+ * "name": "slack",
6904
+ * "imChannel": "D3EEXS3J6",
6905
+ * "selfChannel": "D1HN843U3",
6906
+ * "userId": "U0HBQESA1",
6907
+ * "teamId": "T0HBUA0TC"
6908
+ * },
6909
+ * "confirmed": true,
6910
+ * "avatar": "https://cdn.workast.io/avatar.png",
6911
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6912
+ * }
6913
+ * ],
6914
+ * "subscribers": [
6915
+ * {
6916
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6917
+ * "name": "Grace Hopper",
6918
+ * "userName": "grace",
6919
+ * "email": "grace@example.com",
6920
+ * "platformDetails": {
6921
+ * "name": "slack",
6922
+ * "imChannel": "D3EEXS3J6",
6923
+ * "selfChannel": "D1HN843U3",
6924
+ * "userId": "U0HBQESA1",
6925
+ * "teamId": "T0HBUA0TC"
6926
+ * },
6927
+ * "confirmed": true,
6928
+ * "avatar": "https://cdn.workast.io/avatar.png",
6929
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6930
+ * }
6931
+ * ],
6932
+ * "allDay": false,
6933
+ * "createdBy": {
6934
+ * "id": "4214932441cb21eebdb396bfe34a8340",
6935
+ * "name": "Grace Hopper",
6936
+ * "userName": "grace",
6937
+ * "email": "grace@example.com",
6938
+ * "platformDetails": {
6939
+ * "name": "slack",
6940
+ * "imChannel": "D3EEXS3J6",
6941
+ * "selfChannel": "D1HN843U3",
6942
+ * "userId": "U0HBQESA1",
6943
+ * "teamId": "T0HBUA0TC"
6944
+ * },
6945
+ * "confirmed": true,
6946
+ * "avatar": "https://cdn.workast.io/avatar.png",
6947
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
6948
+ * },
6949
+ * "hasDescription": true,
6950
+ * "numberOfComments": 0,
6951
+ * "numberOfAttachments": 0,
6952
+ * "totalSubTasks": 2,
6953
+ * "completedSubTasks": 2,
6954
+ * "isSubscribed": true,
6955
+ * "taskStatus": {
6956
+ * "id": "5c7184fa40721e2ed4175a6e",
6957
+ * "label": "Open",
6958
+ * "color": "#808080",
6959
+ * "createdAt": "2019-02-23T17:38:02.928Z",
6960
+ * "updatedAt": "2019-02-23T17:38:02.928Z"
6961
+ * },
6962
+ * "milestones": [],
6963
+ * "inHome": false,
6964
+ * "fields": []
6965
+ * }
6966
+ * ],
6967
+ * "total": 12,
6968
+ * "hiddenTasks": 0
6969
+ * }
6970
+ * }
6971
+ */
4816
6972
  SearchDetail: components["schemas"]["Search"] & {
4817
6973
  /** @description Matching tasks. Present when getTasks is set. */
4818
6974
  results?: components["schemas"]["SearchResults"];
4819
6975
  };
4820
- /** @description Paginated notes. Each item from Note.buildMinimalResource. */
6976
+ /**
6977
+ * @description Paginated notes. Each item from Note.buildMinimalResource.
6978
+ * @example {
6979
+ * "notes": [
6980
+ * {
6981
+ * "id": "6994a3e051b10d097caddd0f",
6982
+ * "title": "Ship v3",
6983
+ * "createdAt": "2026-02-17T17:22:40.359Z",
6984
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
6985
+ * "version": 58,
6986
+ * "list": {
6987
+ * "id": "6938534c1679f90979e5ccf4",
6988
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
6989
+ * "name": "Engineering",
6990
+ * "numberOfParticipants": 2,
6991
+ * "type": "group",
6992
+ * "slug": "engineering",
6993
+ * "privacy": "team",
6994
+ * "platformDetails": {
6995
+ * "type": "group"
6996
+ * },
6997
+ * "isArchived": false,
6998
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
6999
+ * "participants": [
7000
+ * "67c6206fc7cb0feb115113cdf71aa72d",
7001
+ * "4214932441cb21eebdb396bfe34a8340"
7002
+ * ],
7003
+ * "platformNotifications": {
7004
+ * "taskCreated": true,
7005
+ * "taskCompleted": true
7006
+ * },
7007
+ * "apps": [
7008
+ * {
7009
+ * "id": "5b23da45e7179a589282a60c",
7010
+ * "name": "Email",
7011
+ * "description": "Ship v3",
7012
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
7013
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7014
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
7015
+ * "accessType": "user",
7016
+ * "developedByWorkast": true,
7017
+ * "integration": {
7018
+ * "spaceActions": [
7019
+ * {
7020
+ * "actionId": "SHOW_SETTINGS",
7021
+ * "label": "Email"
7022
+ * }
7023
+ * ],
7024
+ * "taskActions": []
7025
+ * }
7026
+ * },
7027
+ * {
7028
+ * "name": "Example App",
7029
+ * "description": "Ship v3",
7030
+ * "icon": "https://cdn.workast.io/avatar.png",
7031
+ * "createdAt": "2019-10-06T22:30:33.687Z",
7032
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7033
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
7034
+ * "accessType": "user",
7035
+ * "developedByWorkast": true,
7036
+ * "id": "5d83a3de767119000151da7a"
7037
+ * }
7038
+ * ],
7039
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
7040
+ * "subLists": [
7041
+ * {
7042
+ * "id": "6938534c1679f90979e5ccf3",
7043
+ * "name": "To-do",
7044
+ * "listPosition": 100000,
7045
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7046
+ * },
7047
+ * {
7048
+ * "id": "693853701679f90979e5d186",
7049
+ * "name": "In Progress",
7050
+ * "listPosition": 200000,
7051
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7052
+ * }
7053
+ * ],
7054
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
7055
+ * "isParticipant": true,
7056
+ * "someParticipants": [
7057
+ * {
7058
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7059
+ * "name": "Katherine Johnson",
7060
+ * "userName": "katherine",
7061
+ * "email": "katherine@example.com",
7062
+ * "platformDetails": {
7063
+ * "name": "slack",
7064
+ * "imChannel": "D06JN8RT8KB",
7065
+ * "selfChannel": "D06HV290V6K",
7066
+ * "userId": "U06J9JSF6R0",
7067
+ * "teamId": "T0HBUA0TC"
7068
+ * },
7069
+ * "confirmed": false,
7070
+ * "avatar": "https://cdn.workast.io/avatar.png",
7071
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7072
+ * }
7073
+ * ],
7074
+ * "columns": [
7075
+ * "assignedTo",
7076
+ * "dueDate",
7077
+ * "doneBy",
7078
+ * "doneAt"
7079
+ * ],
7080
+ * "groupBy": "subList"
7081
+ * },
7082
+ * "createdBy": {
7083
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7084
+ * "name": "Katherine Johnson",
7085
+ * "userName": "katherine",
7086
+ * "email": "katherine@example.com",
7087
+ * "platformDetails": {
7088
+ * "name": "slack",
7089
+ * "imChannel": "D06JN8RT8KB",
7090
+ * "selfChannel": "D06HV290V6K",
7091
+ * "userId": "U06J9JSF6R0",
7092
+ * "teamId": "T0HBUA0TC"
7093
+ * },
7094
+ * "confirmed": false,
7095
+ * "avatar": "https://cdn.workast.io/avatar.png",
7096
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7097
+ * }
7098
+ * }
7099
+ * ],
7100
+ * "total": 168
7101
+ * }
7102
+ */
4821
7103
  Notes: {
4822
7104
  /**
4823
7105
  * @description Total records matched by the filters
@@ -4827,7 +7109,128 @@ interface components {
4827
7109
  /** @description Notes matching the filters */
4828
7110
  notes: components["schemas"]["Note"][];
4829
7111
  };
4830
- /** @description Minimal note. Built by Note.buildMinimalResource. */
7112
+ /**
7113
+ * @description Minimal note. Built by Note.buildMinimalResource.
7114
+ * @example {
7115
+ * "id": "6994a3e051b10d097caddd0f",
7116
+ * "title": "Ship v3",
7117
+ * "createdAt": "2026-02-17T17:22:40.359Z",
7118
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
7119
+ * "version": 58,
7120
+ * "list": {
7121
+ * "id": "6938534c1679f90979e5ccf4",
7122
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
7123
+ * "name": "Engineering",
7124
+ * "numberOfParticipants": 2,
7125
+ * "type": "group",
7126
+ * "slug": "engineering",
7127
+ * "privacy": "team",
7128
+ * "platformDetails": {
7129
+ * "type": "group"
7130
+ * },
7131
+ * "isArchived": false,
7132
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
7133
+ * "participants": [
7134
+ * "67c6206fc7cb0feb115113cdf71aa72d",
7135
+ * "4214932441cb21eebdb396bfe34a8340"
7136
+ * ],
7137
+ * "platformNotifications": {
7138
+ * "taskCreated": true,
7139
+ * "taskCompleted": true
7140
+ * },
7141
+ * "apps": [
7142
+ * {
7143
+ * "id": "5b23da45e7179a589282a60c",
7144
+ * "name": "Email",
7145
+ * "description": "Ship v3",
7146
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
7147
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7148
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
7149
+ * "accessType": "user",
7150
+ * "developedByWorkast": true,
7151
+ * "integration": {
7152
+ * "spaceActions": [
7153
+ * {
7154
+ * "actionId": "SHOW_SETTINGS",
7155
+ * "label": "Email"
7156
+ * }
7157
+ * ],
7158
+ * "taskActions": []
7159
+ * }
7160
+ * },
7161
+ * {
7162
+ * "name": "Example App",
7163
+ * "description": "Ship v3",
7164
+ * "icon": "https://cdn.workast.io/avatar.png",
7165
+ * "createdAt": "2019-10-06T22:30:33.687Z",
7166
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7167
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
7168
+ * "accessType": "user",
7169
+ * "developedByWorkast": true,
7170
+ * "id": "5d83a3de767119000151da7a"
7171
+ * }
7172
+ * ],
7173
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
7174
+ * "subLists": [
7175
+ * {
7176
+ * "id": "6938534c1679f90979e5ccf3",
7177
+ * "name": "To-do",
7178
+ * "listPosition": 100000,
7179
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7180
+ * },
7181
+ * {
7182
+ * "id": "693853701679f90979e5d186",
7183
+ * "name": "In Progress",
7184
+ * "listPosition": 200000,
7185
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7186
+ * }
7187
+ * ],
7188
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
7189
+ * "isParticipant": true,
7190
+ * "someParticipants": [
7191
+ * {
7192
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7193
+ * "name": "Katherine Johnson",
7194
+ * "userName": "katherine",
7195
+ * "email": "katherine@example.com",
7196
+ * "platformDetails": {
7197
+ * "name": "slack",
7198
+ * "imChannel": "D06JN8RT8KB",
7199
+ * "selfChannel": "D06HV290V6K",
7200
+ * "userId": "U06J9JSF6R0",
7201
+ * "teamId": "T0HBUA0TC"
7202
+ * },
7203
+ * "confirmed": false,
7204
+ * "avatar": "https://cdn.workast.io/avatar.png",
7205
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7206
+ * }
7207
+ * ],
7208
+ * "columns": [
7209
+ * "assignedTo",
7210
+ * "dueDate",
7211
+ * "doneBy",
7212
+ * "doneAt"
7213
+ * ],
7214
+ * "groupBy": "subList"
7215
+ * },
7216
+ * "createdBy": {
7217
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7218
+ * "name": "Katherine Johnson",
7219
+ * "userName": "katherine",
7220
+ * "email": "katherine@example.com",
7221
+ * "platformDetails": {
7222
+ * "name": "slack",
7223
+ * "imChannel": "D06JN8RT8KB",
7224
+ * "selfChannel": "D06HV290V6K",
7225
+ * "userId": "U06J9JSF6R0",
7226
+ * "teamId": "T0HBUA0TC"
7227
+ * },
7228
+ * "confirmed": false,
7229
+ * "avatar": "https://cdn.workast.io/avatar.png",
7230
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7231
+ * }
7232
+ * }
7233
+ */
4831
7234
  Note: {
4832
7235
  /** @description The note ID. */
4833
7236
  id?: string;
@@ -4850,7 +7253,129 @@ interface components {
4850
7253
  */
4851
7254
  updatedAt?: string;
4852
7255
  };
4853
- /** @description Full note. Built by Note.buildResource (buildMinimalResource plus body). */
7256
+ /**
7257
+ * @description Full note. Built by Note.buildResource (buildMinimalResource plus body).
7258
+ * @example {
7259
+ * "id": "6994a3e051b10d097caddd0f",
7260
+ * "title": "Ship v3",
7261
+ * "createdAt": "2026-02-17T17:22:40.359Z",
7262
+ * "updatedAt": "2026-02-23T22:00:53.158Z",
7263
+ * "version": 58,
7264
+ * "list": {
7265
+ * "id": "6938534c1679f90979e5ccf4",
7266
+ * "avatar": "https://cdn.workast.io/list-avatar.png",
7267
+ * "name": "Engineering",
7268
+ * "numberOfParticipants": 2,
7269
+ * "type": "group",
7270
+ * "slug": "engineering",
7271
+ * "privacy": "team",
7272
+ * "platformDetails": {
7273
+ * "type": "group"
7274
+ * },
7275
+ * "isArchived": false,
7276
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d",
7277
+ * "participants": [
7278
+ * "67c6206fc7cb0feb115113cdf71aa72d",
7279
+ * "4214932441cb21eebdb396bfe34a8340"
7280
+ * ],
7281
+ * "platformNotifications": {
7282
+ * "taskCreated": true,
7283
+ * "taskCompleted": true
7284
+ * },
7285
+ * "apps": [
7286
+ * {
7287
+ * "id": "5b23da45e7179a589282a60c",
7288
+ * "name": "Email",
7289
+ * "description": "Ship v3",
7290
+ * "icon": "https://cdn.workast.io/integrations/Email/icon.png",
7291
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7292
+ * "clientId": "Jr5LKksQ9PZhr89R3l93aaaaab",
7293
+ * "accessType": "user",
7294
+ * "developedByWorkast": true,
7295
+ * "integration": {
7296
+ * "spaceActions": [
7297
+ * {
7298
+ * "actionId": "SHOW_SETTINGS",
7299
+ * "label": "Email"
7300
+ * }
7301
+ * ],
7302
+ * "taskActions": []
7303
+ * }
7304
+ * },
7305
+ * {
7306
+ * "name": "Example App",
7307
+ * "description": "Ship v3",
7308
+ * "icon": "https://cdn.workast.io/avatar.png",
7309
+ * "createdAt": "2019-10-06T22:30:33.687Z",
7310
+ * "updatedAt": "2020-03-06T21:14:00.371Z",
7311
+ * "clientId": "S4GuidJp6frYrxLTuQBM5JoTug",
7312
+ * "accessType": "user",
7313
+ * "developedByWorkast": true,
7314
+ * "id": "5d83a3de767119000151da7a"
7315
+ * }
7316
+ * ],
7317
+ * "defaultSubList": "6938534c1679f90979e5ccf3",
7318
+ * "subLists": [
7319
+ * {
7320
+ * "id": "6938534c1679f90979e5ccf3",
7321
+ * "name": "To-do",
7322
+ * "listPosition": 100000,
7323
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7324
+ * },
7325
+ * {
7326
+ * "id": "693853701679f90979e5d186",
7327
+ * "name": "In Progress",
7328
+ * "listPosition": 200000,
7329
+ * "createdBy": "67c6206fc7cb0feb115113cdf71aa72d"
7330
+ * }
7331
+ * ],
7332
+ * "link": "https://app.workast.com/list/6938534c1679f90979e5ccf4",
7333
+ * "isParticipant": true,
7334
+ * "someParticipants": [
7335
+ * {
7336
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7337
+ * "name": "Katherine Johnson",
7338
+ * "userName": "katherine",
7339
+ * "email": "katherine@example.com",
7340
+ * "platformDetails": {
7341
+ * "name": "slack",
7342
+ * "imChannel": "D06JN8RT8KB",
7343
+ * "selfChannel": "D06HV290V6K",
7344
+ * "userId": "U06J9JSF6R0",
7345
+ * "teamId": "T0HBUA0TC"
7346
+ * },
7347
+ * "confirmed": false,
7348
+ * "avatar": "https://cdn.workast.io/avatar.png",
7349
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7350
+ * }
7351
+ * ],
7352
+ * "columns": [
7353
+ * "assignedTo",
7354
+ * "dueDate",
7355
+ * "doneBy",
7356
+ * "doneAt"
7357
+ * ],
7358
+ * "groupBy": "subList"
7359
+ * },
7360
+ * "createdBy": {
7361
+ * "id": "67c6206fc7cb0feb115113cdf71aa72d",
7362
+ * "name": "Katherine Johnson",
7363
+ * "userName": "katherine",
7364
+ * "email": "katherine@example.com",
7365
+ * "platformDetails": {
7366
+ * "name": "slack",
7367
+ * "imChannel": "D06JN8RT8KB",
7368
+ * "selfChannel": "D06HV290V6K",
7369
+ * "userId": "U06J9JSF6R0",
7370
+ * "teamId": "T0HBUA0TC"
7371
+ * },
7372
+ * "confirmed": false,
7373
+ * "avatar": "https://cdn.workast.io/avatar.png",
7374
+ * "costCenter": "5c1b92b0a57d2b342c1a610e"
7375
+ * },
7376
+ * "body": "<p>Ship v3</p>"
7377
+ * }
7378
+ */
4854
7379
  NoteDetail: components["schemas"]["Note"] & {
4855
7380
  /** @description HTML note content. Empty string when version is 0 or the S3 file is missing. */
4856
7381
  body: string;
@@ -4871,14 +7396,61 @@ interface components {
4871
7396
  name?: string;
4872
7397
  };
4873
7398
  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. */
7399
+ /**
7400
+ * @description Paginated workflows from GET /workflow. Each item from Workflow.buildResource.
7401
+ * @example {
7402
+ * "workflows": [
7403
+ * {
7404
+ * "id": "673b14ef1231f8099d5c96a4",
7405
+ * "trigger": {
7406
+ * "name": "event",
7407
+ * "value": "task_created"
7408
+ * },
7409
+ * "prompt": "Ship v3",
7410
+ * "lists": [
7411
+ * {
7412
+ * "id": "673b0b7b1231f8099d5ba067",
7413
+ * "type": "group",
7414
+ * "status": "archived",
7415
+ * "privacy": "team",
7416
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7417
+ * "name": "Engineering"
7418
+ * }
7419
+ * ],
7420
+ * "status": "active"
7421
+ * }
7422
+ * ],
7423
+ * "total": 11
7424
+ * }
7425
+ */
4875
7426
  Workflows: {
4876
7427
  /** @description Workflows created by the logged-in user, excluding removed. */
4877
7428
  workflows: components["schemas"]["Workflow"][];
4878
7429
  /** @description Total number of matching workflows. */
4879
7430
  total: number;
4880
7431
  };
4881
- /** @description Workflow.buildResource. */
7432
+ /**
7433
+ * @description Workflow.buildResource.
7434
+ * @example {
7435
+ * "id": "673b14ef1231f8099d5c96a4",
7436
+ * "trigger": {
7437
+ * "name": "event",
7438
+ * "value": "task_created"
7439
+ * },
7440
+ * "prompt": "Ship v3",
7441
+ * "lists": [
7442
+ * {
7443
+ * "id": "673b0b7b1231f8099d5ba067",
7444
+ * "type": "group",
7445
+ * "status": "archived",
7446
+ * "privacy": "team",
7447
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7448
+ * "name": "Engineering"
7449
+ * }
7450
+ * ],
7451
+ * "status": "active"
7452
+ * }
7453
+ */
4882
7454
  Workflow: {
4883
7455
  /** @description The workflow ID. */
4884
7456
  id: string;
@@ -4926,7 +7498,45 @@ interface components {
4926
7498
  /** @description Cron expression. Applied when the workflow trigger is cron. Maps to trigger.value on the workflow. */
4927
7499
  trigger?: string;
4928
7500
  };
4929
- /** @description GET /workflow/{workflowId} body. Workflow.buildResource plus paginated runs from WorkflowRun.buildResource. */
7501
+ /**
7502
+ * @description GET /workflow/{workflowId} body. Workflow.buildResource plus paginated runs from WorkflowRun.buildResource.
7503
+ * @example {
7504
+ * "id": "673b14ef1231f8099d5c96a4",
7505
+ * "trigger": {
7506
+ * "name": "event",
7507
+ * "value": "task_created"
7508
+ * },
7509
+ * "prompt": "Ship v3",
7510
+ * "lists": [
7511
+ * {
7512
+ * "id": "673b0b7b1231f8099d5ba067",
7513
+ * "type": "group",
7514
+ * "status": "archived",
7515
+ * "privacy": "team",
7516
+ * "link": "https://app.workast.com/list/673b0b7b1231f8099d5ba067",
7517
+ * "name": "Engineering"
7518
+ * }
7519
+ * ],
7520
+ * "status": "active",
7521
+ * "runs": [
7522
+ * {
7523
+ * "id": "673bffe012f608759e4bebca",
7524
+ * "result": "Ship v3",
7525
+ * "activity": {
7526
+ * "id": "673bffdc77ac5a0996dc537d",
7527
+ * "task": {
7528
+ * "id": "e1bb3fcad526680b6e7387e988fea1d9",
7529
+ * "text": "Ship v3",
7530
+ * "shortId": "T31UJ",
7531
+ * "link": "https://app.workast.com/task/e1bb3fcad526680b6e7387e988fea1d9"
7532
+ * }
7533
+ * },
7534
+ * "createdAt": "2024-11-19T03:02:56.261Z"
7535
+ * }
7536
+ * ],
7537
+ * "totalRuns": 4
7538
+ * }
7539
+ */
4930
7540
  WorkflowDetail: components["schemas"]["Workflow"] & {
4931
7541
  /** @description Workflow runs for this workflow. Each item from WorkflowRun.buildResource. */
4932
7542
  runs: components["schemas"]["WorkflowRun"][];
@@ -5332,9 +7942,7 @@ interface operations {
5332
7942
  [name: string]: unknown;
5333
7943
  };
5334
7944
  content: {
5335
- "application/json": components["schemas"]["UserDetail"] & {
5336
- team?: components["schemas"]["Team"];
5337
- };
7945
+ "application/json": components["schemas"]["UserDetailWithTeam"];
5338
7946
  };
5339
7947
  };
5340
7948
  /** @description Bad request */
@@ -7203,8 +9811,6 @@ interface operations {
7203
9811
  skip?: number;
7204
9812
  /** @description The sort criteria for returned Searches. Default is createdAt. */
7205
9813
  sort?: "createdAt" | "-createdAt" | "updatedAt" | "-updatedAt" | "name" | "-name";
7206
- /** @description Whether to only list the user's searches that are displayed in the home screen (favourites) or not. */
7207
- home?: boolean;
7208
9814
  };
7209
9815
  header?: never;
7210
9816
  path?: never;
@@ -7460,6 +10066,58 @@ interface operations {
7460
10066
  };
7461
10067
  };
7462
10068
  };
10069
+ findHomeSearches: {
10070
+ parameters: {
10071
+ query?: {
10072
+ /** @description The max number of Searches to return. */
10073
+ limit?: number;
10074
+ /** @description The number of Searches to skip in this search. */
10075
+ skip?: number;
10076
+ };
10077
+ header?: never;
10078
+ path?: never;
10079
+ cookie?: never;
10080
+ };
10081
+ requestBody?: never;
10082
+ responses: {
10083
+ /** @description The home searches. */
10084
+ 200: {
10085
+ headers: {
10086
+ [name: string]: unknown;
10087
+ };
10088
+ content: {
10089
+ "application/json": components["schemas"]["Searches"];
10090
+ };
10091
+ };
10092
+ /** @description Unauthorized */
10093
+ 401: {
10094
+ headers: {
10095
+ [name: string]: unknown;
10096
+ };
10097
+ content: {
10098
+ "application/json": components["schemas"]["401Error"];
10099
+ };
10100
+ };
10101
+ /** @description Forbidden */
10102
+ 403: {
10103
+ headers: {
10104
+ [name: string]: unknown;
10105
+ };
10106
+ content: {
10107
+ "application/json": components["schemas"]["403Error"];
10108
+ };
10109
+ };
10110
+ /** @description Unexpected error */
10111
+ default: {
10112
+ headers: {
10113
+ [name: string]: unknown;
10114
+ };
10115
+ content: {
10116
+ "application/json": components["schemas"]["500Error"];
10117
+ };
10118
+ };
10119
+ };
10120
+ };
7463
10121
  getSearch: {
7464
10122
  parameters: {
7465
10123
  query?: {
@@ -9127,6 +11785,67 @@ interface operations {
9127
11785
  };
9128
11786
  };
9129
11787
  };
11788
+ createPersonalListTask: {
11789
+ parameters: {
11790
+ query?: never;
11791
+ header?: never;
11792
+ path?: never;
11793
+ cookie?: never;
11794
+ };
11795
+ /** @description The task details */
11796
+ requestBody: {
11797
+ content: {
11798
+ "application/json": components["schemas"]["TaskCreate"];
11799
+ };
11800
+ };
11801
+ responses: {
11802
+ /** @description The created task */
11803
+ 201: {
11804
+ headers: {
11805
+ [name: string]: unknown;
11806
+ };
11807
+ content: {
11808
+ "application/json": components["schemas"]["Task"];
11809
+ };
11810
+ };
11811
+ /** @description Bad request */
11812
+ 400: {
11813
+ headers: {
11814
+ [name: string]: unknown;
11815
+ };
11816
+ content: {
11817
+ "application/json": components["schemas"]["400Error"];
11818
+ };
11819
+ };
11820
+ /** @description Unauthorized */
11821
+ 401: {
11822
+ headers: {
11823
+ [name: string]: unknown;
11824
+ };
11825
+ content: {
11826
+ "application/json": components["schemas"]["401Error"];
11827
+ };
11828
+ };
11829
+ /** @description Forbidden */
11830
+ 403: {
11831
+ headers: {
11832
+ [name: string]: unknown;
11833
+ };
11834
+ content: {
11835
+ "application/json": components["schemas"]["403Error"];
11836
+ };
11837
+ };
11838
+ /** @description Unexpected error */
11839
+ default: {
11840
+ headers: {
11841
+ [name: string]: unknown;
11842
+ };
11843
+ content: {
11844
+ "application/json": components["schemas"]["500Error"];
11845
+ };
11846
+ };
11847
+ };
11848
+ };
9130
11849
  getListParticipants: {
9131
11850
  parameters: {
9132
11851
  query?: never;
@@ -9892,6 +12611,84 @@ interface operations {
9892
12611
  };
9893
12612
  };
9894
12613
  };
12614
+ createNote: {
12615
+ parameters: {
12616
+ query?: never;
12617
+ header?: never;
12618
+ path: {
12619
+ /** @description The list ID */
12620
+ listId: string;
12621
+ };
12622
+ cookie?: never;
12623
+ };
12624
+ requestBody?: {
12625
+ content: {
12626
+ "application/json": {
12627
+ /**
12628
+ * @description The note title
12629
+ * @example Action Items
12630
+ */
12631
+ title?: string;
12632
+ };
12633
+ };
12634
+ };
12635
+ responses: {
12636
+ /** @description The Note was created successfully. */
12637
+ 201: {
12638
+ headers: {
12639
+ [name: string]: unknown;
12640
+ };
12641
+ content: {
12642
+ "application/json": components["schemas"]["Note"];
12643
+ };
12644
+ };
12645
+ /** @description Bad request. */
12646
+ 400: {
12647
+ headers: {
12648
+ [name: string]: unknown;
12649
+ };
12650
+ content: {
12651
+ "application/json": components["schemas"]["400Error"];
12652
+ };
12653
+ };
12654
+ /** @description Unauthorized */
12655
+ 401: {
12656
+ headers: {
12657
+ [name: string]: unknown;
12658
+ };
12659
+ content: {
12660
+ "application/json": components["schemas"]["401Error"];
12661
+ };
12662
+ };
12663
+ /** @description Forbidden */
12664
+ 403: {
12665
+ headers: {
12666
+ [name: string]: unknown;
12667
+ };
12668
+ content: {
12669
+ "application/json": components["schemas"]["403Error"];
12670
+ };
12671
+ };
12672
+ /** @description List not found. */
12673
+ 404: {
12674
+ headers: {
12675
+ [name: string]: unknown;
12676
+ };
12677
+ content: {
12678
+ "application/json": components["schemas"]["404Error"];
12679
+ };
12680
+ };
12681
+ /** @description Unexpected error */
12682
+ default: {
12683
+ headers: {
12684
+ [name: string]: unknown;
12685
+ };
12686
+ content: {
12687
+ "application/json": components["schemas"]["500Error"];
12688
+ };
12689
+ };
12690
+ };
12691
+ };
9895
12692
  getNotes: {
9896
12693
  parameters: {
9897
12694
  query?: {
@@ -12355,7 +15152,7 @@ interface operations {
12355
15152
 
12356
15153
  /**
12357
15154
  * This file was generated by scripts/generate-types.mjs. Do not edit.
12358
- * Source swagger SHA-256: be9f451bbac4f67dfe07c4aeca0574d2d7eb021b16ac465d15fdd91b76cfbccc
15155
+ * Source swagger SHA-256: 960f8629333a3f09cac00abc7fc8fb7d68c165cac7a216639e536d9c6af24c04
12359
15156
  */
12360
15157
 
12361
15158
  type ActivityBody = components["schemas"]["ActivityBody"];
@@ -12435,6 +15232,7 @@ type TokenTeam = components["schemas"]["TokenTeam"];
12435
15232
  type TokenUser = components["schemas"]["TokenUser"];
12436
15233
  type User = components["schemas"]["User"];
12437
15234
  type UserDetail = components["schemas"]["UserDetail"];
15235
+ type UserDetailWithTeam = components["schemas"]["UserDetailWithTeam"];
12438
15236
  type UserInvite = components["schemas"]["UserInvite"];
12439
15237
  type UserResource = components["schemas"]["UserResource"];
12440
15238
  type Workflow = components["schemas"]["Workflow"];
@@ -12460,12 +15258,14 @@ type TaskActivitySearchQuery = NonNullable<paths["/task/{taskId}/activity"]["get
12460
15258
  type UserByEmailQuery = NonNullable<paths["/user/email/{email}"]["get"]["parameters"]["query"]>;
12461
15259
  type UserSearchQuery = NonNullable<paths["/user"]["get"]["parameters"]["query"]>;
12462
15260
  type WorkflowSearchQuery = NonNullable<paths["/workflow"]["get"]["parameters"]["query"]>;
15261
+ type FindHomeSearchesQuery = NonNullable<paths["/search/home"]["get"]["parameters"]["query"]>;
12463
15262
 
12464
15263
  declare class Attachments {
12465
15264
  private readonly client;
12466
15265
  constructor(client: Workast);
12467
15266
  /**
12468
15267
  * Get a signed URL to download an attachment file.
15268
+ * Requires `file:find`.
12469
15269
  *
12470
15270
  * @example
12471
15271
  * const attachment = await workast.attachments.retrieveFileUrl('attachment-id');
@@ -12478,6 +15278,7 @@ declare class CalendarEventsResource {
12478
15278
  constructor(client: Workast);
12479
15279
  /**
12480
15280
  * List user calendar events.
15281
+ * Requires `calendar:find`.
12481
15282
  *
12482
15283
  * @example
12483
15284
  * const results = await workast.calendar.events.list({ from: '2025-10-29', to: '2025-11-05' });
@@ -12494,6 +15295,7 @@ declare class Fields {
12494
15295
  constructor(client: Workast);
12495
15296
  /**
12496
15297
  * List custom fields in the team.
15298
+ * Requires one of: `field:find` (least privilege) or `field:manage`.
12497
15299
  *
12498
15300
  * @example
12499
15301
  * const fields = await workast.fields.list({ listId: 'list-id' });
@@ -12501,6 +15303,7 @@ declare class Fields {
12501
15303
  list(query?: CustomFieldSearchQuery, options?: RequestOptions): Promise<CustomField[]>;
12502
15304
  /**
12503
15305
  * Create a custom field.
15306
+ * Requires `field:manage`.
12504
15307
  *
12505
15308
  * @example
12506
15309
  * const field = await workast.fields.create({ name: 'Priority', type: 'text' });
@@ -12508,6 +15311,7 @@ declare class Fields {
12508
15311
  create(body: CustomFieldCreate, options?: RequestOptions): Promise<CustomField>;
12509
15312
  /**
12510
15313
  * Update a custom field.
15314
+ * Requires `field:manage`.
12511
15315
  *
12512
15316
  * @example
12513
15317
  * const field = await workast.fields.update('field-id', { name: 'Priority' });
@@ -12515,6 +15319,7 @@ declare class Fields {
12515
15319
  update(fieldId: string, body: CustomFieldPatch, options?: RequestOptions): Promise<CustomField>;
12516
15320
  /**
12517
15321
  * Remove a custom field.
15322
+ * Requires `field:manage`.
12518
15323
  *
12519
15324
  * @example
12520
15325
  * await workast.fields.del('field-id');
@@ -12527,6 +15332,7 @@ declare class ListSublists {
12527
15332
  constructor(client: Workast);
12528
15333
  /**
12529
15334
  * List unique sublist names across lists.
15335
+ * Requires one of: `list:find` (least privilege) or `list:manage`.
12530
15336
  *
12531
15337
  * @example
12532
15338
  * const names = await workast.lists.sublists.list({ types: ['group'] });
@@ -12534,6 +15340,7 @@ declare class ListSublists {
12534
15340
  list(query?: SubListSearchQuery, options?: RequestOptions): Promise<string[]>;
12535
15341
  /**
12536
15342
  * Create a sublist in a list.
15343
+ * Requires one of: `list:create` (least privilege) or `list:manage`.
12537
15344
  *
12538
15345
  * @example
12539
15346
  * const sublist = await workast.lists.sublists.create('list-id', { name: 'To-do' });
@@ -12541,6 +15348,7 @@ declare class ListSublists {
12541
15348
  create(listId: string, body: SubListCreate, options?: RequestOptions): Promise<SubList>;
12542
15349
  /**
12543
15350
  * Update a sublist.
15351
+ * Requires one of: `list:update` (least privilege) or `list:manage`.
12544
15352
  *
12545
15353
  * @example
12546
15354
  * await workast.lists.sublists.update('list-id', 'sublist-id', { name: 'Done' });
@@ -12548,6 +15356,7 @@ declare class ListSublists {
12548
15356
  update(listId: string, subListId: string, body: SubListPatch, options?: RequestOptions): Promise<void>;
12549
15357
  /**
12550
15358
  * Remove a sublist.
15359
+ * Requires one of: `list:update` (least privilege) or `list:manage`.
12551
15360
  *
12552
15361
  * @example
12553
15362
  * await workast.lists.sublists.del('list-id', 'sublist-id');
@@ -12559,6 +15368,7 @@ declare class ListParticipantsResource {
12559
15368
  constructor(client: Workast);
12560
15369
  /**
12561
15370
  * List participants on a list.
15371
+ * Requires one of: `list:participant:find` (least privilege) or `list:manage`.
12562
15372
  *
12563
15373
  * @example
12564
15374
  * const users = await workast.lists.participants.list('list-id');
@@ -12566,6 +15376,7 @@ declare class ListParticipantsResource {
12566
15376
  list(listId: string, options?: RequestOptions): Promise<User[]>;
12567
15377
  /**
12568
15378
  * Add participants to a list.
15379
+ * Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
12569
15380
  *
12570
15381
  * @example
12571
15382
  * await workast.lists.participants.add('list-id', { users: ['user-id'] });
@@ -12573,6 +15384,7 @@ declare class ListParticipantsResource {
12573
15384
  add(listId: string, body: ListParticipants, options?: RequestOptions): Promise<void>;
12574
15385
  /**
12575
15386
  * Remove participants from a list.
15387
+ * Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
12576
15388
  *
12577
15389
  * @example
12578
15390
  * await workast.lists.participants.del('list-id', { users: ['user-id'] });
@@ -12584,6 +15396,7 @@ declare class ListFields {
12584
15396
  constructor(client: Workast);
12585
15397
  /**
12586
15398
  * Enable a custom field on a list.
15399
+ * Requires `field:manage`.
12587
15400
  *
12588
15401
  * @example
12589
15402
  * await workast.lists.fields.enable('list-id', 'field-id');
@@ -12591,6 +15404,7 @@ declare class ListFields {
12591
15404
  enable(listId: string, fieldId: string, options?: RequestOptions): Promise<void>;
12592
15405
  /**
12593
15406
  * Disable a custom field on a list.
15407
+ * Requires `field:manage`.
12594
15408
  *
12595
15409
  * @example
12596
15410
  * await workast.lists.fields.disable('list-id', 'field-id');
@@ -12605,6 +15419,7 @@ declare class Lists {
12605
15419
  constructor(client: Workast);
12606
15420
  /**
12607
15421
  * Create a list.
15422
+ * Requires one of: `list:create` (least privilege) or `list:manage`.
12608
15423
  *
12609
15424
  * @example
12610
15425
  * const list = await workast.lists.create({ name: 'Engineering' });
@@ -12612,6 +15427,7 @@ declare class Lists {
12612
15427
  create(body: ListCreate, options?: RequestOptions): Promise<List>;
12613
15428
  /**
12614
15429
  * Get a list by ID.
15430
+ * Requires one of: `list:find` (least privilege) or `list:manage`.
12615
15431
  *
12616
15432
  * @example
12617
15433
  * const list = await workast.lists.retrieve('list-id');
@@ -12619,6 +15435,7 @@ declare class Lists {
12619
15435
  retrieve(listId: string, options?: RequestOptions): Promise<List>;
12620
15436
  /**
12621
15437
  * Update a list.
15438
+ * Requires one of: `list:update` (least privilege) or `list:manage`.
12622
15439
  *
12623
15440
  * @example
12624
15441
  * await workast.lists.update('list-id', { name: 'Engineering' });
@@ -12626,6 +15443,7 @@ declare class Lists {
12626
15443
  update(listId: string, body: ListPatch, options?: RequestOptions): Promise<void>;
12627
15444
  /**
12628
15445
  * Search lists.
15446
+ * Requires one of: `list:find` (least privilege) or `list:manage`.
12629
15447
  *
12630
15448
  * @example
12631
15449
  * const lists = await workast.lists.list({ type: 'group', limit: 10 });
@@ -12633,6 +15451,7 @@ declare class Lists {
12633
15451
  list(query?: ListSearchQuery, options?: RequestOptions): Promise<ListEnumerate[]>;
12634
15452
  /**
12635
15453
  * Get the personal list.
15454
+ * Requires one of: `list:find` (least privilege) or `list:manage`.
12636
15455
  *
12637
15456
  * @example
12638
15457
  * const list = await workast.lists.retrievePersonal();
@@ -12640,6 +15459,7 @@ declare class Lists {
12640
15459
  retrievePersonal(options?: RequestOptions): Promise<List>;
12641
15460
  /**
12642
15461
  * Archive a list.
15462
+ * Requires `list:manage`.
12643
15463
  *
12644
15464
  * @example
12645
15465
  * await workast.lists.archive('list-id');
@@ -12647,6 +15467,7 @@ declare class Lists {
12647
15467
  archive(listId: string, options?: RequestOptions): Promise<void>;
12648
15468
  /**
12649
15469
  * Unarchive a list.
15470
+ * Requires `list:manage`.
12650
15471
  *
12651
15472
  * @example
12652
15473
  * await workast.lists.unarchive('list-id');
@@ -12654,6 +15475,7 @@ declare class Lists {
12654
15475
  unarchive(listId: string, options?: RequestOptions): Promise<void>;
12655
15476
  /**
12656
15477
  * Join a list.
15478
+ * Requires `list:join`.
12657
15479
  *
12658
15480
  * @example
12659
15481
  * await workast.lists.join('list-id');
@@ -12661,6 +15483,7 @@ declare class Lists {
12661
15483
  join(listId: string, options?: RequestOptions): Promise<void>;
12662
15484
  /**
12663
15485
  * Request access to a private list.
15486
+ * Requires `list:join`.
12664
15487
  *
12665
15488
  * @example
12666
15489
  * await workast.lists.requestAccess('list-id');
@@ -12668,6 +15491,7 @@ declare class Lists {
12668
15491
  requestAccess(listId: string, options?: RequestOptions): Promise<void>;
12669
15492
  /**
12670
15493
  * Import a template into a list.
15494
+ * Requires one of: `task:create` (least privilege) or `task:manage`.
12671
15495
  *
12672
15496
  * @example
12673
15497
  * await workast.lists.importTemplate('list-id', 'template-id', { updateDueDates: 30 });
@@ -12680,6 +15504,7 @@ declare class MeetingsResource {
12680
15504
  constructor(client: Workast);
12681
15505
  /**
12682
15506
  * List meetings.
15507
+ * Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
12683
15508
  *
12684
15509
  * @example
12685
15510
  * const results = await workast.meetings.list({ timeMin: '2026-01-01T00:00:00Z', maxResults: 15 });
@@ -12687,6 +15512,7 @@ declare class MeetingsResource {
12687
15512
  list(query?: MeetingSearchQuery, options?: RequestOptions): Promise<Meetings>;
12688
15513
  /**
12689
15514
  * Create a meeting from a calendar event, or create a new calendar event.
15515
+ * Requires `meeting:manage`.
12690
15516
  *
12691
15517
  * @example
12692
15518
  * const meeting = await workast.meetings.createFromEvent({
@@ -12698,6 +15524,7 @@ declare class MeetingsResource {
12698
15524
  createFromEvent(body: MeetingCreate, options?: RequestOptions): Promise<Meeting>;
12699
15525
  /**
12700
15526
  * Get a meeting by ID.
15527
+ * Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
12701
15528
  *
12702
15529
  * @example
12703
15530
  * const meeting = await workast.meetings.retrieve('meeting-id');
@@ -12705,6 +15532,7 @@ declare class MeetingsResource {
12705
15532
  retrieve(meetingId: string, options?: RequestOptions): Promise<MeetingDetail>;
12706
15533
  /**
12707
15534
  * Update meeting notes.
15535
+ * Requires `meeting:manage`.
12708
15536
  *
12709
15537
  * @example
12710
15538
  * const meeting = await workast.meetings.update('meeting-id', { notes: 'Ship v3' });
@@ -12712,6 +15540,7 @@ declare class MeetingsResource {
12712
15540
  update(meetingId: string, body: MeetingPatch, options?: RequestOptions): Promise<MeetingDetail>;
12713
15541
  /**
12714
15542
  * Get meeting recording assets and transcript.
15543
+ * Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
12715
15544
  *
12716
15545
  * @example
12717
15546
  * const recording = await workast.meetings.retrieveRecording('meeting-id');
@@ -12719,6 +15548,7 @@ declare class MeetingsResource {
12719
15548
  retrieveRecording(meetingId: string, options?: RequestOptions): Promise<MeetingRecordingResource>;
12720
15549
  /**
12721
15550
  * Enable the notetaker for a meeting.
15551
+ * Requires `meeting:manage`.
12722
15552
  *
12723
15553
  * @example
12724
15554
  * const meeting = await workast.meetings.enableNotetaker('meeting-id', {
@@ -12728,6 +15558,7 @@ declare class MeetingsResource {
12728
15558
  enableNotetaker(meetingId: string, body?: MeetingNotetakerEnable, options?: RequestOptions): Promise<Meeting>;
12729
15559
  /**
12730
15560
  * Disable or remove the notetaker from a meeting.
15561
+ * Requires `meeting:manage`.
12731
15562
  *
12732
15563
  * @example
12733
15564
  * const meeting = await workast.meetings.disableNotetaker('meeting-id');
@@ -12740,6 +15571,7 @@ declare class NotesResource {
12740
15571
  constructor(client: Workast);
12741
15572
  /**
12742
15573
  * List notes.
15574
+ * Requires one of: `note:find` (least privilege) or `note:manage`.
12743
15575
  *
12744
15576
  * @example
12745
15577
  * const results = await workast.notes.list({ title: 'Spec', limit: 10 });
@@ -12747,6 +15579,7 @@ declare class NotesResource {
12747
15579
  list(query?: NoteSearchQuery, options?: RequestOptions): Promise<Notes>;
12748
15580
  /**
12749
15581
  * Get a note by ID.
15582
+ * Requires one of: `note:find` (least privilege) or `note:manage`.
12750
15583
  *
12751
15584
  * @example
12752
15585
  * const note = await workast.notes.retrieve('note-id');
@@ -12754,6 +15587,7 @@ declare class NotesResource {
12754
15587
  retrieve(noteId: string, options?: RequestOptions): Promise<NoteDetail>;
12755
15588
  /**
12756
15589
  * Update a note.
15590
+ * Requires one of: `note:update` (least privilege) or `note:manage`.
12757
15591
  *
12758
15592
  * @example
12759
15593
  * const note = await workast.notes.update('note-id', { title: 'Spec', version: 1, body: '<p>Hello</p>' });
@@ -12761,6 +15595,7 @@ declare class NotesResource {
12761
15595
  update(noteId: string, body: NotePatch, options?: RequestOptions): Promise<Note>;
12762
15596
  /**
12763
15597
  * Delete a note.
15598
+ * Requires `note:manage`.
12764
15599
  *
12765
15600
  * @example
12766
15601
  * await workast.notes.del('note-id');
@@ -12773,6 +15608,7 @@ declare class NotificationsResource {
12773
15608
  constructor(client: Workast);
12774
15609
  /**
12775
15610
  * List notifications for the logged-in user.
15611
+ * Requires one of: `notification:find` (least privilege) or `notification:manage`.
12776
15612
  *
12777
15613
  * @example
12778
15614
  * const results = await workast.notifications.list({ read: false, limit: 10 });
@@ -12780,6 +15616,7 @@ declare class NotificationsResource {
12780
15616
  list(query?: NotificationSearchQuery, options?: RequestOptions): Promise<Notifications>;
12781
15617
  /**
12782
15618
  * Mark a notification as read.
15619
+ * Requires `notification:manage`.
12783
15620
  *
12784
15621
  * @example
12785
15622
  * await workast.notifications.markRead('notification-id');
@@ -12787,6 +15624,7 @@ declare class NotificationsResource {
12787
15624
  markRead(notificationId: string, options?: RequestOptions): Promise<void>;
12788
15625
  /**
12789
15626
  * Mark a notification as unread.
15627
+ * Requires `notification:manage`.
12790
15628
  *
12791
15629
  * @example
12792
15630
  * await workast.notifications.markUnread('notification-id');
@@ -12799,6 +15637,7 @@ declare class Reactions {
12799
15637
  constructor(client: Workast);
12800
15638
  /**
12801
15639
  * Add a reaction to an activity.
15640
+ * Requires one of: `activity:react` (least privilege) or `task:manage`.
12802
15641
  *
12803
15642
  * @example
12804
15643
  * const reaction = await workast.reactions.add('activity-id', { emoji: ':+1:' });
@@ -12806,6 +15645,7 @@ declare class Reactions {
12806
15645
  add(activityId: string, body: ReactionCreate, options?: RequestOptions): Promise<ReactionReadOnly>;
12807
15646
  /**
12808
15647
  * Remove a reaction from an activity.
15648
+ * Requires one of: `activity:react` (least privilege) or `task:manage`.
12809
15649
  *
12810
15650
  * @example
12811
15651
  * await workast.reactions.del('activity-id', 'reaction-id');
@@ -12818,13 +15658,15 @@ declare class SearchesResource {
12818
15658
  constructor(client: Workast);
12819
15659
  /**
12820
15660
  * List searches for the logged-in user.
15661
+ * Requires one of: `search:find` (least privilege) or `search:manage`.
12821
15662
  *
12822
15663
  * @example
12823
- * const results = await workast.searches.list({ home: true, limit: 10 });
15664
+ * const results = await workast.searches.list({ limit: 10 });
12824
15665
  */
12825
15666
  list(query?: SearchFindQuery, options?: RequestOptions): Promise<Searches>;
12826
15667
  /**
12827
15668
  * Create a search.
15669
+ * Requires `search:manage`.
12828
15670
  *
12829
15671
  * @example
12830
15672
  * const search = await workast.searches.create({
@@ -12835,6 +15677,7 @@ declare class SearchesResource {
12835
15677
  create(body: SearchCreate, options?: RequestOptions): Promise<Search>;
12836
15678
  /**
12837
15679
  * Get a search by ID.
15680
+ * Requires one of: `search:find` (least privilege) or `search:manage`.
12838
15681
  *
12839
15682
  * @example
12840
15683
  * const search = await workast.searches.retrieve('search-id');
@@ -12842,6 +15685,7 @@ declare class SearchesResource {
12842
15685
  retrieve(searchId: string, query?: SearchRetrieveQuery, options?: RequestOptions): Promise<SearchDetail>;
12843
15686
  /**
12844
15687
  * Update a search.
15688
+ * Requires `search:manage`.
12845
15689
  *
12846
15690
  * @example
12847
15691
  * const search = await workast.searches.update('search-id', { name: 'Updated' });
@@ -12849,13 +15693,23 @@ declare class SearchesResource {
12849
15693
  update(searchId: string, body: SearchPatch, options?: RequestOptions): Promise<Search>;
12850
15694
  /**
12851
15695
  * Delete a search.
15696
+ * Requires `search:manage`.
12852
15697
  *
12853
15698
  * @example
12854
15699
  * await workast.searches.del('search-id');
12855
15700
  */
12856
15701
  del(searchId: string, options?: RequestOptions): Promise<void>;
15702
+ /**
15703
+ * List searches pinned on the home screen.
15704
+ * Requires one of: `home:search:find` (least privilege) or `home:search:manage`.
15705
+ *
15706
+ * @example
15707
+ * const results = await workast.searches.listHome({ limit: 10 });
15708
+ */
15709
+ listHome(query?: FindHomeSearchesQuery, options?: RequestOptions): Promise<Searches>;
12857
15710
  /**
12858
15711
  * Add a search to the home screen.
15712
+ * Requires `home:search:manage`.
12859
15713
  *
12860
15714
  * @example
12861
15715
  * await workast.searches.addHome('search-id');
@@ -12863,6 +15717,7 @@ declare class SearchesResource {
12863
15717
  addHome(searchId: string, options?: RequestOptions): Promise<void>;
12864
15718
  /**
12865
15719
  * Remove a search from the home screen.
15720
+ * Requires `home:search:manage`.
12866
15721
  *
12867
15722
  * @example
12868
15723
  * await workast.searches.removeHome('search-id');
@@ -12870,6 +15725,7 @@ declare class SearchesResource {
12870
15725
  removeHome(searchId: string, options?: RequestOptions): Promise<void>;
12871
15726
  /**
12872
15727
  * Share a search with users.
15728
+ * Requires `search:manage`.
12873
15729
  *
12874
15730
  * @example
12875
15731
  * await workast.searches.share('search-id', { users: ['user-id'] });
@@ -12877,6 +15733,7 @@ declare class SearchesResource {
12877
15733
  share(searchId: string, body: SearchShare, options?: RequestOptions): Promise<void>;
12878
15734
  /**
12879
15735
  * Unshare a search from users.
15736
+ * Requires `search:manage`.
12880
15737
  *
12881
15738
  * @example
12882
15739
  * await workast.searches.unshare('search-id', { users: ['user-id'] });
@@ -12884,6 +15741,7 @@ declare class SearchesResource {
12884
15741
  unshare(searchId: string, body: SearchShare, options?: RequestOptions): Promise<void>;
12885
15742
  /**
12886
15743
  * Set a reminder on a search.
15744
+ * Requires `search:manage`.
12887
15745
  *
12888
15746
  * @example
12889
15747
  * await workast.searches.setReminder('search-id', {
@@ -12893,6 +15751,7 @@ declare class SearchesResource {
12893
15751
  setReminder(searchId: string, body: SearchReminderSet, options?: RequestOptions): Promise<void>;
12894
15752
  /**
12895
15753
  * Delete a reminder from a search.
15754
+ * Requires `search:manage`.
12896
15755
  *
12897
15756
  * @example
12898
15757
  * await workast.searches.delReminder('search-id');
@@ -12905,6 +15764,7 @@ declare class Tags {
12905
15764
  constructor(client: Workast);
12906
15765
  /**
12907
15766
  * List tags in the team.
15767
+ * Requires one of: `tag:find` (least privilege) or `tag:manage`.
12908
15768
  *
12909
15769
  * @example
12910
15770
  * const tags = await workast.tags.list({ listId: 'list-id' });
@@ -12912,6 +15772,7 @@ declare class Tags {
12912
15772
  list(query?: TagSearchQuery, options?: RequestOptions): Promise<Tag[]>;
12913
15773
  /**
12914
15774
  * Create a tag.
15775
+ * Requires `tag:manage`.
12915
15776
  *
12916
15777
  * @example
12917
15778
  * const tag = await workast.tags.create({ name: 'Priority', color: '#ff0000' });
@@ -12919,6 +15780,7 @@ declare class Tags {
12919
15780
  create(body: TagCreate, options?: RequestOptions): Promise<Tag>;
12920
15781
  /**
12921
15782
  * Update a tag.
15783
+ * Requires `tag:manage`.
12922
15784
  *
12923
15785
  * @example
12924
15786
  * const tag = await workast.tags.update('tag-id', { name: 'Priority' });
@@ -12926,6 +15788,7 @@ declare class Tags {
12926
15788
  update(tagId: string, body: TagPatch, options?: RequestOptions): Promise<Tag>;
12927
15789
  /**
12928
15790
  * Delete a tag.
15791
+ * Requires `tag:manage`.
12929
15792
  *
12930
15793
  * @example
12931
15794
  * await workast.tags.del('tag-id');
@@ -12938,6 +15801,7 @@ declare class TaskSubtasks {
12938
15801
  constructor(client: Workast);
12939
15802
  /**
12940
15803
  * Create a subtask on a task.
15804
+ * Requires one of: `task:create` (least privilege) or `task:manage`.
12941
15805
  *
12942
15806
  * @example
12943
15807
  * const subtask = await workast.tasks.subtasks.create('task-id', { text: 'Write tests' });
@@ -12949,6 +15813,7 @@ declare class TaskDependencies {
12949
15813
  constructor(client: Workast);
12950
15814
  /**
12951
15815
  * Add a dependency to a task.
15816
+ * Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
12952
15817
  *
12953
15818
  * @example
12954
15819
  * await workast.tasks.dependencies.add('task-id', 'dependency-id');
@@ -12956,6 +15821,7 @@ declare class TaskDependencies {
12956
15821
  add(taskId: string, dependencyId: string, options?: RequestOptions): Promise<void>;
12957
15822
  /**
12958
15823
  * Remove a dependency from a task.
15824
+ * Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
12959
15825
  *
12960
15826
  * @example
12961
15827
  * await workast.tasks.dependencies.del('task-id', 'dependency-id');
@@ -12967,6 +15833,7 @@ declare class TaskAttachments {
12967
15833
  constructor(client: Workast);
12968
15834
  /**
12969
15835
  * Create an attachment on a task.
15836
+ * Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
12970
15837
  *
12971
15838
  * @example
12972
15839
  * const attachment = await workast.tasks.attachments.create('task-id', { author: 'user-id' });
@@ -12974,6 +15841,7 @@ declare class TaskAttachments {
12974
15841
  create(taskId: string, body: NewAttachment, options?: RequestOptions): Promise<Attachment>;
12975
15842
  /**
12976
15843
  * Update a task attachment.
15844
+ * Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
12977
15845
  *
12978
15846
  * @example
12979
15847
  * const attachment = await workast.tasks.attachments.update('task-id', 'attachment-id', { date: '2026-01-01' });
@@ -12981,6 +15849,7 @@ declare class TaskAttachments {
12981
15849
  update(taskId: string, attachmentId: string, body: NewAttachment, options?: RequestOptions): Promise<Attachment>;
12982
15850
  /**
12983
15851
  * Delete a task attachment.
15852
+ * Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
12984
15853
  *
12985
15854
  * @example
12986
15855
  * await workast.tasks.attachments.del('task-id', 'attachment-id');
@@ -12992,6 +15861,7 @@ declare class TaskActivitiesResource {
12992
15861
  constructor(client: Workast);
12993
15862
  /**
12994
15863
  * List activities on a task.
15864
+ * Requires one of: `task:activity:find` (least privilege) or `task:manage`.
12995
15865
  *
12996
15866
  * @example
12997
15867
  * const results = await workast.tasks.activities.list('task-id', { type: ['comment'], limit: 10 });
@@ -12999,6 +15869,7 @@ declare class TaskActivitiesResource {
12999
15869
  list(taskId: string, query?: TaskActivitySearchQuery, options?: RequestOptions): Promise<TaskActivities>;
13000
15870
  /**
13001
15871
  * Create a comment activity on a task.
15872
+ * Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
13002
15873
  *
13003
15874
  * @example
13004
15875
  * const activity = await workast.tasks.activities.create('task-id', { type: 'comment', value: 'Looks good' });
@@ -13006,6 +15877,7 @@ declare class TaskActivitiesResource {
13006
15877
  create(taskId: string, body: TaskActivityBody, options?: RequestOptions): Promise<CommentActivity>;
13007
15878
  /**
13008
15879
  * Update a task activity.
15880
+ * Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
13009
15881
  *
13010
15882
  * @example
13011
15883
  * await workast.tasks.activities.update('task-id', 'activity-id', { value: 'Updated comment' });
@@ -13013,6 +15885,7 @@ declare class TaskActivitiesResource {
13013
15885
  update(taskId: string, activityId: string, body: ActivityBody, options?: RequestOptions): Promise<void>;
13014
15886
  /**
13015
15887
  * Delete a task activity.
15888
+ * Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
13016
15889
  *
13017
15890
  * @example
13018
15891
  * await workast.tasks.activities.del('task-id', 'activity-id');
@@ -13028,13 +15901,23 @@ declare class Tasks {
13028
15901
  constructor(client: Workast);
13029
15902
  /**
13030
15903
  * Create a task in a list.
15904
+ * Requires one of: `task:create` (least privilege) or `task:manage`.
13031
15905
  *
13032
15906
  * @example
13033
15907
  * const task = await workast.tasks.create('list-id', { text: 'Ship v3' });
13034
15908
  */
13035
15909
  create(listId: string, body: TaskCreate, options?: RequestOptions): Promise<Task>;
15910
+ /**
15911
+ * Create a task in the personal list.
15912
+ * Requires one of: `task:create` (least privilege) or `task:manage`.
15913
+ *
15914
+ * @example
15915
+ * const task = await workast.tasks.createPersonal({ text: 'Ship v3' });
15916
+ */
15917
+ createPersonal(body: TaskCreate, options?: RequestOptions): Promise<Task>;
13036
15918
  /**
13037
15919
  * Get a task by ID.
15920
+ * Requires one of: `task:find` (least privilege) or `task:manage`.
13038
15921
  *
13039
15922
  * @example
13040
15923
  * const task = await workast.tasks.retrieve('task-id');
@@ -13042,6 +15925,7 @@ declare class Tasks {
13042
15925
  retrieve(taskId: string, options?: RequestOptions): Promise<Task>;
13043
15926
  /**
13044
15927
  * Get a task by short ID.
15928
+ * Requires one of: `task:find` (least privilege) or `task:manage`.
13045
15929
  *
13046
15930
  * @example
13047
15931
  * const task = await workast.tasks.retrieveByShortId('t4k1');
@@ -13049,6 +15933,7 @@ declare class Tasks {
13049
15933
  retrieveByShortId(shortId: string, options?: RequestOptions): Promise<Task>;
13050
15934
  /**
13051
15935
  * Update a task.
15936
+ * Requires `task:manage`.
13052
15937
  *
13053
15938
  * @example
13054
15939
  * await workast.tasks.update('task-id', { text: 'Ship v3' });
@@ -13056,6 +15941,7 @@ declare class Tasks {
13056
15941
  update(taskId: string, body: TaskPatch, options?: RequestOptions): Promise<void>;
13057
15942
  /**
13058
15943
  * Delete a task.
15944
+ * Requires one of: `task:manage:remove` (least privilege) or `task:manage`.
13059
15945
  *
13060
15946
  * @example
13061
15947
  * await workast.tasks.del('task-id');
@@ -13063,6 +15949,7 @@ declare class Tasks {
13063
15949
  del(taskId: string, options?: RequestOptions): Promise<void>;
13064
15950
  /**
13065
15951
  * Search tasks.
15952
+ * Requires one of: `task:find` (least privilege) or `task:manage`.
13066
15953
  *
13067
15954
  * @example
13068
15955
  * const results = await workast.tasks.list({
@@ -13072,6 +15959,7 @@ declare class Tasks {
13072
15959
  list(body: TaskSearch, options?: RequestOptions): Promise<SearchResults>;
13073
15960
  /**
13074
15961
  * Complete a task.
15962
+ * Requires one of: `task:manage:status` (least privilege) or `task:manage`.
13075
15963
  *
13076
15964
  * @example
13077
15965
  * await workast.tasks.complete('task-id');
@@ -13079,6 +15967,7 @@ declare class Tasks {
13079
15967
  complete(taskId: string, options?: RequestOptions): Promise<void>;
13080
15968
  /**
13081
15969
  * Uncomplete a task.
15970
+ * Requires one of: `task:manage:status` (least privilege) or `task:manage`.
13082
15971
  *
13083
15972
  * @example
13084
15973
  * await workast.tasks.uncomplete('task-id');
@@ -13086,6 +15975,7 @@ declare class Tasks {
13086
15975
  uncomplete(taskId: string, options?: RequestOptions): Promise<void>;
13087
15976
  /**
13088
15977
  * Assign users to a task.
15978
+ * Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
13089
15979
  *
13090
15980
  * @example
13091
15981
  * await workast.tasks.assign('task-id', { users: ['user-id'] });
@@ -13093,6 +15983,7 @@ declare class Tasks {
13093
15983
  assign(taskId: string, body: TaskAssignment, options?: RequestOptions): Promise<void>;
13094
15984
  /**
13095
15985
  * Unassign users from a task.
15986
+ * Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
13096
15987
  *
13097
15988
  * @example
13098
15989
  * await workast.tasks.unassign('task-id', { users: ['user-id'] });
@@ -13100,6 +15991,7 @@ declare class Tasks {
13100
15991
  unassign(taskId: string, body: TaskAssignment, options?: RequestOptions): Promise<void>;
13101
15992
  /**
13102
15993
  * Add followers to a task.
15994
+ * Requires `user:task:follow`.
13103
15995
  *
13104
15996
  * @example
13105
15997
  * await workast.tasks.follow('task-id', { users: ['user-id'] });
@@ -13107,6 +15999,7 @@ declare class Tasks {
13107
15999
  follow(taskId: string, body: TaskFollow, options?: RequestOptions): Promise<void>;
13108
16000
  /**
13109
16001
  * Remove followers from a task.
16002
+ * Requires `user:task:follow`.
13110
16003
  *
13111
16004
  * @example
13112
16005
  * await workast.tasks.unfollow('task-id', { users: ['user-id'] });
@@ -13114,6 +16007,7 @@ declare class Tasks {
13114
16007
  unfollow(taskId: string, body: TaskFollow, options?: RequestOptions): Promise<void>;
13115
16008
  /**
13116
16009
  * Move tasks to another list.
16010
+ * Requires one of: `task:manage:move` (least privilege) or `task:manage`.
13117
16011
  *
13118
16012
  * @example
13119
16013
  * await workast.tasks.move('list-id', { tasks: ['task-id'], target: 'other-list-id' });
@@ -13121,6 +16015,7 @@ declare class Tasks {
13121
16015
  move(listId: string, body: TaskMove, options?: RequestOptions): Promise<void>;
13122
16016
  /**
13123
16017
  * Create many tasks in a list.
16018
+ * Requires one of: `task:create` (least privilege) or `task:manage`.
13124
16019
  *
13125
16020
  * @example
13126
16021
  * await workast.tasks.createMany('list-id', [{ text: 'One' }, { text: 'Two' }]);
@@ -13128,6 +16023,7 @@ declare class Tasks {
13128
16023
  createMany(listId: string, body: TaskBulkCreate[], options?: RequestOptions): Promise<void>;
13129
16024
  /**
13130
16025
  * Update many tasks.
16026
+ * Requires `task:manage`.
13131
16027
  *
13132
16028
  * @example
13133
16029
  * const result = await workast.tasks.updateMany({ tasks: ['task-id'], status: 'done' });
@@ -13135,6 +16031,7 @@ declare class Tasks {
13135
16031
  updateMany(body: TaskBulkUpdate, options?: RequestOptions): Promise<TaskBulkUpdateResult>;
13136
16032
  /**
13137
16033
  * List home (favourite) tasks.
16034
+ * Requires one of: `home:task:find` (least privilege) or `home:task:manage`.
13138
16035
  *
13139
16036
  * @example
13140
16037
  * const home = await workast.tasks.listHome();
@@ -13142,6 +16039,7 @@ declare class Tasks {
13142
16039
  listHome(options?: RequestOptions): Promise<HomeTasks>;
13143
16040
  /**
13144
16041
  * Add a task to the home screen.
16042
+ * Requires `home:task:manage`.
13145
16043
  *
13146
16044
  * @example
13147
16045
  * await workast.tasks.addHome('task-id');
@@ -13149,6 +16047,7 @@ declare class Tasks {
13149
16047
  addHome(taskId: string, options?: RequestOptions): Promise<void>;
13150
16048
  /**
13151
16049
  * Remove a task from the home screen.
16050
+ * Requires `home:task:manage`.
13152
16051
  *
13153
16052
  * @example
13154
16053
  * await workast.tasks.removeHome('task-id');
@@ -13156,6 +16055,7 @@ declare class Tasks {
13156
16055
  removeHome(taskId: string, options?: RequestOptions): Promise<void>;
13157
16056
  /**
13158
16057
  * Add tags to a task.
16058
+ * Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
13159
16059
  *
13160
16060
  * @example
13161
16061
  * await workast.tasks.addTag('task-id', { tags: ['tag-id'] });
@@ -13163,6 +16063,7 @@ declare class Tasks {
13163
16063
  addTag(taskId: string, body: TaskTag, options?: RequestOptions): Promise<void>;
13164
16064
  /**
13165
16065
  * Remove tags from a task.
16066
+ * Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
13166
16067
  *
13167
16068
  * @example
13168
16069
  * await workast.tasks.removeTag('task-id', { tags: ['tag-id'] });
@@ -13170,6 +16071,7 @@ declare class Tasks {
13170
16071
  removeTag(taskId: string, body: TaskTag, options?: RequestOptions): Promise<void>;
13171
16072
  /**
13172
16073
  * Convert a task into a subtask of another task.
16074
+ * Requires `task:manage`.
13173
16075
  *
13174
16076
  * @example
13175
16077
  * await workast.tasks.convertToSubtask('task-id', { parentTaskId: 'parent-id' });
@@ -13177,6 +16079,7 @@ declare class Tasks {
13177
16079
  convertToSubtask(taskId: string, body: ConvertToSubtask, options?: RequestOptions): Promise<void>;
13178
16080
  /**
13179
16081
  * Convert a subtask into a standalone task.
16082
+ * Requires `task:manage`.
13180
16083
  *
13181
16084
  * @example
13182
16085
  * const task = await workast.tasks.convertToTask('task-id');
@@ -13189,6 +16092,7 @@ declare class Tokens {
13189
16092
  constructor(client: Workast);
13190
16093
  /**
13191
16094
  * Get the token details.
16095
+ * Requires any authenticated token (no specific scope).
13192
16096
  *
13193
16097
  * @example
13194
16098
  * const token = await workast.tokens.retrieve();
@@ -13201,6 +16105,7 @@ declare class Users {
13201
16105
  constructor(client: Workast);
13202
16106
  /**
13203
16107
  * Get the logged-in user.
16108
+ * Requires any authenticated token (no specific scope).
13204
16109
  *
13205
16110
  * @example
13206
16111
  * const me = await workast.users.me();
@@ -13208,6 +16113,7 @@ declare class Users {
13208
16113
  me(options?: RequestOptions): Promise<UserResource>;
13209
16114
  /**
13210
16115
  * List users in the team.
16116
+ * Requires one of: `user:find` (least privilege) or `user:manage`.
13211
16117
  *
13212
16118
  * @example
13213
16119
  * const users = await workast.users.list({ name: 'Ada', limit: 10 });
@@ -13215,6 +16121,7 @@ declare class Users {
13215
16121
  list(query?: UserSearchQuery, options?: RequestOptions): Promise<UserDetail[]>;
13216
16122
  /**
13217
16123
  * Get a user by ID.
16124
+ * Requires one of: `user:find` (least privilege) or `user:manage`.
13218
16125
  *
13219
16126
  * @example
13220
16127
  * const user = await workast.users.retrieve('user-id');
@@ -13222,15 +16129,15 @@ declare class Users {
13222
16129
  retrieve(userId: string, options?: RequestOptions): Promise<UserDetail>;
13223
16130
  /**
13224
16131
  * Get a user by email.
16132
+ * Requires one of: `user:find` (least privilege) or `user:manage`.
13225
16133
  *
13226
16134
  * @example
13227
16135
  * const user = await workast.users.retrieveByEmail('ada@example.com');
13228
16136
  */
13229
- retrieveByEmail(email: string, query?: UserByEmailQuery, options?: RequestOptions): Promise<UserDetail & {
13230
- team?: Team;
13231
- }>;
16137
+ retrieveByEmail(email: string, query?: UserByEmailQuery, options?: RequestOptions): Promise<UserDetailWithTeam>;
13232
16138
  /**
13233
16139
  * Invite a user to the team.
16140
+ * Requires one of: `user:invite` (least privilege) or `user:manage`.
13234
16141
  *
13235
16142
  * @example
13236
16143
  * const user = await workast.users.invite({ name: 'Ada', email: 'ada@example.com', role: 'member' });
@@ -13243,6 +16150,7 @@ declare class WorkflowsResource {
13243
16150
  constructor(client: Workast);
13244
16151
  /**
13245
16152
  * List workflows created by the logged-in user.
16153
+ * Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
13246
16154
  *
13247
16155
  * @example
13248
16156
  * const results = await workast.workflows.list({ limit: 10, skip: 0 });
@@ -13250,6 +16158,7 @@ declare class WorkflowsResource {
13250
16158
  list(query?: WorkflowSearchQuery, options?: RequestOptions): Promise<Workflows>;
13251
16159
  /**
13252
16160
  * Create a workflow.
16161
+ * Requires `workflow:manage`.
13253
16162
  *
13254
16163
  * @example
13255
16164
  * const workflow = await workast.workflows.create({
@@ -13262,6 +16171,7 @@ declare class WorkflowsResource {
13262
16171
  create(body: WorkflowCreate, options?: RequestOptions): Promise<Workflow>;
13263
16172
  /**
13264
16173
  * Get a workflow by ID.
16174
+ * Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
13265
16175
  *
13266
16176
  * @example
13267
16177
  * const workflow = await workast.workflows.retrieve('workflow-id');
@@ -13269,6 +16179,7 @@ declare class WorkflowsResource {
13269
16179
  retrieve(workflowId: string, options?: RequestOptions): Promise<WorkflowDetail>;
13270
16180
  /**
13271
16181
  * Update a workflow.
16182
+ * Requires `workflow:manage`.
13272
16183
  *
13273
16184
  * @example
13274
16185
  * await workast.workflows.update('workflow-id', { prompt: 'Ship v3' });
@@ -13276,6 +16187,7 @@ declare class WorkflowsResource {
13276
16187
  update(workflowId: string, body: WorkflowPatch, options?: RequestOptions): Promise<void>;
13277
16188
  /**
13278
16189
  * Delete a workflow.
16190
+ * Requires `workflow:manage`.
13279
16191
  *
13280
16192
  * @example
13281
16193
  * await workast.workflows.del('workflow-id');
@@ -13283,6 +16195,7 @@ declare class WorkflowsResource {
13283
16195
  del(workflowId: string, options?: RequestOptions): Promise<void>;
13284
16196
  /**
13285
16197
  * Activate a workflow.
16198
+ * Requires `workflow:manage`.
13286
16199
  *
13287
16200
  * @example
13288
16201
  * await workast.workflows.activate('workflow-id');
@@ -13290,6 +16203,7 @@ declare class WorkflowsResource {
13290
16203
  activate(workflowId: string, options?: RequestOptions): Promise<void>;
13291
16204
  /**
13292
16205
  * Deactivate a workflow.
16206
+ * Requires `workflow:manage`.
13293
16207
  *
13294
16208
  * @example
13295
16209
  * await workast.workflows.deactivate('workflow-id');
@@ -13358,4 +16272,4 @@ declare class ValidationError extends ApiError {
13358
16272
  constructor(message: string, status?: number, body?: unknown);
13359
16273
  }
13360
16274
 
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 };
16275
+ 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 FindHomeSearchesQuery, 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 };