@workast/sdk 3.1.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/{chunk-LR7MGXLV.js → chunk-77N6V6HL.js} +135 -5
- package/dist/chunk-77N6V6HL.js.map +1 -0
- package/dist/index.cjs +134 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +370 -6
- package/dist/index.d.ts +370 -6
- package/dist/index.js +1 -1
- package/dist/mock.cjs +134 -4
- package/dist/mock.cjs.map +1 -1
- package/dist/mock.d.cts +1 -1
- package/dist/mock.d.ts +1 -1
- package/dist/mock.js +1 -1
- package/dist/mock.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-LR7MGXLV.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -5,7 +5,7 @@ interface RequestOptions {
|
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* This file was generated by scripts/generate-types.mjs. Do not edit.
|
|
8
|
-
* Source swagger SHA-256:
|
|
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;
|
|
@@ -9754,8 +9811,6 @@ interface operations {
|
|
|
9754
9811
|
skip?: number;
|
|
9755
9812
|
/** @description The sort criteria for returned Searches. Default is createdAt. */
|
|
9756
9813
|
sort?: "createdAt" | "-createdAt" | "updatedAt" | "-updatedAt" | "name" | "-name";
|
|
9757
|
-
/** @description Whether to only list the user's searches that are displayed in the home screen (favourites) or not. */
|
|
9758
|
-
home?: boolean;
|
|
9759
9814
|
};
|
|
9760
9815
|
header?: never;
|
|
9761
9816
|
path?: never;
|
|
@@ -10011,6 +10066,58 @@ interface operations {
|
|
|
10011
10066
|
};
|
|
10012
10067
|
};
|
|
10013
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
|
+
};
|
|
10014
10121
|
getSearch: {
|
|
10015
10122
|
parameters: {
|
|
10016
10123
|
query?: {
|
|
@@ -11678,6 +11785,67 @@ interface operations {
|
|
|
11678
11785
|
};
|
|
11679
11786
|
};
|
|
11680
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
|
+
};
|
|
11681
11849
|
getListParticipants: {
|
|
11682
11850
|
parameters: {
|
|
11683
11851
|
query?: never;
|
|
@@ -12443,6 +12611,84 @@ interface operations {
|
|
|
12443
12611
|
};
|
|
12444
12612
|
};
|
|
12445
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
|
+
};
|
|
12446
12692
|
getNotes: {
|
|
12447
12693
|
parameters: {
|
|
12448
12694
|
query?: {
|
|
@@ -14906,7 +15152,7 @@ interface operations {
|
|
|
14906
15152
|
|
|
14907
15153
|
/**
|
|
14908
15154
|
* This file was generated by scripts/generate-types.mjs. Do not edit.
|
|
14909
|
-
* Source swagger SHA-256:
|
|
15155
|
+
* Source swagger SHA-256: 960f8629333a3f09cac00abc7fc8fb7d68c165cac7a216639e536d9c6af24c04
|
|
14910
15156
|
*/
|
|
14911
15157
|
|
|
14912
15158
|
type ActivityBody = components["schemas"]["ActivityBody"];
|
|
@@ -15012,12 +15258,14 @@ type TaskActivitySearchQuery = NonNullable<paths["/task/{taskId}/activity"]["get
|
|
|
15012
15258
|
type UserByEmailQuery = NonNullable<paths["/user/email/{email}"]["get"]["parameters"]["query"]>;
|
|
15013
15259
|
type UserSearchQuery = NonNullable<paths["/user"]["get"]["parameters"]["query"]>;
|
|
15014
15260
|
type WorkflowSearchQuery = NonNullable<paths["/workflow"]["get"]["parameters"]["query"]>;
|
|
15261
|
+
type FindHomeSearchesQuery = NonNullable<paths["/search/home"]["get"]["parameters"]["query"]>;
|
|
15015
15262
|
|
|
15016
15263
|
declare class Attachments {
|
|
15017
15264
|
private readonly client;
|
|
15018
15265
|
constructor(client: Workast);
|
|
15019
15266
|
/**
|
|
15020
15267
|
* Get a signed URL to download an attachment file.
|
|
15268
|
+
* Requires `file:find`.
|
|
15021
15269
|
*
|
|
15022
15270
|
* @example
|
|
15023
15271
|
* const attachment = await workast.attachments.retrieveFileUrl('attachment-id');
|
|
@@ -15030,6 +15278,7 @@ declare class CalendarEventsResource {
|
|
|
15030
15278
|
constructor(client: Workast);
|
|
15031
15279
|
/**
|
|
15032
15280
|
* List user calendar events.
|
|
15281
|
+
* Requires `calendar:find`.
|
|
15033
15282
|
*
|
|
15034
15283
|
* @example
|
|
15035
15284
|
* const results = await workast.calendar.events.list({ from: '2025-10-29', to: '2025-11-05' });
|
|
@@ -15046,6 +15295,7 @@ declare class Fields {
|
|
|
15046
15295
|
constructor(client: Workast);
|
|
15047
15296
|
/**
|
|
15048
15297
|
* List custom fields in the team.
|
|
15298
|
+
* Requires one of: `field:find` (least privilege) or `field:manage`.
|
|
15049
15299
|
*
|
|
15050
15300
|
* @example
|
|
15051
15301
|
* const fields = await workast.fields.list({ listId: 'list-id' });
|
|
@@ -15053,6 +15303,7 @@ declare class Fields {
|
|
|
15053
15303
|
list(query?: CustomFieldSearchQuery, options?: RequestOptions): Promise<CustomField[]>;
|
|
15054
15304
|
/**
|
|
15055
15305
|
* Create a custom field.
|
|
15306
|
+
* Requires `field:manage`.
|
|
15056
15307
|
*
|
|
15057
15308
|
* @example
|
|
15058
15309
|
* const field = await workast.fields.create({ name: 'Priority', type: 'text' });
|
|
@@ -15060,6 +15311,7 @@ declare class Fields {
|
|
|
15060
15311
|
create(body: CustomFieldCreate, options?: RequestOptions): Promise<CustomField>;
|
|
15061
15312
|
/**
|
|
15062
15313
|
* Update a custom field.
|
|
15314
|
+
* Requires `field:manage`.
|
|
15063
15315
|
*
|
|
15064
15316
|
* @example
|
|
15065
15317
|
* const field = await workast.fields.update('field-id', { name: 'Priority' });
|
|
@@ -15067,6 +15319,7 @@ declare class Fields {
|
|
|
15067
15319
|
update(fieldId: string, body: CustomFieldPatch, options?: RequestOptions): Promise<CustomField>;
|
|
15068
15320
|
/**
|
|
15069
15321
|
* Remove a custom field.
|
|
15322
|
+
* Requires `field:manage`.
|
|
15070
15323
|
*
|
|
15071
15324
|
* @example
|
|
15072
15325
|
* await workast.fields.del('field-id');
|
|
@@ -15079,6 +15332,7 @@ declare class ListSublists {
|
|
|
15079
15332
|
constructor(client: Workast);
|
|
15080
15333
|
/**
|
|
15081
15334
|
* List unique sublist names across lists.
|
|
15335
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
15082
15336
|
*
|
|
15083
15337
|
* @example
|
|
15084
15338
|
* const names = await workast.lists.sublists.list({ types: ['group'] });
|
|
@@ -15086,6 +15340,7 @@ declare class ListSublists {
|
|
|
15086
15340
|
list(query?: SubListSearchQuery, options?: RequestOptions): Promise<string[]>;
|
|
15087
15341
|
/**
|
|
15088
15342
|
* Create a sublist in a list.
|
|
15343
|
+
* Requires one of: `list:create` (least privilege) or `list:manage`.
|
|
15089
15344
|
*
|
|
15090
15345
|
* @example
|
|
15091
15346
|
* const sublist = await workast.lists.sublists.create('list-id', { name: 'To-do' });
|
|
@@ -15093,6 +15348,7 @@ declare class ListSublists {
|
|
|
15093
15348
|
create(listId: string, body: SubListCreate, options?: RequestOptions): Promise<SubList>;
|
|
15094
15349
|
/**
|
|
15095
15350
|
* Update a sublist.
|
|
15351
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
15096
15352
|
*
|
|
15097
15353
|
* @example
|
|
15098
15354
|
* await workast.lists.sublists.update('list-id', 'sublist-id', { name: 'Done' });
|
|
@@ -15100,6 +15356,7 @@ declare class ListSublists {
|
|
|
15100
15356
|
update(listId: string, subListId: string, body: SubListPatch, options?: RequestOptions): Promise<void>;
|
|
15101
15357
|
/**
|
|
15102
15358
|
* Remove a sublist.
|
|
15359
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
15103
15360
|
*
|
|
15104
15361
|
* @example
|
|
15105
15362
|
* await workast.lists.sublists.del('list-id', 'sublist-id');
|
|
@@ -15111,6 +15368,7 @@ declare class ListParticipantsResource {
|
|
|
15111
15368
|
constructor(client: Workast);
|
|
15112
15369
|
/**
|
|
15113
15370
|
* List participants on a list.
|
|
15371
|
+
* Requires one of: `list:participant:find` (least privilege) or `list:manage`.
|
|
15114
15372
|
*
|
|
15115
15373
|
* @example
|
|
15116
15374
|
* const users = await workast.lists.participants.list('list-id');
|
|
@@ -15118,6 +15376,7 @@ declare class ListParticipantsResource {
|
|
|
15118
15376
|
list(listId: string, options?: RequestOptions): Promise<User[]>;
|
|
15119
15377
|
/**
|
|
15120
15378
|
* Add participants to a list.
|
|
15379
|
+
* Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
|
|
15121
15380
|
*
|
|
15122
15381
|
* @example
|
|
15123
15382
|
* await workast.lists.participants.add('list-id', { users: ['user-id'] });
|
|
@@ -15125,6 +15384,7 @@ declare class ListParticipantsResource {
|
|
|
15125
15384
|
add(listId: string, body: ListParticipants, options?: RequestOptions): Promise<void>;
|
|
15126
15385
|
/**
|
|
15127
15386
|
* Remove participants from a list.
|
|
15387
|
+
* Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
|
|
15128
15388
|
*
|
|
15129
15389
|
* @example
|
|
15130
15390
|
* await workast.lists.participants.del('list-id', { users: ['user-id'] });
|
|
@@ -15136,6 +15396,7 @@ declare class ListFields {
|
|
|
15136
15396
|
constructor(client: Workast);
|
|
15137
15397
|
/**
|
|
15138
15398
|
* Enable a custom field on a list.
|
|
15399
|
+
* Requires `field:manage`.
|
|
15139
15400
|
*
|
|
15140
15401
|
* @example
|
|
15141
15402
|
* await workast.lists.fields.enable('list-id', 'field-id');
|
|
@@ -15143,6 +15404,7 @@ declare class ListFields {
|
|
|
15143
15404
|
enable(listId: string, fieldId: string, options?: RequestOptions): Promise<void>;
|
|
15144
15405
|
/**
|
|
15145
15406
|
* Disable a custom field on a list.
|
|
15407
|
+
* Requires `field:manage`.
|
|
15146
15408
|
*
|
|
15147
15409
|
* @example
|
|
15148
15410
|
* await workast.lists.fields.disable('list-id', 'field-id');
|
|
@@ -15157,6 +15419,7 @@ declare class Lists {
|
|
|
15157
15419
|
constructor(client: Workast);
|
|
15158
15420
|
/**
|
|
15159
15421
|
* Create a list.
|
|
15422
|
+
* Requires one of: `list:create` (least privilege) or `list:manage`.
|
|
15160
15423
|
*
|
|
15161
15424
|
* @example
|
|
15162
15425
|
* const list = await workast.lists.create({ name: 'Engineering' });
|
|
@@ -15164,6 +15427,7 @@ declare class Lists {
|
|
|
15164
15427
|
create(body: ListCreate, options?: RequestOptions): Promise<List>;
|
|
15165
15428
|
/**
|
|
15166
15429
|
* Get a list by ID.
|
|
15430
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
15167
15431
|
*
|
|
15168
15432
|
* @example
|
|
15169
15433
|
* const list = await workast.lists.retrieve('list-id');
|
|
@@ -15171,6 +15435,7 @@ declare class Lists {
|
|
|
15171
15435
|
retrieve(listId: string, options?: RequestOptions): Promise<List>;
|
|
15172
15436
|
/**
|
|
15173
15437
|
* Update a list.
|
|
15438
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
15174
15439
|
*
|
|
15175
15440
|
* @example
|
|
15176
15441
|
* await workast.lists.update('list-id', { name: 'Engineering' });
|
|
@@ -15178,6 +15443,7 @@ declare class Lists {
|
|
|
15178
15443
|
update(listId: string, body: ListPatch, options?: RequestOptions): Promise<void>;
|
|
15179
15444
|
/**
|
|
15180
15445
|
* Search lists.
|
|
15446
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
15181
15447
|
*
|
|
15182
15448
|
* @example
|
|
15183
15449
|
* const lists = await workast.lists.list({ type: 'group', limit: 10 });
|
|
@@ -15185,6 +15451,7 @@ declare class Lists {
|
|
|
15185
15451
|
list(query?: ListSearchQuery, options?: RequestOptions): Promise<ListEnumerate[]>;
|
|
15186
15452
|
/**
|
|
15187
15453
|
* Get the personal list.
|
|
15454
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
15188
15455
|
*
|
|
15189
15456
|
* @example
|
|
15190
15457
|
* const list = await workast.lists.retrievePersonal();
|
|
@@ -15192,6 +15459,7 @@ declare class Lists {
|
|
|
15192
15459
|
retrievePersonal(options?: RequestOptions): Promise<List>;
|
|
15193
15460
|
/**
|
|
15194
15461
|
* Archive a list.
|
|
15462
|
+
* Requires `list:manage`.
|
|
15195
15463
|
*
|
|
15196
15464
|
* @example
|
|
15197
15465
|
* await workast.lists.archive('list-id');
|
|
@@ -15199,6 +15467,7 @@ declare class Lists {
|
|
|
15199
15467
|
archive(listId: string, options?: RequestOptions): Promise<void>;
|
|
15200
15468
|
/**
|
|
15201
15469
|
* Unarchive a list.
|
|
15470
|
+
* Requires `list:manage`.
|
|
15202
15471
|
*
|
|
15203
15472
|
* @example
|
|
15204
15473
|
* await workast.lists.unarchive('list-id');
|
|
@@ -15206,6 +15475,7 @@ declare class Lists {
|
|
|
15206
15475
|
unarchive(listId: string, options?: RequestOptions): Promise<void>;
|
|
15207
15476
|
/**
|
|
15208
15477
|
* Join a list.
|
|
15478
|
+
* Requires `list:join`.
|
|
15209
15479
|
*
|
|
15210
15480
|
* @example
|
|
15211
15481
|
* await workast.lists.join('list-id');
|
|
@@ -15213,6 +15483,7 @@ declare class Lists {
|
|
|
15213
15483
|
join(listId: string, options?: RequestOptions): Promise<void>;
|
|
15214
15484
|
/**
|
|
15215
15485
|
* Request access to a private list.
|
|
15486
|
+
* Requires `list:join`.
|
|
15216
15487
|
*
|
|
15217
15488
|
* @example
|
|
15218
15489
|
* await workast.lists.requestAccess('list-id');
|
|
@@ -15220,6 +15491,7 @@ declare class Lists {
|
|
|
15220
15491
|
requestAccess(listId: string, options?: RequestOptions): Promise<void>;
|
|
15221
15492
|
/**
|
|
15222
15493
|
* Import a template into a list.
|
|
15494
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
15223
15495
|
*
|
|
15224
15496
|
* @example
|
|
15225
15497
|
* await workast.lists.importTemplate('list-id', 'template-id', { updateDueDates: 30 });
|
|
@@ -15232,6 +15504,7 @@ declare class MeetingsResource {
|
|
|
15232
15504
|
constructor(client: Workast);
|
|
15233
15505
|
/**
|
|
15234
15506
|
* List meetings.
|
|
15507
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
15235
15508
|
*
|
|
15236
15509
|
* @example
|
|
15237
15510
|
* const results = await workast.meetings.list({ timeMin: '2026-01-01T00:00:00Z', maxResults: 15 });
|
|
@@ -15239,6 +15512,7 @@ declare class MeetingsResource {
|
|
|
15239
15512
|
list(query?: MeetingSearchQuery, options?: RequestOptions): Promise<Meetings>;
|
|
15240
15513
|
/**
|
|
15241
15514
|
* Create a meeting from a calendar event, or create a new calendar event.
|
|
15515
|
+
* Requires `meeting:manage`.
|
|
15242
15516
|
*
|
|
15243
15517
|
* @example
|
|
15244
15518
|
* const meeting = await workast.meetings.createFromEvent({
|
|
@@ -15250,6 +15524,7 @@ declare class MeetingsResource {
|
|
|
15250
15524
|
createFromEvent(body: MeetingCreate, options?: RequestOptions): Promise<Meeting>;
|
|
15251
15525
|
/**
|
|
15252
15526
|
* Get a meeting by ID.
|
|
15527
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
15253
15528
|
*
|
|
15254
15529
|
* @example
|
|
15255
15530
|
* const meeting = await workast.meetings.retrieve('meeting-id');
|
|
@@ -15257,6 +15532,7 @@ declare class MeetingsResource {
|
|
|
15257
15532
|
retrieve(meetingId: string, options?: RequestOptions): Promise<MeetingDetail>;
|
|
15258
15533
|
/**
|
|
15259
15534
|
* Update meeting notes.
|
|
15535
|
+
* Requires `meeting:manage`.
|
|
15260
15536
|
*
|
|
15261
15537
|
* @example
|
|
15262
15538
|
* const meeting = await workast.meetings.update('meeting-id', { notes: 'Ship v3' });
|
|
@@ -15264,6 +15540,7 @@ declare class MeetingsResource {
|
|
|
15264
15540
|
update(meetingId: string, body: MeetingPatch, options?: RequestOptions): Promise<MeetingDetail>;
|
|
15265
15541
|
/**
|
|
15266
15542
|
* Get meeting recording assets and transcript.
|
|
15543
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
15267
15544
|
*
|
|
15268
15545
|
* @example
|
|
15269
15546
|
* const recording = await workast.meetings.retrieveRecording('meeting-id');
|
|
@@ -15271,6 +15548,7 @@ declare class MeetingsResource {
|
|
|
15271
15548
|
retrieveRecording(meetingId: string, options?: RequestOptions): Promise<MeetingRecordingResource>;
|
|
15272
15549
|
/**
|
|
15273
15550
|
* Enable the notetaker for a meeting.
|
|
15551
|
+
* Requires `meeting:manage`.
|
|
15274
15552
|
*
|
|
15275
15553
|
* @example
|
|
15276
15554
|
* const meeting = await workast.meetings.enableNotetaker('meeting-id', {
|
|
@@ -15280,6 +15558,7 @@ declare class MeetingsResource {
|
|
|
15280
15558
|
enableNotetaker(meetingId: string, body?: MeetingNotetakerEnable, options?: RequestOptions): Promise<Meeting>;
|
|
15281
15559
|
/**
|
|
15282
15560
|
* Disable or remove the notetaker from a meeting.
|
|
15561
|
+
* Requires `meeting:manage`.
|
|
15283
15562
|
*
|
|
15284
15563
|
* @example
|
|
15285
15564
|
* const meeting = await workast.meetings.disableNotetaker('meeting-id');
|
|
@@ -15292,6 +15571,7 @@ declare class NotesResource {
|
|
|
15292
15571
|
constructor(client: Workast);
|
|
15293
15572
|
/**
|
|
15294
15573
|
* List notes.
|
|
15574
|
+
* Requires one of: `note:find` (least privilege) or `note:manage`.
|
|
15295
15575
|
*
|
|
15296
15576
|
* @example
|
|
15297
15577
|
* const results = await workast.notes.list({ title: 'Spec', limit: 10 });
|
|
@@ -15299,6 +15579,7 @@ declare class NotesResource {
|
|
|
15299
15579
|
list(query?: NoteSearchQuery, options?: RequestOptions): Promise<Notes>;
|
|
15300
15580
|
/**
|
|
15301
15581
|
* Get a note by ID.
|
|
15582
|
+
* Requires one of: `note:find` (least privilege) or `note:manage`.
|
|
15302
15583
|
*
|
|
15303
15584
|
* @example
|
|
15304
15585
|
* const note = await workast.notes.retrieve('note-id');
|
|
@@ -15306,6 +15587,7 @@ declare class NotesResource {
|
|
|
15306
15587
|
retrieve(noteId: string, options?: RequestOptions): Promise<NoteDetail>;
|
|
15307
15588
|
/**
|
|
15308
15589
|
* Update a note.
|
|
15590
|
+
* Requires one of: `note:update` (least privilege) or `note:manage`.
|
|
15309
15591
|
*
|
|
15310
15592
|
* @example
|
|
15311
15593
|
* const note = await workast.notes.update('note-id', { title: 'Spec', version: 1, body: '<p>Hello</p>' });
|
|
@@ -15313,6 +15595,7 @@ declare class NotesResource {
|
|
|
15313
15595
|
update(noteId: string, body: NotePatch, options?: RequestOptions): Promise<Note>;
|
|
15314
15596
|
/**
|
|
15315
15597
|
* Delete a note.
|
|
15598
|
+
* Requires `note:manage`.
|
|
15316
15599
|
*
|
|
15317
15600
|
* @example
|
|
15318
15601
|
* await workast.notes.del('note-id');
|
|
@@ -15325,6 +15608,7 @@ declare class NotificationsResource {
|
|
|
15325
15608
|
constructor(client: Workast);
|
|
15326
15609
|
/**
|
|
15327
15610
|
* List notifications for the logged-in user.
|
|
15611
|
+
* Requires one of: `notification:find` (least privilege) or `notification:manage`.
|
|
15328
15612
|
*
|
|
15329
15613
|
* @example
|
|
15330
15614
|
* const results = await workast.notifications.list({ read: false, limit: 10 });
|
|
@@ -15332,6 +15616,7 @@ declare class NotificationsResource {
|
|
|
15332
15616
|
list(query?: NotificationSearchQuery, options?: RequestOptions): Promise<Notifications>;
|
|
15333
15617
|
/**
|
|
15334
15618
|
* Mark a notification as read.
|
|
15619
|
+
* Requires `notification:manage`.
|
|
15335
15620
|
*
|
|
15336
15621
|
* @example
|
|
15337
15622
|
* await workast.notifications.markRead('notification-id');
|
|
@@ -15339,6 +15624,7 @@ declare class NotificationsResource {
|
|
|
15339
15624
|
markRead(notificationId: string, options?: RequestOptions): Promise<void>;
|
|
15340
15625
|
/**
|
|
15341
15626
|
* Mark a notification as unread.
|
|
15627
|
+
* Requires `notification:manage`.
|
|
15342
15628
|
*
|
|
15343
15629
|
* @example
|
|
15344
15630
|
* await workast.notifications.markUnread('notification-id');
|
|
@@ -15351,6 +15637,7 @@ declare class Reactions {
|
|
|
15351
15637
|
constructor(client: Workast);
|
|
15352
15638
|
/**
|
|
15353
15639
|
* Add a reaction to an activity.
|
|
15640
|
+
* Requires one of: `activity:react` (least privilege) or `task:manage`.
|
|
15354
15641
|
*
|
|
15355
15642
|
* @example
|
|
15356
15643
|
* const reaction = await workast.reactions.add('activity-id', { emoji: ':+1:' });
|
|
@@ -15358,6 +15645,7 @@ declare class Reactions {
|
|
|
15358
15645
|
add(activityId: string, body: ReactionCreate, options?: RequestOptions): Promise<ReactionReadOnly>;
|
|
15359
15646
|
/**
|
|
15360
15647
|
* Remove a reaction from an activity.
|
|
15648
|
+
* Requires one of: `activity:react` (least privilege) or `task:manage`.
|
|
15361
15649
|
*
|
|
15362
15650
|
* @example
|
|
15363
15651
|
* await workast.reactions.del('activity-id', 'reaction-id');
|
|
@@ -15370,13 +15658,15 @@ declare class SearchesResource {
|
|
|
15370
15658
|
constructor(client: Workast);
|
|
15371
15659
|
/**
|
|
15372
15660
|
* List searches for the logged-in user.
|
|
15661
|
+
* Requires one of: `search:find` (least privilege) or `search:manage`.
|
|
15373
15662
|
*
|
|
15374
15663
|
* @example
|
|
15375
|
-
* const results = await workast.searches.list({
|
|
15664
|
+
* const results = await workast.searches.list({ limit: 10 });
|
|
15376
15665
|
*/
|
|
15377
15666
|
list(query?: SearchFindQuery, options?: RequestOptions): Promise<Searches>;
|
|
15378
15667
|
/**
|
|
15379
15668
|
* Create a search.
|
|
15669
|
+
* Requires `search:manage`.
|
|
15380
15670
|
*
|
|
15381
15671
|
* @example
|
|
15382
15672
|
* const search = await workast.searches.create({
|
|
@@ -15387,6 +15677,7 @@ declare class SearchesResource {
|
|
|
15387
15677
|
create(body: SearchCreate, options?: RequestOptions): Promise<Search>;
|
|
15388
15678
|
/**
|
|
15389
15679
|
* Get a search by ID.
|
|
15680
|
+
* Requires one of: `search:find` (least privilege) or `search:manage`.
|
|
15390
15681
|
*
|
|
15391
15682
|
* @example
|
|
15392
15683
|
* const search = await workast.searches.retrieve('search-id');
|
|
@@ -15394,6 +15685,7 @@ declare class SearchesResource {
|
|
|
15394
15685
|
retrieve(searchId: string, query?: SearchRetrieveQuery, options?: RequestOptions): Promise<SearchDetail>;
|
|
15395
15686
|
/**
|
|
15396
15687
|
* Update a search.
|
|
15688
|
+
* Requires `search:manage`.
|
|
15397
15689
|
*
|
|
15398
15690
|
* @example
|
|
15399
15691
|
* const search = await workast.searches.update('search-id', { name: 'Updated' });
|
|
@@ -15401,13 +15693,23 @@ declare class SearchesResource {
|
|
|
15401
15693
|
update(searchId: string, body: SearchPatch, options?: RequestOptions): Promise<Search>;
|
|
15402
15694
|
/**
|
|
15403
15695
|
* Delete a search.
|
|
15696
|
+
* Requires `search:manage`.
|
|
15404
15697
|
*
|
|
15405
15698
|
* @example
|
|
15406
15699
|
* await workast.searches.del('search-id');
|
|
15407
15700
|
*/
|
|
15408
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>;
|
|
15409
15710
|
/**
|
|
15410
15711
|
* Add a search to the home screen.
|
|
15712
|
+
* Requires `home:search:manage`.
|
|
15411
15713
|
*
|
|
15412
15714
|
* @example
|
|
15413
15715
|
* await workast.searches.addHome('search-id');
|
|
@@ -15415,6 +15717,7 @@ declare class SearchesResource {
|
|
|
15415
15717
|
addHome(searchId: string, options?: RequestOptions): Promise<void>;
|
|
15416
15718
|
/**
|
|
15417
15719
|
* Remove a search from the home screen.
|
|
15720
|
+
* Requires `home:search:manage`.
|
|
15418
15721
|
*
|
|
15419
15722
|
* @example
|
|
15420
15723
|
* await workast.searches.removeHome('search-id');
|
|
@@ -15422,6 +15725,7 @@ declare class SearchesResource {
|
|
|
15422
15725
|
removeHome(searchId: string, options?: RequestOptions): Promise<void>;
|
|
15423
15726
|
/**
|
|
15424
15727
|
* Share a search with users.
|
|
15728
|
+
* Requires `search:manage`.
|
|
15425
15729
|
*
|
|
15426
15730
|
* @example
|
|
15427
15731
|
* await workast.searches.share('search-id', { users: ['user-id'] });
|
|
@@ -15429,6 +15733,7 @@ declare class SearchesResource {
|
|
|
15429
15733
|
share(searchId: string, body: SearchShare, options?: RequestOptions): Promise<void>;
|
|
15430
15734
|
/**
|
|
15431
15735
|
* Unshare a search from users.
|
|
15736
|
+
* Requires `search:manage`.
|
|
15432
15737
|
*
|
|
15433
15738
|
* @example
|
|
15434
15739
|
* await workast.searches.unshare('search-id', { users: ['user-id'] });
|
|
@@ -15436,6 +15741,7 @@ declare class SearchesResource {
|
|
|
15436
15741
|
unshare(searchId: string, body: SearchShare, options?: RequestOptions): Promise<void>;
|
|
15437
15742
|
/**
|
|
15438
15743
|
* Set a reminder on a search.
|
|
15744
|
+
* Requires `search:manage`.
|
|
15439
15745
|
*
|
|
15440
15746
|
* @example
|
|
15441
15747
|
* await workast.searches.setReminder('search-id', {
|
|
@@ -15445,6 +15751,7 @@ declare class SearchesResource {
|
|
|
15445
15751
|
setReminder(searchId: string, body: SearchReminderSet, options?: RequestOptions): Promise<void>;
|
|
15446
15752
|
/**
|
|
15447
15753
|
* Delete a reminder from a search.
|
|
15754
|
+
* Requires `search:manage`.
|
|
15448
15755
|
*
|
|
15449
15756
|
* @example
|
|
15450
15757
|
* await workast.searches.delReminder('search-id');
|
|
@@ -15457,6 +15764,7 @@ declare class Tags {
|
|
|
15457
15764
|
constructor(client: Workast);
|
|
15458
15765
|
/**
|
|
15459
15766
|
* List tags in the team.
|
|
15767
|
+
* Requires one of: `tag:find` (least privilege) or `tag:manage`.
|
|
15460
15768
|
*
|
|
15461
15769
|
* @example
|
|
15462
15770
|
* const tags = await workast.tags.list({ listId: 'list-id' });
|
|
@@ -15464,6 +15772,7 @@ declare class Tags {
|
|
|
15464
15772
|
list(query?: TagSearchQuery, options?: RequestOptions): Promise<Tag[]>;
|
|
15465
15773
|
/**
|
|
15466
15774
|
* Create a tag.
|
|
15775
|
+
* Requires `tag:manage`.
|
|
15467
15776
|
*
|
|
15468
15777
|
* @example
|
|
15469
15778
|
* const tag = await workast.tags.create({ name: 'Priority', color: '#ff0000' });
|
|
@@ -15471,6 +15780,7 @@ declare class Tags {
|
|
|
15471
15780
|
create(body: TagCreate, options?: RequestOptions): Promise<Tag>;
|
|
15472
15781
|
/**
|
|
15473
15782
|
* Update a tag.
|
|
15783
|
+
* Requires `tag:manage`.
|
|
15474
15784
|
*
|
|
15475
15785
|
* @example
|
|
15476
15786
|
* const tag = await workast.tags.update('tag-id', { name: 'Priority' });
|
|
@@ -15478,6 +15788,7 @@ declare class Tags {
|
|
|
15478
15788
|
update(tagId: string, body: TagPatch, options?: RequestOptions): Promise<Tag>;
|
|
15479
15789
|
/**
|
|
15480
15790
|
* Delete a tag.
|
|
15791
|
+
* Requires `tag:manage`.
|
|
15481
15792
|
*
|
|
15482
15793
|
* @example
|
|
15483
15794
|
* await workast.tags.del('tag-id');
|
|
@@ -15490,6 +15801,7 @@ declare class TaskSubtasks {
|
|
|
15490
15801
|
constructor(client: Workast);
|
|
15491
15802
|
/**
|
|
15492
15803
|
* Create a subtask on a task.
|
|
15804
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
15493
15805
|
*
|
|
15494
15806
|
* @example
|
|
15495
15807
|
* const subtask = await workast.tasks.subtasks.create('task-id', { text: 'Write tests' });
|
|
@@ -15501,6 +15813,7 @@ declare class TaskDependencies {
|
|
|
15501
15813
|
constructor(client: Workast);
|
|
15502
15814
|
/**
|
|
15503
15815
|
* Add a dependency to a task.
|
|
15816
|
+
* Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
|
|
15504
15817
|
*
|
|
15505
15818
|
* @example
|
|
15506
15819
|
* await workast.tasks.dependencies.add('task-id', 'dependency-id');
|
|
@@ -15508,6 +15821,7 @@ declare class TaskDependencies {
|
|
|
15508
15821
|
add(taskId: string, dependencyId: string, options?: RequestOptions): Promise<void>;
|
|
15509
15822
|
/**
|
|
15510
15823
|
* Remove a dependency from a task.
|
|
15824
|
+
* Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
|
|
15511
15825
|
*
|
|
15512
15826
|
* @example
|
|
15513
15827
|
* await workast.tasks.dependencies.del('task-id', 'dependency-id');
|
|
@@ -15519,6 +15833,7 @@ declare class TaskAttachments {
|
|
|
15519
15833
|
constructor(client: Workast);
|
|
15520
15834
|
/**
|
|
15521
15835
|
* Create an attachment on a task.
|
|
15836
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
15522
15837
|
*
|
|
15523
15838
|
* @example
|
|
15524
15839
|
* const attachment = await workast.tasks.attachments.create('task-id', { author: 'user-id' });
|
|
@@ -15526,6 +15841,7 @@ declare class TaskAttachments {
|
|
|
15526
15841
|
create(taskId: string, body: NewAttachment, options?: RequestOptions): Promise<Attachment>;
|
|
15527
15842
|
/**
|
|
15528
15843
|
* Update a task attachment.
|
|
15844
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
15529
15845
|
*
|
|
15530
15846
|
* @example
|
|
15531
15847
|
* const attachment = await workast.tasks.attachments.update('task-id', 'attachment-id', { date: '2026-01-01' });
|
|
@@ -15533,6 +15849,7 @@ declare class TaskAttachments {
|
|
|
15533
15849
|
update(taskId: string, attachmentId: string, body: NewAttachment, options?: RequestOptions): Promise<Attachment>;
|
|
15534
15850
|
/**
|
|
15535
15851
|
* Delete a task attachment.
|
|
15852
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
15536
15853
|
*
|
|
15537
15854
|
* @example
|
|
15538
15855
|
* await workast.tasks.attachments.del('task-id', 'attachment-id');
|
|
@@ -15544,6 +15861,7 @@ declare class TaskActivitiesResource {
|
|
|
15544
15861
|
constructor(client: Workast);
|
|
15545
15862
|
/**
|
|
15546
15863
|
* List activities on a task.
|
|
15864
|
+
* Requires one of: `task:activity:find` (least privilege) or `task:manage`.
|
|
15547
15865
|
*
|
|
15548
15866
|
* @example
|
|
15549
15867
|
* const results = await workast.tasks.activities.list('task-id', { type: ['comment'], limit: 10 });
|
|
@@ -15551,6 +15869,7 @@ declare class TaskActivitiesResource {
|
|
|
15551
15869
|
list(taskId: string, query?: TaskActivitySearchQuery, options?: RequestOptions): Promise<TaskActivities>;
|
|
15552
15870
|
/**
|
|
15553
15871
|
* Create a comment activity on a task.
|
|
15872
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
15554
15873
|
*
|
|
15555
15874
|
* @example
|
|
15556
15875
|
* const activity = await workast.tasks.activities.create('task-id', { type: 'comment', value: 'Looks good' });
|
|
@@ -15558,6 +15877,7 @@ declare class TaskActivitiesResource {
|
|
|
15558
15877
|
create(taskId: string, body: TaskActivityBody, options?: RequestOptions): Promise<CommentActivity>;
|
|
15559
15878
|
/**
|
|
15560
15879
|
* Update a task activity.
|
|
15880
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
15561
15881
|
*
|
|
15562
15882
|
* @example
|
|
15563
15883
|
* await workast.tasks.activities.update('task-id', 'activity-id', { value: 'Updated comment' });
|
|
@@ -15565,6 +15885,7 @@ declare class TaskActivitiesResource {
|
|
|
15565
15885
|
update(taskId: string, activityId: string, body: ActivityBody, options?: RequestOptions): Promise<void>;
|
|
15566
15886
|
/**
|
|
15567
15887
|
* Delete a task activity.
|
|
15888
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
15568
15889
|
*
|
|
15569
15890
|
* @example
|
|
15570
15891
|
* await workast.tasks.activities.del('task-id', 'activity-id');
|
|
@@ -15580,13 +15901,23 @@ declare class Tasks {
|
|
|
15580
15901
|
constructor(client: Workast);
|
|
15581
15902
|
/**
|
|
15582
15903
|
* Create a task in a list.
|
|
15904
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
15583
15905
|
*
|
|
15584
15906
|
* @example
|
|
15585
15907
|
* const task = await workast.tasks.create('list-id', { text: 'Ship v3' });
|
|
15586
15908
|
*/
|
|
15587
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>;
|
|
15588
15918
|
/**
|
|
15589
15919
|
* Get a task by ID.
|
|
15920
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
15590
15921
|
*
|
|
15591
15922
|
* @example
|
|
15592
15923
|
* const task = await workast.tasks.retrieve('task-id');
|
|
@@ -15594,6 +15925,7 @@ declare class Tasks {
|
|
|
15594
15925
|
retrieve(taskId: string, options?: RequestOptions): Promise<Task>;
|
|
15595
15926
|
/**
|
|
15596
15927
|
* Get a task by short ID.
|
|
15928
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
15597
15929
|
*
|
|
15598
15930
|
* @example
|
|
15599
15931
|
* const task = await workast.tasks.retrieveByShortId('t4k1');
|
|
@@ -15601,6 +15933,7 @@ declare class Tasks {
|
|
|
15601
15933
|
retrieveByShortId(shortId: string, options?: RequestOptions): Promise<Task>;
|
|
15602
15934
|
/**
|
|
15603
15935
|
* Update a task.
|
|
15936
|
+
* Requires `task:manage`.
|
|
15604
15937
|
*
|
|
15605
15938
|
* @example
|
|
15606
15939
|
* await workast.tasks.update('task-id', { text: 'Ship v3' });
|
|
@@ -15608,6 +15941,7 @@ declare class Tasks {
|
|
|
15608
15941
|
update(taskId: string, body: TaskPatch, options?: RequestOptions): Promise<void>;
|
|
15609
15942
|
/**
|
|
15610
15943
|
* Delete a task.
|
|
15944
|
+
* Requires one of: `task:manage:remove` (least privilege) or `task:manage`.
|
|
15611
15945
|
*
|
|
15612
15946
|
* @example
|
|
15613
15947
|
* await workast.tasks.del('task-id');
|
|
@@ -15615,6 +15949,7 @@ declare class Tasks {
|
|
|
15615
15949
|
del(taskId: string, options?: RequestOptions): Promise<void>;
|
|
15616
15950
|
/**
|
|
15617
15951
|
* Search tasks.
|
|
15952
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
15618
15953
|
*
|
|
15619
15954
|
* @example
|
|
15620
15955
|
* const results = await workast.tasks.list({
|
|
@@ -15624,6 +15959,7 @@ declare class Tasks {
|
|
|
15624
15959
|
list(body: TaskSearch, options?: RequestOptions): Promise<SearchResults>;
|
|
15625
15960
|
/**
|
|
15626
15961
|
* Complete a task.
|
|
15962
|
+
* Requires one of: `task:manage:status` (least privilege) or `task:manage`.
|
|
15627
15963
|
*
|
|
15628
15964
|
* @example
|
|
15629
15965
|
* await workast.tasks.complete('task-id');
|
|
@@ -15631,6 +15967,7 @@ declare class Tasks {
|
|
|
15631
15967
|
complete(taskId: string, options?: RequestOptions): Promise<void>;
|
|
15632
15968
|
/**
|
|
15633
15969
|
* Uncomplete a task.
|
|
15970
|
+
* Requires one of: `task:manage:status` (least privilege) or `task:manage`.
|
|
15634
15971
|
*
|
|
15635
15972
|
* @example
|
|
15636
15973
|
* await workast.tasks.uncomplete('task-id');
|
|
@@ -15638,6 +15975,7 @@ declare class Tasks {
|
|
|
15638
15975
|
uncomplete(taskId: string, options?: RequestOptions): Promise<void>;
|
|
15639
15976
|
/**
|
|
15640
15977
|
* Assign users to a task.
|
|
15978
|
+
* Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
|
|
15641
15979
|
*
|
|
15642
15980
|
* @example
|
|
15643
15981
|
* await workast.tasks.assign('task-id', { users: ['user-id'] });
|
|
@@ -15645,6 +15983,7 @@ declare class Tasks {
|
|
|
15645
15983
|
assign(taskId: string, body: TaskAssignment, options?: RequestOptions): Promise<void>;
|
|
15646
15984
|
/**
|
|
15647
15985
|
* Unassign users from a task.
|
|
15986
|
+
* Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
|
|
15648
15987
|
*
|
|
15649
15988
|
* @example
|
|
15650
15989
|
* await workast.tasks.unassign('task-id', { users: ['user-id'] });
|
|
@@ -15652,6 +15991,7 @@ declare class Tasks {
|
|
|
15652
15991
|
unassign(taskId: string, body: TaskAssignment, options?: RequestOptions): Promise<void>;
|
|
15653
15992
|
/**
|
|
15654
15993
|
* Add followers to a task.
|
|
15994
|
+
* Requires `user:task:follow`.
|
|
15655
15995
|
*
|
|
15656
15996
|
* @example
|
|
15657
15997
|
* await workast.tasks.follow('task-id', { users: ['user-id'] });
|
|
@@ -15659,6 +15999,7 @@ declare class Tasks {
|
|
|
15659
15999
|
follow(taskId: string, body: TaskFollow, options?: RequestOptions): Promise<void>;
|
|
15660
16000
|
/**
|
|
15661
16001
|
* Remove followers from a task.
|
|
16002
|
+
* Requires `user:task:follow`.
|
|
15662
16003
|
*
|
|
15663
16004
|
* @example
|
|
15664
16005
|
* await workast.tasks.unfollow('task-id', { users: ['user-id'] });
|
|
@@ -15666,6 +16007,7 @@ declare class Tasks {
|
|
|
15666
16007
|
unfollow(taskId: string, body: TaskFollow, options?: RequestOptions): Promise<void>;
|
|
15667
16008
|
/**
|
|
15668
16009
|
* Move tasks to another list.
|
|
16010
|
+
* Requires one of: `task:manage:move` (least privilege) or `task:manage`.
|
|
15669
16011
|
*
|
|
15670
16012
|
* @example
|
|
15671
16013
|
* await workast.tasks.move('list-id', { tasks: ['task-id'], target: 'other-list-id' });
|
|
@@ -15673,6 +16015,7 @@ declare class Tasks {
|
|
|
15673
16015
|
move(listId: string, body: TaskMove, options?: RequestOptions): Promise<void>;
|
|
15674
16016
|
/**
|
|
15675
16017
|
* Create many tasks in a list.
|
|
16018
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
15676
16019
|
*
|
|
15677
16020
|
* @example
|
|
15678
16021
|
* await workast.tasks.createMany('list-id', [{ text: 'One' }, { text: 'Two' }]);
|
|
@@ -15680,6 +16023,7 @@ declare class Tasks {
|
|
|
15680
16023
|
createMany(listId: string, body: TaskBulkCreate[], options?: RequestOptions): Promise<void>;
|
|
15681
16024
|
/**
|
|
15682
16025
|
* Update many tasks.
|
|
16026
|
+
* Requires `task:manage`.
|
|
15683
16027
|
*
|
|
15684
16028
|
* @example
|
|
15685
16029
|
* const result = await workast.tasks.updateMany({ tasks: ['task-id'], status: 'done' });
|
|
@@ -15687,6 +16031,7 @@ declare class Tasks {
|
|
|
15687
16031
|
updateMany(body: TaskBulkUpdate, options?: RequestOptions): Promise<TaskBulkUpdateResult>;
|
|
15688
16032
|
/**
|
|
15689
16033
|
* List home (favourite) tasks.
|
|
16034
|
+
* Requires one of: `home:task:find` (least privilege) or `home:task:manage`.
|
|
15690
16035
|
*
|
|
15691
16036
|
* @example
|
|
15692
16037
|
* const home = await workast.tasks.listHome();
|
|
@@ -15694,6 +16039,7 @@ declare class Tasks {
|
|
|
15694
16039
|
listHome(options?: RequestOptions): Promise<HomeTasks>;
|
|
15695
16040
|
/**
|
|
15696
16041
|
* Add a task to the home screen.
|
|
16042
|
+
* Requires `home:task:manage`.
|
|
15697
16043
|
*
|
|
15698
16044
|
* @example
|
|
15699
16045
|
* await workast.tasks.addHome('task-id');
|
|
@@ -15701,6 +16047,7 @@ declare class Tasks {
|
|
|
15701
16047
|
addHome(taskId: string, options?: RequestOptions): Promise<void>;
|
|
15702
16048
|
/**
|
|
15703
16049
|
* Remove a task from the home screen.
|
|
16050
|
+
* Requires `home:task:manage`.
|
|
15704
16051
|
*
|
|
15705
16052
|
* @example
|
|
15706
16053
|
* await workast.tasks.removeHome('task-id');
|
|
@@ -15708,6 +16055,7 @@ declare class Tasks {
|
|
|
15708
16055
|
removeHome(taskId: string, options?: RequestOptions): Promise<void>;
|
|
15709
16056
|
/**
|
|
15710
16057
|
* Add tags to a task.
|
|
16058
|
+
* Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
|
|
15711
16059
|
*
|
|
15712
16060
|
* @example
|
|
15713
16061
|
* await workast.tasks.addTag('task-id', { tags: ['tag-id'] });
|
|
@@ -15715,6 +16063,7 @@ declare class Tasks {
|
|
|
15715
16063
|
addTag(taskId: string, body: TaskTag, options?: RequestOptions): Promise<void>;
|
|
15716
16064
|
/**
|
|
15717
16065
|
* Remove tags from a task.
|
|
16066
|
+
* Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
|
|
15718
16067
|
*
|
|
15719
16068
|
* @example
|
|
15720
16069
|
* await workast.tasks.removeTag('task-id', { tags: ['tag-id'] });
|
|
@@ -15722,6 +16071,7 @@ declare class Tasks {
|
|
|
15722
16071
|
removeTag(taskId: string, body: TaskTag, options?: RequestOptions): Promise<void>;
|
|
15723
16072
|
/**
|
|
15724
16073
|
* Convert a task into a subtask of another task.
|
|
16074
|
+
* Requires `task:manage`.
|
|
15725
16075
|
*
|
|
15726
16076
|
* @example
|
|
15727
16077
|
* await workast.tasks.convertToSubtask('task-id', { parentTaskId: 'parent-id' });
|
|
@@ -15729,6 +16079,7 @@ declare class Tasks {
|
|
|
15729
16079
|
convertToSubtask(taskId: string, body: ConvertToSubtask, options?: RequestOptions): Promise<void>;
|
|
15730
16080
|
/**
|
|
15731
16081
|
* Convert a subtask into a standalone task.
|
|
16082
|
+
* Requires `task:manage`.
|
|
15732
16083
|
*
|
|
15733
16084
|
* @example
|
|
15734
16085
|
* const task = await workast.tasks.convertToTask('task-id');
|
|
@@ -15741,6 +16092,7 @@ declare class Tokens {
|
|
|
15741
16092
|
constructor(client: Workast);
|
|
15742
16093
|
/**
|
|
15743
16094
|
* Get the token details.
|
|
16095
|
+
* Requires any authenticated token (no specific scope).
|
|
15744
16096
|
*
|
|
15745
16097
|
* @example
|
|
15746
16098
|
* const token = await workast.tokens.retrieve();
|
|
@@ -15753,6 +16105,7 @@ declare class Users {
|
|
|
15753
16105
|
constructor(client: Workast);
|
|
15754
16106
|
/**
|
|
15755
16107
|
* Get the logged-in user.
|
|
16108
|
+
* Requires any authenticated token (no specific scope).
|
|
15756
16109
|
*
|
|
15757
16110
|
* @example
|
|
15758
16111
|
* const me = await workast.users.me();
|
|
@@ -15760,6 +16113,7 @@ declare class Users {
|
|
|
15760
16113
|
me(options?: RequestOptions): Promise<UserResource>;
|
|
15761
16114
|
/**
|
|
15762
16115
|
* List users in the team.
|
|
16116
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
15763
16117
|
*
|
|
15764
16118
|
* @example
|
|
15765
16119
|
* const users = await workast.users.list({ name: 'Ada', limit: 10 });
|
|
@@ -15767,6 +16121,7 @@ declare class Users {
|
|
|
15767
16121
|
list(query?: UserSearchQuery, options?: RequestOptions): Promise<UserDetail[]>;
|
|
15768
16122
|
/**
|
|
15769
16123
|
* Get a user by ID.
|
|
16124
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
15770
16125
|
*
|
|
15771
16126
|
* @example
|
|
15772
16127
|
* const user = await workast.users.retrieve('user-id');
|
|
@@ -15774,6 +16129,7 @@ declare class Users {
|
|
|
15774
16129
|
retrieve(userId: string, options?: RequestOptions): Promise<UserDetail>;
|
|
15775
16130
|
/**
|
|
15776
16131
|
* Get a user by email.
|
|
16132
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
15777
16133
|
*
|
|
15778
16134
|
* @example
|
|
15779
16135
|
* const user = await workast.users.retrieveByEmail('ada@example.com');
|
|
@@ -15781,6 +16137,7 @@ declare class Users {
|
|
|
15781
16137
|
retrieveByEmail(email: string, query?: UserByEmailQuery, options?: RequestOptions): Promise<UserDetailWithTeam>;
|
|
15782
16138
|
/**
|
|
15783
16139
|
* Invite a user to the team.
|
|
16140
|
+
* Requires one of: `user:invite` (least privilege) or `user:manage`.
|
|
15784
16141
|
*
|
|
15785
16142
|
* @example
|
|
15786
16143
|
* const user = await workast.users.invite({ name: 'Ada', email: 'ada@example.com', role: 'member' });
|
|
@@ -15793,6 +16150,7 @@ declare class WorkflowsResource {
|
|
|
15793
16150
|
constructor(client: Workast);
|
|
15794
16151
|
/**
|
|
15795
16152
|
* List workflows created by the logged-in user.
|
|
16153
|
+
* Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
|
|
15796
16154
|
*
|
|
15797
16155
|
* @example
|
|
15798
16156
|
* const results = await workast.workflows.list({ limit: 10, skip: 0 });
|
|
@@ -15800,6 +16158,7 @@ declare class WorkflowsResource {
|
|
|
15800
16158
|
list(query?: WorkflowSearchQuery, options?: RequestOptions): Promise<Workflows>;
|
|
15801
16159
|
/**
|
|
15802
16160
|
* Create a workflow.
|
|
16161
|
+
* Requires `workflow:manage`.
|
|
15803
16162
|
*
|
|
15804
16163
|
* @example
|
|
15805
16164
|
* const workflow = await workast.workflows.create({
|
|
@@ -15812,6 +16171,7 @@ declare class WorkflowsResource {
|
|
|
15812
16171
|
create(body: WorkflowCreate, options?: RequestOptions): Promise<Workflow>;
|
|
15813
16172
|
/**
|
|
15814
16173
|
* Get a workflow by ID.
|
|
16174
|
+
* Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
|
|
15815
16175
|
*
|
|
15816
16176
|
* @example
|
|
15817
16177
|
* const workflow = await workast.workflows.retrieve('workflow-id');
|
|
@@ -15819,6 +16179,7 @@ declare class WorkflowsResource {
|
|
|
15819
16179
|
retrieve(workflowId: string, options?: RequestOptions): Promise<WorkflowDetail>;
|
|
15820
16180
|
/**
|
|
15821
16181
|
* Update a workflow.
|
|
16182
|
+
* Requires `workflow:manage`.
|
|
15822
16183
|
*
|
|
15823
16184
|
* @example
|
|
15824
16185
|
* await workast.workflows.update('workflow-id', { prompt: 'Ship v3' });
|
|
@@ -15826,6 +16187,7 @@ declare class WorkflowsResource {
|
|
|
15826
16187
|
update(workflowId: string, body: WorkflowPatch, options?: RequestOptions): Promise<void>;
|
|
15827
16188
|
/**
|
|
15828
16189
|
* Delete a workflow.
|
|
16190
|
+
* Requires `workflow:manage`.
|
|
15829
16191
|
*
|
|
15830
16192
|
* @example
|
|
15831
16193
|
* await workast.workflows.del('workflow-id');
|
|
@@ -15833,6 +16195,7 @@ declare class WorkflowsResource {
|
|
|
15833
16195
|
del(workflowId: string, options?: RequestOptions): Promise<void>;
|
|
15834
16196
|
/**
|
|
15835
16197
|
* Activate a workflow.
|
|
16198
|
+
* Requires `workflow:manage`.
|
|
15836
16199
|
*
|
|
15837
16200
|
* @example
|
|
15838
16201
|
* await workast.workflows.activate('workflow-id');
|
|
@@ -15840,6 +16203,7 @@ declare class WorkflowsResource {
|
|
|
15840
16203
|
activate(workflowId: string, options?: RequestOptions): Promise<void>;
|
|
15841
16204
|
/**
|
|
15842
16205
|
* Deactivate a workflow.
|
|
16206
|
+
* Requires `workflow:manage`.
|
|
15843
16207
|
*
|
|
15844
16208
|
* @example
|
|
15845
16209
|
* await workast.workflows.deactivate('workflow-id');
|
|
@@ -15908,4 +16272,4 @@ declare class ValidationError extends ApiError {
|
|
|
15908
16272
|
constructor(message: string, status?: number, body?: unknown);
|
|
15909
16273
|
}
|
|
15910
16274
|
|
|
15911
|
-
export { type ActivityBody, ApiError, type Attachment, type AttachmentFileUrl, type AttachmentFileUrlQuery, AuthenticationError, type CalendarEvent, type CalendarEventSearchQuery, type CalendarEvents, type CommentActivity, type ConvertToSubtask, type CustomField, type CustomFieldCreate, type CustomFieldPatch, type CustomFieldSearchQuery, type Emoji, type HomeTasks, type ImportTemplate, type List, type ListCreate, type ListEnumerate, type ListParticipants, type ListPatch, type ListSearchQuery, type Meeting, type MeetingCreate, type MeetingCreateEvent, type MeetingDetail, type MeetingMinimalResource, type MeetingNotetakerEnable, type MeetingPatch, type MeetingRecordingResource, type MeetingSearchQuery, type Meetings, type NewAttachment, NotFoundError, type Note, type NoteDetail, type NotePatch, type NoteSearchQuery, type Notes, type Notification, type NotificationSearchQuery, type NotificationType, type Notifications, PermissionError, type ReactionCreate, type ReactionReadOnly, type ReactionUser, type Repeat, type RepeatSchema, type RequestOptions, type Search, type SearchCreate, type SearchDetail, type SearchFindQuery, type SearchItem, type SearchPatch, type SearchPayload, type SearchReminderSet, type SearchResults, type SearchRetrieveQuery, type SearchShare, type Searches, type SubList, type SubListCreate, type SubListPatch, type SubListSearchQuery, type SubtaskCreate, type Tag, type TagCreate, type TagPatch, type TagSearchQuery, type Task, type TaskActivities, type TaskActivityBody, type TaskActivitySearchQuery, type TaskAssignment, type TaskBulkCreate, type TaskBulkUpdate, type TaskBulkUpdateResult, type TaskCreate, type TaskFollow, type TaskMove, type TaskPatch, type TaskSearch, type TaskTag, type Team, type TokenApp, type TokenDetails, type TokenTeam, type TokenUser, type User, type UserByEmailQuery, type UserDetail, type UserDetailWithTeam, type UserInvite, type UserResource, type UserSearchQuery, ValidationError, Workast, type WorkastAuth, type WorkastOptions, type Workflow, type WorkflowCreate, type WorkflowDetail, type WorkflowPatch, type WorkflowRun, type WorkflowRunActivity, type WorkflowSearchQuery, type WorkflowTrigger, type Workflows };
|
|
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 };
|