@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
|
@@ -129,6 +129,7 @@ var Attachments = class {
|
|
|
129
129
|
client;
|
|
130
130
|
/**
|
|
131
131
|
* Get a signed URL to download an attachment file.
|
|
132
|
+
* Requires `file:find`.
|
|
132
133
|
*
|
|
133
134
|
* @example
|
|
134
135
|
* const attachment = await workast.attachments.retrieveFileUrl('attachment-id');
|
|
@@ -155,6 +156,7 @@ var CalendarEventsResource = class {
|
|
|
155
156
|
client;
|
|
156
157
|
/**
|
|
157
158
|
* List user calendar events.
|
|
159
|
+
* Requires `calendar:find`.
|
|
158
160
|
*
|
|
159
161
|
* @example
|
|
160
162
|
* const results = await workast.calendar.events.list({ from: '2025-10-29', to: '2025-11-05' });
|
|
@@ -198,6 +200,7 @@ var Fields = class {
|
|
|
198
200
|
client;
|
|
199
201
|
/**
|
|
200
202
|
* List custom fields in the team.
|
|
203
|
+
* Requires one of: `field:find` (least privilege) or `field:manage`.
|
|
201
204
|
*
|
|
202
205
|
* @example
|
|
203
206
|
* const fields = await workast.fields.list({ listId: 'list-id' });
|
|
@@ -216,6 +219,7 @@ var Fields = class {
|
|
|
216
219
|
}
|
|
217
220
|
/**
|
|
218
221
|
* Create a custom field.
|
|
222
|
+
* Requires `field:manage`.
|
|
219
223
|
*
|
|
220
224
|
* @example
|
|
221
225
|
* const field = await workast.fields.create({ name: 'Priority', type: 'text' });
|
|
@@ -225,6 +229,7 @@ var Fields = class {
|
|
|
225
229
|
}
|
|
226
230
|
/**
|
|
227
231
|
* Update a custom field.
|
|
232
|
+
* Requires `field:manage`.
|
|
228
233
|
*
|
|
229
234
|
* @example
|
|
230
235
|
* const field = await workast.fields.update('field-id', { name: 'Priority' });
|
|
@@ -239,6 +244,7 @@ var Fields = class {
|
|
|
239
244
|
}
|
|
240
245
|
/**
|
|
241
246
|
* Remove a custom field.
|
|
247
|
+
* Requires `field:manage`.
|
|
242
248
|
*
|
|
243
249
|
* @example
|
|
244
250
|
* await workast.fields.del('field-id');
|
|
@@ -261,6 +267,7 @@ var ListSublists = class {
|
|
|
261
267
|
client;
|
|
262
268
|
/**
|
|
263
269
|
* List unique sublist names across lists.
|
|
270
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
264
271
|
*
|
|
265
272
|
* @example
|
|
266
273
|
* const names = await workast.lists.sublists.list({ types: ['group'] });
|
|
@@ -284,6 +291,7 @@ var ListSublists = class {
|
|
|
284
291
|
}
|
|
285
292
|
/**
|
|
286
293
|
* Create a sublist in a list.
|
|
294
|
+
* Requires one of: `list:create` (least privilege) or `list:manage`.
|
|
287
295
|
*
|
|
288
296
|
* @example
|
|
289
297
|
* const sublist = await workast.lists.sublists.create('list-id', { name: 'To-do' });
|
|
@@ -298,6 +306,7 @@ var ListSublists = class {
|
|
|
298
306
|
}
|
|
299
307
|
/**
|
|
300
308
|
* Update a sublist.
|
|
309
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
301
310
|
*
|
|
302
311
|
* @example
|
|
303
312
|
* await workast.lists.sublists.update('list-id', 'sublist-id', { name: 'Done' });
|
|
@@ -312,6 +321,7 @@ var ListSublists = class {
|
|
|
312
321
|
}
|
|
313
322
|
/**
|
|
314
323
|
* Remove a sublist.
|
|
324
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
315
325
|
*
|
|
316
326
|
* @example
|
|
317
327
|
* await workast.lists.sublists.del('list-id', 'sublist-id');
|
|
@@ -332,6 +342,7 @@ var ListParticipantsResource = class {
|
|
|
332
342
|
client;
|
|
333
343
|
/**
|
|
334
344
|
* List participants on a list.
|
|
345
|
+
* Requires one of: `list:participant:find` (least privilege) or `list:manage`.
|
|
335
346
|
*
|
|
336
347
|
* @example
|
|
337
348
|
* const users = await workast.lists.participants.list('list-id');
|
|
@@ -346,6 +357,7 @@ var ListParticipantsResource = class {
|
|
|
346
357
|
}
|
|
347
358
|
/**
|
|
348
359
|
* Add participants to a list.
|
|
360
|
+
* Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
|
|
349
361
|
*
|
|
350
362
|
* @example
|
|
351
363
|
* await workast.lists.participants.add('list-id', { users: ['user-id'] });
|
|
@@ -360,6 +372,7 @@ var ListParticipantsResource = class {
|
|
|
360
372
|
}
|
|
361
373
|
/**
|
|
362
374
|
* Remove participants from a list.
|
|
375
|
+
* Requires one of: `list:participant:manage` (least privilege) or `list:manage`.
|
|
363
376
|
*
|
|
364
377
|
* @example
|
|
365
378
|
* await workast.lists.participants.del('list-id', { users: ['user-id'] });
|
|
@@ -380,6 +393,7 @@ var ListFields = class {
|
|
|
380
393
|
client;
|
|
381
394
|
/**
|
|
382
395
|
* Enable a custom field on a list.
|
|
396
|
+
* Requires `field:manage`.
|
|
383
397
|
*
|
|
384
398
|
* @example
|
|
385
399
|
* await workast.lists.fields.enable('list-id', 'field-id');
|
|
@@ -394,6 +408,7 @@ var ListFields = class {
|
|
|
394
408
|
}
|
|
395
409
|
/**
|
|
396
410
|
* Disable a custom field on a list.
|
|
411
|
+
* Requires `field:manage`.
|
|
397
412
|
*
|
|
398
413
|
* @example
|
|
399
414
|
* await workast.lists.fields.disable('list-id', 'field-id');
|
|
@@ -420,6 +435,7 @@ var Lists = class {
|
|
|
420
435
|
fields;
|
|
421
436
|
/**
|
|
422
437
|
* Create a list.
|
|
438
|
+
* Requires one of: `list:create` (least privilege) or `list:manage`.
|
|
423
439
|
*
|
|
424
440
|
* @example
|
|
425
441
|
* const list = await workast.lists.create({ name: 'Engineering' });
|
|
@@ -429,6 +445,7 @@ var Lists = class {
|
|
|
429
445
|
}
|
|
430
446
|
/**
|
|
431
447
|
* Get a list by ID.
|
|
448
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
432
449
|
*
|
|
433
450
|
* @example
|
|
434
451
|
* const list = await workast.lists.retrieve('list-id');
|
|
@@ -438,6 +455,7 @@ var Lists = class {
|
|
|
438
455
|
}
|
|
439
456
|
/**
|
|
440
457
|
* Update a list.
|
|
458
|
+
* Requires one of: `list:update` (least privilege) or `list:manage`.
|
|
441
459
|
*
|
|
442
460
|
* @example
|
|
443
461
|
* await workast.lists.update('list-id', { name: 'Engineering' });
|
|
@@ -447,6 +465,7 @@ var Lists = class {
|
|
|
447
465
|
}
|
|
448
466
|
/**
|
|
449
467
|
* Search lists.
|
|
468
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
450
469
|
*
|
|
451
470
|
* @example
|
|
452
471
|
* const lists = await workast.lists.list({ type: 'group', limit: 10 });
|
|
@@ -494,6 +513,7 @@ var Lists = class {
|
|
|
494
513
|
}
|
|
495
514
|
/**
|
|
496
515
|
* Get the personal list.
|
|
516
|
+
* Requires one of: `list:find` (least privilege) or `list:manage`.
|
|
497
517
|
*
|
|
498
518
|
* @example
|
|
499
519
|
* const list = await workast.lists.retrievePersonal();
|
|
@@ -503,6 +523,7 @@ var Lists = class {
|
|
|
503
523
|
}
|
|
504
524
|
/**
|
|
505
525
|
* Archive a list.
|
|
526
|
+
* Requires `list:manage`.
|
|
506
527
|
*
|
|
507
528
|
* @example
|
|
508
529
|
* await workast.lists.archive('list-id');
|
|
@@ -517,6 +538,7 @@ var Lists = class {
|
|
|
517
538
|
}
|
|
518
539
|
/**
|
|
519
540
|
* Unarchive a list.
|
|
541
|
+
* Requires `list:manage`.
|
|
520
542
|
*
|
|
521
543
|
* @example
|
|
522
544
|
* await workast.lists.unarchive('list-id');
|
|
@@ -531,6 +553,7 @@ var Lists = class {
|
|
|
531
553
|
}
|
|
532
554
|
/**
|
|
533
555
|
* Join a list.
|
|
556
|
+
* Requires `list:join`.
|
|
534
557
|
*
|
|
535
558
|
* @example
|
|
536
559
|
* await workast.lists.join('list-id');
|
|
@@ -545,6 +568,7 @@ var Lists = class {
|
|
|
545
568
|
}
|
|
546
569
|
/**
|
|
547
570
|
* Request access to a private list.
|
|
571
|
+
* Requires `list:join`.
|
|
548
572
|
*
|
|
549
573
|
* @example
|
|
550
574
|
* await workast.lists.requestAccess('list-id');
|
|
@@ -559,6 +583,7 @@ var Lists = class {
|
|
|
559
583
|
}
|
|
560
584
|
/**
|
|
561
585
|
* Import a template into a list.
|
|
586
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
562
587
|
*
|
|
563
588
|
* @example
|
|
564
589
|
* await workast.lists.importTemplate('list-id', 'template-id', { updateDueDates: 30 });
|
|
@@ -581,6 +606,7 @@ var MeetingsResource = class {
|
|
|
581
606
|
client;
|
|
582
607
|
/**
|
|
583
608
|
* List meetings.
|
|
609
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
584
610
|
*
|
|
585
611
|
* @example
|
|
586
612
|
* const results = await workast.meetings.list({ timeMin: '2026-01-01T00:00:00Z', maxResults: 15 });
|
|
@@ -613,6 +639,7 @@ var MeetingsResource = class {
|
|
|
613
639
|
}
|
|
614
640
|
/**
|
|
615
641
|
* Create a meeting from a calendar event, or create a new calendar event.
|
|
642
|
+
* Requires `meeting:manage`.
|
|
616
643
|
*
|
|
617
644
|
* @example
|
|
618
645
|
* const meeting = await workast.meetings.createFromEvent({
|
|
@@ -626,6 +653,7 @@ var MeetingsResource = class {
|
|
|
626
653
|
}
|
|
627
654
|
/**
|
|
628
655
|
* Get a meeting by ID.
|
|
656
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
629
657
|
*
|
|
630
658
|
* @example
|
|
631
659
|
* const meeting = await workast.meetings.retrieve('meeting-id');
|
|
@@ -635,6 +663,7 @@ var MeetingsResource = class {
|
|
|
635
663
|
}
|
|
636
664
|
/**
|
|
637
665
|
* Update meeting notes.
|
|
666
|
+
* Requires `meeting:manage`.
|
|
638
667
|
*
|
|
639
668
|
* @example
|
|
640
669
|
* const meeting = await workast.meetings.update('meeting-id', { notes: 'Ship v3' });
|
|
@@ -644,6 +673,7 @@ var MeetingsResource = class {
|
|
|
644
673
|
}
|
|
645
674
|
/**
|
|
646
675
|
* Get meeting recording assets and transcript.
|
|
676
|
+
* Requires one of: `meeting:find` (least privilege) or `meeting:manage`.
|
|
647
677
|
*
|
|
648
678
|
* @example
|
|
649
679
|
* const recording = await workast.meetings.retrieveRecording('meeting-id');
|
|
@@ -658,6 +688,7 @@ var MeetingsResource = class {
|
|
|
658
688
|
}
|
|
659
689
|
/**
|
|
660
690
|
* Enable the notetaker for a meeting.
|
|
691
|
+
* Requires `meeting:manage`.
|
|
661
692
|
*
|
|
662
693
|
* @example
|
|
663
694
|
* const meeting = await workast.meetings.enableNotetaker('meeting-id', {
|
|
@@ -674,6 +705,7 @@ var MeetingsResource = class {
|
|
|
674
705
|
}
|
|
675
706
|
/**
|
|
676
707
|
* Disable or remove the notetaker from a meeting.
|
|
708
|
+
* Requires `meeting:manage`.
|
|
677
709
|
*
|
|
678
710
|
* @example
|
|
679
711
|
* const meeting = await workast.meetings.disableNotetaker('meeting-id');
|
|
@@ -696,6 +728,7 @@ var NotesResource = class {
|
|
|
696
728
|
client;
|
|
697
729
|
/**
|
|
698
730
|
* List notes.
|
|
731
|
+
* Requires one of: `note:find` (least privilege) or `note:manage`.
|
|
699
732
|
*
|
|
700
733
|
* @example
|
|
701
734
|
* const results = await workast.notes.list({ title: 'Spec', limit: 10 });
|
|
@@ -736,6 +769,7 @@ var NotesResource = class {
|
|
|
736
769
|
}
|
|
737
770
|
/**
|
|
738
771
|
* Get a note by ID.
|
|
772
|
+
* Requires one of: `note:find` (least privilege) or `note:manage`.
|
|
739
773
|
*
|
|
740
774
|
* @example
|
|
741
775
|
* const note = await workast.notes.retrieve('note-id');
|
|
@@ -745,6 +779,7 @@ var NotesResource = class {
|
|
|
745
779
|
}
|
|
746
780
|
/**
|
|
747
781
|
* Update a note.
|
|
782
|
+
* Requires one of: `note:update` (least privilege) or `note:manage`.
|
|
748
783
|
*
|
|
749
784
|
* @example
|
|
750
785
|
* const note = await workast.notes.update('note-id', { title: 'Spec', version: 1, body: '<p>Hello</p>' });
|
|
@@ -754,6 +789,7 @@ var NotesResource = class {
|
|
|
754
789
|
}
|
|
755
790
|
/**
|
|
756
791
|
* Delete a note.
|
|
792
|
+
* Requires `note:manage`.
|
|
757
793
|
*
|
|
758
794
|
* @example
|
|
759
795
|
* await workast.notes.del('note-id');
|
|
@@ -771,6 +807,7 @@ var NotificationsResource = class {
|
|
|
771
807
|
client;
|
|
772
808
|
/**
|
|
773
809
|
* List notifications for the logged-in user.
|
|
810
|
+
* Requires one of: `notification:find` (least privilege) or `notification:manage`.
|
|
774
811
|
*
|
|
775
812
|
* @example
|
|
776
813
|
* const results = await workast.notifications.list({ read: false, limit: 10 });
|
|
@@ -798,6 +835,7 @@ var NotificationsResource = class {
|
|
|
798
835
|
}
|
|
799
836
|
/**
|
|
800
837
|
* Mark a notification as read.
|
|
838
|
+
* Requires `notification:manage`.
|
|
801
839
|
*
|
|
802
840
|
* @example
|
|
803
841
|
* await workast.notifications.markRead('notification-id');
|
|
@@ -812,6 +850,7 @@ var NotificationsResource = class {
|
|
|
812
850
|
}
|
|
813
851
|
/**
|
|
814
852
|
* Mark a notification as unread.
|
|
853
|
+
* Requires `notification:manage`.
|
|
815
854
|
*
|
|
816
855
|
* @example
|
|
817
856
|
* await workast.notifications.markUnread('notification-id');
|
|
@@ -834,6 +873,7 @@ var Reactions = class {
|
|
|
834
873
|
client;
|
|
835
874
|
/**
|
|
836
875
|
* Add a reaction to an activity.
|
|
876
|
+
* Requires one of: `activity:react` (least privilege) or `task:manage`.
|
|
837
877
|
*
|
|
838
878
|
* @example
|
|
839
879
|
* const reaction = await workast.reactions.add('activity-id', { emoji: ':+1:' });
|
|
@@ -848,6 +888,7 @@ var Reactions = class {
|
|
|
848
888
|
}
|
|
849
889
|
/**
|
|
850
890
|
* Remove a reaction from an activity.
|
|
891
|
+
* Requires one of: `activity:react` (least privilege) or `task:manage`.
|
|
851
892
|
*
|
|
852
893
|
* @example
|
|
853
894
|
* await workast.reactions.del('activity-id', 'reaction-id');
|
|
@@ -870,9 +911,10 @@ var SearchesResource = class {
|
|
|
870
911
|
client;
|
|
871
912
|
/**
|
|
872
913
|
* List searches for the logged-in user.
|
|
914
|
+
* Requires one of: `search:find` (least privilege) or `search:manage`.
|
|
873
915
|
*
|
|
874
916
|
* @example
|
|
875
|
-
* const results = await workast.searches.list({
|
|
917
|
+
* const results = await workast.searches.list({ limit: 10 });
|
|
876
918
|
*/
|
|
877
919
|
list(query, options) {
|
|
878
920
|
const params = new URLSearchParams(options?.query);
|
|
@@ -885,9 +927,6 @@ var SearchesResource = class {
|
|
|
885
927
|
if (query?.sort) {
|
|
886
928
|
params.set("sort", query.sort);
|
|
887
929
|
}
|
|
888
|
-
if (query?.home != null) {
|
|
889
|
-
params.set("home", String(query.home));
|
|
890
|
-
}
|
|
891
930
|
return this.client.request(
|
|
892
931
|
"GET",
|
|
893
932
|
"/search",
|
|
@@ -897,6 +936,7 @@ var SearchesResource = class {
|
|
|
897
936
|
}
|
|
898
937
|
/**
|
|
899
938
|
* Create a search.
|
|
939
|
+
* Requires `search:manage`.
|
|
900
940
|
*
|
|
901
941
|
* @example
|
|
902
942
|
* const search = await workast.searches.create({
|
|
@@ -909,6 +949,7 @@ var SearchesResource = class {
|
|
|
909
949
|
}
|
|
910
950
|
/**
|
|
911
951
|
* Get a search by ID.
|
|
952
|
+
* Requires one of: `search:find` (least privilege) or `search:manage`.
|
|
912
953
|
*
|
|
913
954
|
* @example
|
|
914
955
|
* const search = await workast.searches.retrieve('search-id');
|
|
@@ -932,6 +973,7 @@ var SearchesResource = class {
|
|
|
932
973
|
}
|
|
933
974
|
/**
|
|
934
975
|
* Update a search.
|
|
976
|
+
* Requires `search:manage`.
|
|
935
977
|
*
|
|
936
978
|
* @example
|
|
937
979
|
* const search = await workast.searches.update('search-id', { name: 'Updated' });
|
|
@@ -946,6 +988,7 @@ var SearchesResource = class {
|
|
|
946
988
|
}
|
|
947
989
|
/**
|
|
948
990
|
* Delete a search.
|
|
991
|
+
* Requires `search:manage`.
|
|
949
992
|
*
|
|
950
993
|
* @example
|
|
951
994
|
* await workast.searches.del('search-id');
|
|
@@ -958,8 +1001,31 @@ var SearchesResource = class {
|
|
|
958
1001
|
options
|
|
959
1002
|
);
|
|
960
1003
|
}
|
|
1004
|
+
/**
|
|
1005
|
+
* List searches pinned on the home screen.
|
|
1006
|
+
* Requires one of: `home:search:find` (least privilege) or `home:search:manage`.
|
|
1007
|
+
*
|
|
1008
|
+
* @example
|
|
1009
|
+
* const results = await workast.searches.listHome({ limit: 10 });
|
|
1010
|
+
*/
|
|
1011
|
+
listHome(query, options) {
|
|
1012
|
+
const params = new URLSearchParams(options?.query);
|
|
1013
|
+
if (query?.limit != null) {
|
|
1014
|
+
params.set("limit", String(query.limit));
|
|
1015
|
+
}
|
|
1016
|
+
if (query?.skip != null) {
|
|
1017
|
+
params.set("skip", String(query.skip));
|
|
1018
|
+
}
|
|
1019
|
+
return this.client.request(
|
|
1020
|
+
"GET",
|
|
1021
|
+
"/search/home",
|
|
1022
|
+
void 0,
|
|
1023
|
+
params.toString() ? { ...options, query: params } : options
|
|
1024
|
+
);
|
|
1025
|
+
}
|
|
961
1026
|
/**
|
|
962
1027
|
* Add a search to the home screen.
|
|
1028
|
+
* Requires `home:search:manage`.
|
|
963
1029
|
*
|
|
964
1030
|
* @example
|
|
965
1031
|
* await workast.searches.addHome('search-id');
|
|
@@ -974,6 +1040,7 @@ var SearchesResource = class {
|
|
|
974
1040
|
}
|
|
975
1041
|
/**
|
|
976
1042
|
* Remove a search from the home screen.
|
|
1043
|
+
* Requires `home:search:manage`.
|
|
977
1044
|
*
|
|
978
1045
|
* @example
|
|
979
1046
|
* await workast.searches.removeHome('search-id');
|
|
@@ -988,6 +1055,7 @@ var SearchesResource = class {
|
|
|
988
1055
|
}
|
|
989
1056
|
/**
|
|
990
1057
|
* Share a search with users.
|
|
1058
|
+
* Requires `search:manage`.
|
|
991
1059
|
*
|
|
992
1060
|
* @example
|
|
993
1061
|
* await workast.searches.share('search-id', { users: ['user-id'] });
|
|
@@ -1002,6 +1070,7 @@ var SearchesResource = class {
|
|
|
1002
1070
|
}
|
|
1003
1071
|
/**
|
|
1004
1072
|
* Unshare a search from users.
|
|
1073
|
+
* Requires `search:manage`.
|
|
1005
1074
|
*
|
|
1006
1075
|
* @example
|
|
1007
1076
|
* await workast.searches.unshare('search-id', { users: ['user-id'] });
|
|
@@ -1016,6 +1085,7 @@ var SearchesResource = class {
|
|
|
1016
1085
|
}
|
|
1017
1086
|
/**
|
|
1018
1087
|
* Set a reminder on a search.
|
|
1088
|
+
* Requires `search:manage`.
|
|
1019
1089
|
*
|
|
1020
1090
|
* @example
|
|
1021
1091
|
* await workast.searches.setReminder('search-id', {
|
|
@@ -1032,6 +1102,7 @@ var SearchesResource = class {
|
|
|
1032
1102
|
}
|
|
1033
1103
|
/**
|
|
1034
1104
|
* Delete a reminder from a search.
|
|
1105
|
+
* Requires `search:manage`.
|
|
1035
1106
|
*
|
|
1036
1107
|
* @example
|
|
1037
1108
|
* await workast.searches.delReminder('search-id');
|
|
@@ -1054,6 +1125,7 @@ var Tags = class {
|
|
|
1054
1125
|
client;
|
|
1055
1126
|
/**
|
|
1056
1127
|
* List tags in the team.
|
|
1128
|
+
* Requires one of: `tag:find` (least privilege) or `tag:manage`.
|
|
1057
1129
|
*
|
|
1058
1130
|
* @example
|
|
1059
1131
|
* const tags = await workast.tags.list({ listId: 'list-id' });
|
|
@@ -1075,6 +1147,7 @@ var Tags = class {
|
|
|
1075
1147
|
}
|
|
1076
1148
|
/**
|
|
1077
1149
|
* Create a tag.
|
|
1150
|
+
* Requires `tag:manage`.
|
|
1078
1151
|
*
|
|
1079
1152
|
* @example
|
|
1080
1153
|
* const tag = await workast.tags.create({ name: 'Priority', color: '#ff0000' });
|
|
@@ -1084,6 +1157,7 @@ var Tags = class {
|
|
|
1084
1157
|
}
|
|
1085
1158
|
/**
|
|
1086
1159
|
* Update a tag.
|
|
1160
|
+
* Requires `tag:manage`.
|
|
1087
1161
|
*
|
|
1088
1162
|
* @example
|
|
1089
1163
|
* const tag = await workast.tags.update('tag-id', { name: 'Priority' });
|
|
@@ -1098,6 +1172,7 @@ var Tags = class {
|
|
|
1098
1172
|
}
|
|
1099
1173
|
/**
|
|
1100
1174
|
* Delete a tag.
|
|
1175
|
+
* Requires `tag:manage`.
|
|
1101
1176
|
*
|
|
1102
1177
|
* @example
|
|
1103
1178
|
* await workast.tags.del('tag-id');
|
|
@@ -1120,6 +1195,7 @@ var TaskSubtasks = class {
|
|
|
1120
1195
|
client;
|
|
1121
1196
|
/**
|
|
1122
1197
|
* Create a subtask on a task.
|
|
1198
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
1123
1199
|
*
|
|
1124
1200
|
* @example
|
|
1125
1201
|
* const subtask = await workast.tasks.subtasks.create('task-id', { text: 'Write tests' });
|
|
@@ -1135,6 +1211,7 @@ var TaskDependencies = class {
|
|
|
1135
1211
|
client;
|
|
1136
1212
|
/**
|
|
1137
1213
|
* Add a dependency to a task.
|
|
1214
|
+
* Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
|
|
1138
1215
|
*
|
|
1139
1216
|
* @example
|
|
1140
1217
|
* await workast.tasks.dependencies.add('task-id', 'dependency-id');
|
|
@@ -1149,6 +1226,7 @@ var TaskDependencies = class {
|
|
|
1149
1226
|
}
|
|
1150
1227
|
/**
|
|
1151
1228
|
* Remove a dependency from a task.
|
|
1229
|
+
* Requires one of: `task:manage:dependency` (least privilege) or `task:manage`.
|
|
1152
1230
|
*
|
|
1153
1231
|
* @example
|
|
1154
1232
|
* await workast.tasks.dependencies.del('task-id', 'dependency-id');
|
|
@@ -1169,6 +1247,7 @@ var TaskAttachments = class {
|
|
|
1169
1247
|
client;
|
|
1170
1248
|
/**
|
|
1171
1249
|
* Create an attachment on a task.
|
|
1250
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
1172
1251
|
*
|
|
1173
1252
|
* @example
|
|
1174
1253
|
* const attachment = await workast.tasks.attachments.create('task-id', { author: 'user-id' });
|
|
@@ -1178,6 +1257,7 @@ var TaskAttachments = class {
|
|
|
1178
1257
|
}
|
|
1179
1258
|
/**
|
|
1180
1259
|
* Update a task attachment.
|
|
1260
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
1181
1261
|
*
|
|
1182
1262
|
* @example
|
|
1183
1263
|
* const attachment = await workast.tasks.attachments.update('task-id', 'attachment-id', { date: '2026-01-01' });
|
|
@@ -1192,6 +1272,7 @@ var TaskAttachments = class {
|
|
|
1192
1272
|
}
|
|
1193
1273
|
/**
|
|
1194
1274
|
* Delete a task attachment.
|
|
1275
|
+
* Requires one of: `task:manage:attachment` (least privilege) or `task:manage`.
|
|
1195
1276
|
*
|
|
1196
1277
|
* @example
|
|
1197
1278
|
* await workast.tasks.attachments.del('task-id', 'attachment-id');
|
|
@@ -1212,6 +1293,7 @@ var TaskActivitiesResource = class {
|
|
|
1212
1293
|
client;
|
|
1213
1294
|
/**
|
|
1214
1295
|
* List activities on a task.
|
|
1296
|
+
* Requires one of: `task:activity:find` (least privilege) or `task:manage`.
|
|
1215
1297
|
*
|
|
1216
1298
|
* @example
|
|
1217
1299
|
* const results = await workast.tasks.activities.list('task-id', { type: ['comment'], limit: 10 });
|
|
@@ -1246,6 +1328,7 @@ var TaskActivitiesResource = class {
|
|
|
1246
1328
|
}
|
|
1247
1329
|
/**
|
|
1248
1330
|
* Create a comment activity on a task.
|
|
1331
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
1249
1332
|
*
|
|
1250
1333
|
* @example
|
|
1251
1334
|
* const activity = await workast.tasks.activities.create('task-id', { type: 'comment', value: 'Looks good' });
|
|
@@ -1255,6 +1338,7 @@ var TaskActivitiesResource = class {
|
|
|
1255
1338
|
}
|
|
1256
1339
|
/**
|
|
1257
1340
|
* Update a task activity.
|
|
1341
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
1258
1342
|
*
|
|
1259
1343
|
* @example
|
|
1260
1344
|
* await workast.tasks.activities.update('task-id', 'activity-id', { value: 'Updated comment' });
|
|
@@ -1269,6 +1353,7 @@ var TaskActivitiesResource = class {
|
|
|
1269
1353
|
}
|
|
1270
1354
|
/**
|
|
1271
1355
|
* Delete a task activity.
|
|
1356
|
+
* Requires one of: `task:manage:activity` (least privilege) or `task:manage`.
|
|
1272
1357
|
*
|
|
1273
1358
|
* @example
|
|
1274
1359
|
* await workast.tasks.activities.del('task-id', 'activity-id');
|
|
@@ -1297,6 +1382,7 @@ var Tasks = class {
|
|
|
1297
1382
|
activities;
|
|
1298
1383
|
/**
|
|
1299
1384
|
* Create a task in a list.
|
|
1385
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
1300
1386
|
*
|
|
1301
1387
|
* @example
|
|
1302
1388
|
* const task = await workast.tasks.create('list-id', { text: 'Ship v3' });
|
|
@@ -1304,8 +1390,19 @@ var Tasks = class {
|
|
|
1304
1390
|
create(listId, body, options) {
|
|
1305
1391
|
return this.client.request("POST", `/list/${encodeURIComponent(listId)}/task`, body, options);
|
|
1306
1392
|
}
|
|
1393
|
+
/**
|
|
1394
|
+
* Create a task in the personal list.
|
|
1395
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
1396
|
+
*
|
|
1397
|
+
* @example
|
|
1398
|
+
* const task = await workast.tasks.createPersonal({ text: 'Ship v3' });
|
|
1399
|
+
*/
|
|
1400
|
+
createPersonal(body, options) {
|
|
1401
|
+
return this.client.request("POST", "/list/personal/task", body, options);
|
|
1402
|
+
}
|
|
1307
1403
|
/**
|
|
1308
1404
|
* Get a task by ID.
|
|
1405
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
1309
1406
|
*
|
|
1310
1407
|
* @example
|
|
1311
1408
|
* const task = await workast.tasks.retrieve('task-id');
|
|
@@ -1315,6 +1412,7 @@ var Tasks = class {
|
|
|
1315
1412
|
}
|
|
1316
1413
|
/**
|
|
1317
1414
|
* Get a task by short ID.
|
|
1415
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
1318
1416
|
*
|
|
1319
1417
|
* @example
|
|
1320
1418
|
* const task = await workast.tasks.retrieveByShortId('t4k1');
|
|
@@ -1324,6 +1422,7 @@ var Tasks = class {
|
|
|
1324
1422
|
}
|
|
1325
1423
|
/**
|
|
1326
1424
|
* Update a task.
|
|
1425
|
+
* Requires `task:manage`.
|
|
1327
1426
|
*
|
|
1328
1427
|
* @example
|
|
1329
1428
|
* await workast.tasks.update('task-id', { text: 'Ship v3' });
|
|
@@ -1333,6 +1432,7 @@ var Tasks = class {
|
|
|
1333
1432
|
}
|
|
1334
1433
|
/**
|
|
1335
1434
|
* Delete a task.
|
|
1435
|
+
* Requires one of: `task:manage:remove` (least privilege) or `task:manage`.
|
|
1336
1436
|
*
|
|
1337
1437
|
* @example
|
|
1338
1438
|
* await workast.tasks.del('task-id');
|
|
@@ -1342,6 +1442,7 @@ var Tasks = class {
|
|
|
1342
1442
|
}
|
|
1343
1443
|
/**
|
|
1344
1444
|
* Search tasks.
|
|
1445
|
+
* Requires one of: `task:find` (least privilege) or `task:manage`.
|
|
1345
1446
|
*
|
|
1346
1447
|
* @example
|
|
1347
1448
|
* const results = await workast.tasks.list({
|
|
@@ -1353,6 +1454,7 @@ var Tasks = class {
|
|
|
1353
1454
|
}
|
|
1354
1455
|
/**
|
|
1355
1456
|
* Complete a task.
|
|
1457
|
+
* Requires one of: `task:manage:status` (least privilege) or `task:manage`.
|
|
1356
1458
|
*
|
|
1357
1459
|
* @example
|
|
1358
1460
|
* await workast.tasks.complete('task-id');
|
|
@@ -1362,6 +1464,7 @@ var Tasks = class {
|
|
|
1362
1464
|
}
|
|
1363
1465
|
/**
|
|
1364
1466
|
* Uncomplete a task.
|
|
1467
|
+
* Requires one of: `task:manage:status` (least privilege) or `task:manage`.
|
|
1365
1468
|
*
|
|
1366
1469
|
* @example
|
|
1367
1470
|
* await workast.tasks.uncomplete('task-id');
|
|
@@ -1371,6 +1474,7 @@ var Tasks = class {
|
|
|
1371
1474
|
}
|
|
1372
1475
|
/**
|
|
1373
1476
|
* Assign users to a task.
|
|
1477
|
+
* Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
|
|
1374
1478
|
*
|
|
1375
1479
|
* @example
|
|
1376
1480
|
* await workast.tasks.assign('task-id', { users: ['user-id'] });
|
|
@@ -1380,6 +1484,7 @@ var Tasks = class {
|
|
|
1380
1484
|
}
|
|
1381
1485
|
/**
|
|
1382
1486
|
* Unassign users from a task.
|
|
1487
|
+
* Requires one of: `task:manage:assignee` (least privilege) or `task:manage`.
|
|
1383
1488
|
*
|
|
1384
1489
|
* @example
|
|
1385
1490
|
* await workast.tasks.unassign('task-id', { users: ['user-id'] });
|
|
@@ -1389,6 +1494,7 @@ var Tasks = class {
|
|
|
1389
1494
|
}
|
|
1390
1495
|
/**
|
|
1391
1496
|
* Add followers to a task.
|
|
1497
|
+
* Requires `user:task:follow`.
|
|
1392
1498
|
*
|
|
1393
1499
|
* @example
|
|
1394
1500
|
* await workast.tasks.follow('task-id', { users: ['user-id'] });
|
|
@@ -1398,6 +1504,7 @@ var Tasks = class {
|
|
|
1398
1504
|
}
|
|
1399
1505
|
/**
|
|
1400
1506
|
* Remove followers from a task.
|
|
1507
|
+
* Requires `user:task:follow`.
|
|
1401
1508
|
*
|
|
1402
1509
|
* @example
|
|
1403
1510
|
* await workast.tasks.unfollow('task-id', { users: ['user-id'] });
|
|
@@ -1407,6 +1514,7 @@ var Tasks = class {
|
|
|
1407
1514
|
}
|
|
1408
1515
|
/**
|
|
1409
1516
|
* Move tasks to another list.
|
|
1517
|
+
* Requires one of: `task:manage:move` (least privilege) or `task:manage`.
|
|
1410
1518
|
*
|
|
1411
1519
|
* @example
|
|
1412
1520
|
* await workast.tasks.move('list-id', { tasks: ['task-id'], target: 'other-list-id' });
|
|
@@ -1416,6 +1524,7 @@ var Tasks = class {
|
|
|
1416
1524
|
}
|
|
1417
1525
|
/**
|
|
1418
1526
|
* Create many tasks in a list.
|
|
1527
|
+
* Requires one of: `task:create` (least privilege) or `task:manage`.
|
|
1419
1528
|
*
|
|
1420
1529
|
* @example
|
|
1421
1530
|
* await workast.tasks.createMany('list-id', [{ text: 'One' }, { text: 'Two' }]);
|
|
@@ -1425,6 +1534,7 @@ var Tasks = class {
|
|
|
1425
1534
|
}
|
|
1426
1535
|
/**
|
|
1427
1536
|
* Update many tasks.
|
|
1537
|
+
* Requires `task:manage`.
|
|
1428
1538
|
*
|
|
1429
1539
|
* @example
|
|
1430
1540
|
* const result = await workast.tasks.updateMany({ tasks: ['task-id'], status: 'done' });
|
|
@@ -1434,6 +1544,7 @@ var Tasks = class {
|
|
|
1434
1544
|
}
|
|
1435
1545
|
/**
|
|
1436
1546
|
* List home (favourite) tasks.
|
|
1547
|
+
* Requires one of: `home:task:find` (least privilege) or `home:task:manage`.
|
|
1437
1548
|
*
|
|
1438
1549
|
* @example
|
|
1439
1550
|
* const home = await workast.tasks.listHome();
|
|
@@ -1443,6 +1554,7 @@ var Tasks = class {
|
|
|
1443
1554
|
}
|
|
1444
1555
|
/**
|
|
1445
1556
|
* Add a task to the home screen.
|
|
1557
|
+
* Requires `home:task:manage`.
|
|
1446
1558
|
*
|
|
1447
1559
|
* @example
|
|
1448
1560
|
* await workast.tasks.addHome('task-id');
|
|
@@ -1452,6 +1564,7 @@ var Tasks = class {
|
|
|
1452
1564
|
}
|
|
1453
1565
|
/**
|
|
1454
1566
|
* Remove a task from the home screen.
|
|
1567
|
+
* Requires `home:task:manage`.
|
|
1455
1568
|
*
|
|
1456
1569
|
* @example
|
|
1457
1570
|
* await workast.tasks.removeHome('task-id');
|
|
@@ -1461,6 +1574,7 @@ var Tasks = class {
|
|
|
1461
1574
|
}
|
|
1462
1575
|
/**
|
|
1463
1576
|
* Add tags to a task.
|
|
1577
|
+
* Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
|
|
1464
1578
|
*
|
|
1465
1579
|
* @example
|
|
1466
1580
|
* await workast.tasks.addTag('task-id', { tags: ['tag-id'] });
|
|
@@ -1470,6 +1584,7 @@ var Tasks = class {
|
|
|
1470
1584
|
}
|
|
1471
1585
|
/**
|
|
1472
1586
|
* Remove tags from a task.
|
|
1587
|
+
* Requires one of: `task:manage:tag` (least privilege) or `task:manage`.
|
|
1473
1588
|
*
|
|
1474
1589
|
* @example
|
|
1475
1590
|
* await workast.tasks.removeTag('task-id', { tags: ['tag-id'] });
|
|
@@ -1479,6 +1594,7 @@ var Tasks = class {
|
|
|
1479
1594
|
}
|
|
1480
1595
|
/**
|
|
1481
1596
|
* Convert a task into a subtask of another task.
|
|
1597
|
+
* Requires `task:manage`.
|
|
1482
1598
|
*
|
|
1483
1599
|
* @example
|
|
1484
1600
|
* await workast.tasks.convertToSubtask('task-id', { parentTaskId: 'parent-id' });
|
|
@@ -1493,6 +1609,7 @@ var Tasks = class {
|
|
|
1493
1609
|
}
|
|
1494
1610
|
/**
|
|
1495
1611
|
* Convert a subtask into a standalone task.
|
|
1612
|
+
* Requires `task:manage`.
|
|
1496
1613
|
*
|
|
1497
1614
|
* @example
|
|
1498
1615
|
* const task = await workast.tasks.convertToTask('task-id');
|
|
@@ -1515,6 +1632,7 @@ var Tokens = class {
|
|
|
1515
1632
|
client;
|
|
1516
1633
|
/**
|
|
1517
1634
|
* Get the token details.
|
|
1635
|
+
* Requires any authenticated token (no specific scope).
|
|
1518
1636
|
*
|
|
1519
1637
|
* @example
|
|
1520
1638
|
* const token = await workast.tokens.retrieve();
|
|
@@ -1544,6 +1662,7 @@ var Users = class {
|
|
|
1544
1662
|
client;
|
|
1545
1663
|
/**
|
|
1546
1664
|
* Get the logged-in user.
|
|
1665
|
+
* Requires any authenticated token (no specific scope).
|
|
1547
1666
|
*
|
|
1548
1667
|
* @example
|
|
1549
1668
|
* const me = await workast.users.me();
|
|
@@ -1553,6 +1672,7 @@ var Users = class {
|
|
|
1553
1672
|
}
|
|
1554
1673
|
/**
|
|
1555
1674
|
* List users in the team.
|
|
1675
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
1556
1676
|
*
|
|
1557
1677
|
* @example
|
|
1558
1678
|
* const users = await workast.users.list({ name: 'Ada', limit: 10 });
|
|
@@ -1590,6 +1710,7 @@ var Users = class {
|
|
|
1590
1710
|
}
|
|
1591
1711
|
/**
|
|
1592
1712
|
* Get a user by ID.
|
|
1713
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
1593
1714
|
*
|
|
1594
1715
|
* @example
|
|
1595
1716
|
* const user = await workast.users.retrieve('user-id');
|
|
@@ -1599,6 +1720,7 @@ var Users = class {
|
|
|
1599
1720
|
}
|
|
1600
1721
|
/**
|
|
1601
1722
|
* Get a user by email.
|
|
1723
|
+
* Requires one of: `user:find` (least privilege) or `user:manage`.
|
|
1602
1724
|
*
|
|
1603
1725
|
* @example
|
|
1604
1726
|
* const user = await workast.users.retrieveByEmail('ada@example.com');
|
|
@@ -1617,6 +1739,7 @@ var Users = class {
|
|
|
1617
1739
|
}
|
|
1618
1740
|
/**
|
|
1619
1741
|
* Invite a user to the team.
|
|
1742
|
+
* Requires one of: `user:invite` (least privilege) or `user:manage`.
|
|
1620
1743
|
*
|
|
1621
1744
|
* @example
|
|
1622
1745
|
* const user = await workast.users.invite({ name: 'Ada', email: 'ada@example.com', role: 'member' });
|
|
@@ -1644,6 +1767,7 @@ var WorkflowsResource = class {
|
|
|
1644
1767
|
client;
|
|
1645
1768
|
/**
|
|
1646
1769
|
* List workflows created by the logged-in user.
|
|
1770
|
+
* Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
|
|
1647
1771
|
*
|
|
1648
1772
|
* @example
|
|
1649
1773
|
* const results = await workast.workflows.list({ limit: 10, skip: 0 });
|
|
@@ -1653,6 +1777,7 @@ var WorkflowsResource = class {
|
|
|
1653
1777
|
}
|
|
1654
1778
|
/**
|
|
1655
1779
|
* Create a workflow.
|
|
1780
|
+
* Requires `workflow:manage`.
|
|
1656
1781
|
*
|
|
1657
1782
|
* @example
|
|
1658
1783
|
* const workflow = await workast.workflows.create({
|
|
@@ -1667,6 +1792,7 @@ var WorkflowsResource = class {
|
|
|
1667
1792
|
}
|
|
1668
1793
|
/**
|
|
1669
1794
|
* Get a workflow by ID.
|
|
1795
|
+
* Requires one of: `workflow:find` (least privilege) or `workflow:manage`.
|
|
1670
1796
|
*
|
|
1671
1797
|
* @example
|
|
1672
1798
|
* const workflow = await workast.workflows.retrieve('workflow-id');
|
|
@@ -1681,6 +1807,7 @@ var WorkflowsResource = class {
|
|
|
1681
1807
|
}
|
|
1682
1808
|
/**
|
|
1683
1809
|
* Update a workflow.
|
|
1810
|
+
* Requires `workflow:manage`.
|
|
1684
1811
|
*
|
|
1685
1812
|
* @example
|
|
1686
1813
|
* await workast.workflows.update('workflow-id', { prompt: 'Ship v3' });
|
|
@@ -1695,6 +1822,7 @@ var WorkflowsResource = class {
|
|
|
1695
1822
|
}
|
|
1696
1823
|
/**
|
|
1697
1824
|
* Delete a workflow.
|
|
1825
|
+
* Requires `workflow:manage`.
|
|
1698
1826
|
*
|
|
1699
1827
|
* @example
|
|
1700
1828
|
* await workast.workflows.del('workflow-id');
|
|
@@ -1709,6 +1837,7 @@ var WorkflowsResource = class {
|
|
|
1709
1837
|
}
|
|
1710
1838
|
/**
|
|
1711
1839
|
* Activate a workflow.
|
|
1840
|
+
* Requires `workflow:manage`.
|
|
1712
1841
|
*
|
|
1713
1842
|
* @example
|
|
1714
1843
|
* await workast.workflows.activate('workflow-id');
|
|
@@ -1723,6 +1852,7 @@ var WorkflowsResource = class {
|
|
|
1723
1852
|
}
|
|
1724
1853
|
/**
|
|
1725
1854
|
* Deactivate a workflow.
|
|
1855
|
+
* Requires `workflow:manage`.
|
|
1726
1856
|
*
|
|
1727
1857
|
* @example
|
|
1728
1858
|
* await workast.workflows.deactivate('workflow-id');
|
|
@@ -1848,4 +1978,4 @@ export {
|
|
|
1848
1978
|
ValidationError,
|
|
1849
1979
|
Workast
|
|
1850
1980
|
};
|
|
1851
|
-
//# sourceMappingURL=chunk-
|
|
1981
|
+
//# sourceMappingURL=chunk-77N6V6HL.js.map
|