initiative-plugin-sdk 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -4
- package/dist/client.js +4 -2
- package/dist/client.js.map +1 -1
- package/dist/contract.d.ts +26 -3
- package/dist/contract.js +5 -3
- package/dist/contract.js.map +1 -1
- package/dist/define.d.ts +2 -0
- package/dist/define.js +1 -0
- package/dist/define.js.map +1 -1
- package/dist/plugin-api.generated.d.ts +585 -180
- package/dist/plugin-api.generated.js +186 -42
- package/dist/plugin-api.generated.js.map +1 -1
- package/dist/validate.js +37 -0
- package/dist/validate.js.map +1 -1
- package/manifest.contract.json +24 -3
- package/package.json +1 -1
- package/schemas/env-contract.json +58 -0
- package/schemas/plugin-manifest.json +21 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Generated by scripts/generate-plugin-api.mjs from Initiative 0.74.0's plug-in API
|
|
3
|
-
* (a checkout at
|
|
3
|
+
* (a checkout at 7f3b18767). Do not edit: regenerate.
|
|
4
4
|
*/
|
|
5
5
|
import type { Scope } from "./contract.js";
|
|
6
6
|
/**
|
|
@@ -31,7 +31,7 @@ export interface PluginApiSchemas {
|
|
|
31
31
|
/**
|
|
32
32
|
* Things that can be archived.
|
|
33
33
|
*/
|
|
34
|
-
ArchivableType: "project" | "
|
|
34
|
+
ArchivableType: "project" | "file" | "queue" | "counter_group" | "calendar" | "dashboard" | "post" | "gallery" | "wiki" | "task" | "initiative";
|
|
35
35
|
/**
|
|
36
36
|
* What archiving or unarchiving answers with.
|
|
37
37
|
*/
|
|
@@ -40,6 +40,14 @@ export interface PluginApiSchemas {
|
|
|
40
40
|
entity_id: number;
|
|
41
41
|
archived_at?: string | null;
|
|
42
42
|
};
|
|
43
|
+
Body_upload_gallery_image: {
|
|
44
|
+
file: string;
|
|
45
|
+
title?: string | null;
|
|
46
|
+
caption?: string | null;
|
|
47
|
+
};
|
|
48
|
+
Body_upload_gallery_image_version: {
|
|
49
|
+
file: string;
|
|
50
|
+
};
|
|
43
51
|
CalendarCreate: {
|
|
44
52
|
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
45
53
|
name: string;
|
|
@@ -68,12 +76,6 @@ export interface PluginApiSchemas {
|
|
|
68
76
|
tz?: string | null;
|
|
69
77
|
attendee_ids?: string[] | null;
|
|
70
78
|
tag_ids?: number[] | null;
|
|
71
|
-
document_ids?: number[] | null;
|
|
72
|
-
};
|
|
73
|
-
CalendarEventDocumentRead: {
|
|
74
|
-
document_id: number;
|
|
75
|
-
name?: string;
|
|
76
|
-
attached_at: string;
|
|
77
79
|
};
|
|
78
80
|
CalendarEventRead: {
|
|
79
81
|
title: string;
|
|
@@ -100,7 +102,6 @@ export interface PluginApiSchemas {
|
|
|
100
102
|
created_at: string;
|
|
101
103
|
updated_at: string;
|
|
102
104
|
attendees: PluginApiSchemas["CalendarEventAttendeeRead"][];
|
|
103
|
-
documents: PluginApiSchemas["CalendarEventDocumentRead"][];
|
|
104
105
|
overridden_fields: string[];
|
|
105
106
|
skipped_starts: string[];
|
|
106
107
|
extra_starts: string[];
|
|
@@ -220,8 +221,8 @@ export interface PluginApiSchemas {
|
|
|
220
221
|
content: string;
|
|
221
222
|
task_id?: number | null;
|
|
222
223
|
wiki_page_id?: number | null;
|
|
223
|
-
document_id?: number | null;
|
|
224
224
|
project_id?: number | null;
|
|
225
|
+
file_id?: number | null;
|
|
225
226
|
queue_id?: number | null;
|
|
226
227
|
counter_group_id?: number | null;
|
|
227
228
|
calendar_id?: number | null;
|
|
@@ -240,6 +241,10 @@ export interface PluginApiSchemas {
|
|
|
240
241
|
comments: PluginApiSchemas["CommentRead"][];
|
|
241
242
|
next_cursor: string | null;
|
|
242
243
|
};
|
|
244
|
+
/**
|
|
245
|
+
* One comment. `project_id` is its own for a comment on a project and the
|
|
246
|
+
* task's for a task comment (filled by the service's serializer).
|
|
247
|
+
*/
|
|
243
248
|
CommentRead: {
|
|
244
249
|
/**
|
|
245
250
|
* A person is mentioned as `@[](<reference>)`, by your reference for them,
|
|
@@ -248,11 +253,10 @@ export interface PluginApiSchemas {
|
|
|
248
253
|
* `![alt]()`, `[name]()`.
|
|
249
254
|
*/
|
|
250
255
|
content: string;
|
|
251
|
-
id: number;
|
|
252
|
-
created_by: string | null;
|
|
253
256
|
task_id: number | null;
|
|
254
257
|
wiki_page_id: number | null;
|
|
255
|
-
|
|
258
|
+
project_id: number | null;
|
|
259
|
+
file_id: number | null;
|
|
256
260
|
queue_id: number | null;
|
|
257
261
|
counter_group_id: number | null;
|
|
258
262
|
calendar_id: number | null;
|
|
@@ -260,12 +264,13 @@ export interface PluginApiSchemas {
|
|
|
260
264
|
post_id: number | null;
|
|
261
265
|
gallery_id: number | null;
|
|
262
266
|
wiki_id: number | null;
|
|
267
|
+
id: number;
|
|
268
|
+
created_by: string | null;
|
|
263
269
|
parent_comment_id: number | null;
|
|
264
270
|
created_at: string;
|
|
265
271
|
updated_at: string | null;
|
|
266
272
|
author: PluginApiSchemas["PluginPerson"] | null;
|
|
267
273
|
imported_author_name: string | null;
|
|
268
|
-
project_id: number | null;
|
|
269
274
|
reactions: PluginApiSchemas["ReactionGroup"][];
|
|
270
275
|
can_remove: boolean;
|
|
271
276
|
audience: PluginApiSchemas["CommentAudience"];
|
|
@@ -277,6 +282,18 @@ export interface PluginApiSchemas {
|
|
|
277
282
|
ContentCan: {
|
|
278
283
|
edit: boolean;
|
|
279
284
|
};
|
|
285
|
+
CounterCreate: {
|
|
286
|
+
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
287
|
+
name: string;
|
|
288
|
+
color?: string | null;
|
|
289
|
+
count?: number | string;
|
|
290
|
+
min?: number | string | null;
|
|
291
|
+
max?: number | string | null;
|
|
292
|
+
step?: number | string;
|
|
293
|
+
initial_count?: number | string;
|
|
294
|
+
view_mode?: PluginApiSchemas["CounterViewMode"];
|
|
295
|
+
position?: number | string;
|
|
296
|
+
};
|
|
280
297
|
CounterGroupCreate: {
|
|
281
298
|
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
282
299
|
name: string;
|
|
@@ -369,6 +386,12 @@ export interface PluginApiSchemas {
|
|
|
369
386
|
CounterSetCountRequest: {
|
|
370
387
|
count: number | string;
|
|
371
388
|
};
|
|
389
|
+
CounterSortDirection: "asc" | "desc";
|
|
390
|
+
CounterSortField: "name" | "count";
|
|
391
|
+
CounterSortRequest: {
|
|
392
|
+
field: PluginApiSchemas["CounterSortField"];
|
|
393
|
+
direction?: PluginApiSchemas["CounterSortDirection"];
|
|
394
|
+
};
|
|
372
395
|
/**
|
|
373
396
|
* Move a counter up or down. `amount` left out moves it by the counter's own
|
|
374
397
|
* `step`; given, it must be more than nothing, since which way the counter
|
|
@@ -378,35 +401,36 @@ export interface PluginApiSchemas {
|
|
|
378
401
|
direction: "up" | "down";
|
|
379
402
|
amount?: number | string | null;
|
|
380
403
|
};
|
|
404
|
+
CounterUpdate: {
|
|
405
|
+
name?: string | null;
|
|
406
|
+
color?: string | null;
|
|
407
|
+
min?: number | string | null;
|
|
408
|
+
max?: number | string | null;
|
|
409
|
+
step?: number | string | null;
|
|
410
|
+
initial_count?: number | string | null;
|
|
411
|
+
view_mode?: PluginApiSchemas["CounterViewMode"] | null;
|
|
412
|
+
position?: number | string | null;
|
|
413
|
+
};
|
|
381
414
|
CounterViewMode: "number" | "progress_bar" | "segmented_clock";
|
|
382
|
-
|
|
415
|
+
FileCreate: {
|
|
383
416
|
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
384
417
|
name: string;
|
|
385
418
|
initiative_id: number;
|
|
386
419
|
featured_image_url?: string | null;
|
|
387
420
|
is_template?: boolean;
|
|
388
421
|
content?: Record<string, unknown> | null;
|
|
389
|
-
|
|
422
|
+
file_type?: "native" | "whiteboard" | "smart_link" | "spreadsheet";
|
|
390
423
|
grants?: PluginApiSchemas["ResourceGrantSchema"][];
|
|
391
424
|
};
|
|
392
|
-
|
|
425
|
+
FileListResponse: {
|
|
393
426
|
total_count: number;
|
|
394
427
|
page: number;
|
|
395
428
|
page_size: number;
|
|
396
429
|
has_next: boolean;
|
|
397
430
|
has_prev: boolean;
|
|
398
|
-
items: PluginApiSchemas["
|
|
399
|
-
sort_by: string | null;
|
|
400
|
-
sort_dir: string | null;
|
|
431
|
+
items: PluginApiSchemas["FileSummary"][];
|
|
401
432
|
};
|
|
402
|
-
|
|
403
|
-
project_id: number;
|
|
404
|
-
project_name?: string | null;
|
|
405
|
-
project_icon?: string | null;
|
|
406
|
-
project_initiative_id?: number | null;
|
|
407
|
-
attached_at: string;
|
|
408
|
-
};
|
|
409
|
-
DocumentRead: {
|
|
433
|
+
FileRead: {
|
|
410
434
|
archived_at: string | null;
|
|
411
435
|
can: PluginApiSchemas["ToolCan"];
|
|
412
436
|
id: number;
|
|
@@ -429,9 +453,8 @@ export interface PluginApiSchemas {
|
|
|
429
453
|
initiative: PluginApiSchemas["InitiativeSummary"] | null;
|
|
430
454
|
owner: PluginApiSchemas["PluginPerson"] | null;
|
|
431
455
|
owner_plugin: PluginApiSchemas["OwnerPluginSummary"] | null;
|
|
432
|
-
projects: PluginApiSchemas["DocumentProjectLink"][];
|
|
433
456
|
comment_count: number;
|
|
434
|
-
|
|
457
|
+
file_type: PluginApiSchemas["FileType"];
|
|
435
458
|
/**
|
|
436
459
|
* A stored file comes as an empty string, without its path. A URL from
|
|
437
460
|
* elsewhere comes as it is.
|
|
@@ -441,7 +464,6 @@ export interface PluginApiSchemas {
|
|
|
441
464
|
file_size: number | null;
|
|
442
465
|
original_filename: string | null;
|
|
443
466
|
smart_link_url: string | null;
|
|
444
|
-
yjs_updated_at: string | null;
|
|
445
467
|
/**
|
|
446
468
|
* A Lexical editor state. A person is mentioned by a node whose
|
|
447
469
|
* `mentionUserId` is your reference for them, with `mentionName` and `text`
|
|
@@ -452,7 +474,7 @@ export interface PluginApiSchemas {
|
|
|
452
474
|
content: Record<string, unknown>;
|
|
453
475
|
content_version: string | null;
|
|
454
476
|
};
|
|
455
|
-
|
|
477
|
+
FileSummary: {
|
|
456
478
|
archived_at: string | null;
|
|
457
479
|
can: PluginApiSchemas["ToolCan"];
|
|
458
480
|
id: number;
|
|
@@ -475,9 +497,8 @@ export interface PluginApiSchemas {
|
|
|
475
497
|
initiative: PluginApiSchemas["InitiativeSummary"] | null;
|
|
476
498
|
owner: PluginApiSchemas["PluginPerson"] | null;
|
|
477
499
|
owner_plugin: PluginApiSchemas["OwnerPluginSummary"] | null;
|
|
478
|
-
projects: PluginApiSchemas["DocumentProjectLink"][];
|
|
479
500
|
comment_count: number;
|
|
480
|
-
|
|
501
|
+
file_type: PluginApiSchemas["FileType"];
|
|
481
502
|
/**
|
|
482
503
|
* A stored file comes as an empty string, without its path. A URL from
|
|
483
504
|
* elsewhere comes as it is.
|
|
@@ -487,13 +508,12 @@ export interface PluginApiSchemas {
|
|
|
487
508
|
file_size: number | null;
|
|
488
509
|
original_filename: string | null;
|
|
489
510
|
smart_link_url: string | null;
|
|
490
|
-
yjs_updated_at: string | null;
|
|
491
511
|
};
|
|
492
512
|
/**
|
|
493
|
-
* Discriminator for
|
|
513
|
+
* Discriminator for file type.
|
|
494
514
|
*/
|
|
495
|
-
|
|
496
|
-
|
|
515
|
+
FileType: "native" | "file" | "whiteboard" | "smart_link" | "spreadsheet";
|
|
516
|
+
FileUpdate: {
|
|
497
517
|
name?: string | null;
|
|
498
518
|
content?: Record<string, unknown> | null;
|
|
499
519
|
content_version?: string | null;
|
|
@@ -576,7 +596,7 @@ export interface PluginApiSchemas {
|
|
|
576
596
|
original_filename: string | null;
|
|
577
597
|
width: number | null;
|
|
578
598
|
height: number | null;
|
|
579
|
-
created_by: string;
|
|
599
|
+
created_by: string | null;
|
|
580
600
|
uploader: PluginApiSchemas["PluginPerson"] | null;
|
|
581
601
|
created_at: string;
|
|
582
602
|
updated_at: string;
|
|
@@ -584,6 +604,37 @@ export interface PluginApiSchemas {
|
|
|
584
604
|
tags: PluginApiSchemas["TagSummary"][];
|
|
585
605
|
properties: PluginApiSchemas["PropertySummary"][];
|
|
586
606
|
};
|
|
607
|
+
GalleryImageUpdate: {
|
|
608
|
+
properties?: PluginApiSchemas["PropertyValueInput"][] | null;
|
|
609
|
+
title?: string | null;
|
|
610
|
+
caption?: string | null;
|
|
611
|
+
tag_ids?: number[] | null;
|
|
612
|
+
};
|
|
613
|
+
/**
|
|
614
|
+
* One stored rendition of a picture.
|
|
615
|
+
*/
|
|
616
|
+
GalleryImageVersionRead: {
|
|
617
|
+
id: number;
|
|
618
|
+
version_number: number;
|
|
619
|
+
/**
|
|
620
|
+
* A stored file comes as an empty string, without its path. A URL from
|
|
621
|
+
* elsewhere comes as it is.
|
|
622
|
+
*/
|
|
623
|
+
file_url: string;
|
|
624
|
+
/**
|
|
625
|
+
* A stored file comes as an empty string, without its path. A URL from
|
|
626
|
+
* elsewhere comes as it is.
|
|
627
|
+
*/
|
|
628
|
+
thumbnail_url: string | null;
|
|
629
|
+
file_content_type: string | null;
|
|
630
|
+
file_size: number | null;
|
|
631
|
+
original_filename: string | null;
|
|
632
|
+
width: number | null;
|
|
633
|
+
height: number | null;
|
|
634
|
+
created_by: string | null;
|
|
635
|
+
created_at: string;
|
|
636
|
+
is_current: boolean;
|
|
637
|
+
};
|
|
587
638
|
GalleryListResponse: {
|
|
588
639
|
total_count: number;
|
|
589
640
|
page: number;
|
|
@@ -668,7 +719,7 @@ export interface PluginApiSchemas {
|
|
|
668
719
|
*/
|
|
669
720
|
InitiativeRead: {
|
|
670
721
|
projects_enabled: boolean;
|
|
671
|
-
|
|
722
|
+
files_enabled: boolean;
|
|
672
723
|
queues_enabled: boolean;
|
|
673
724
|
counter_groups_enabled: boolean;
|
|
674
725
|
calendars_enabled: boolean;
|
|
@@ -879,12 +930,6 @@ export interface PluginApiSchemas {
|
|
|
879
930
|
template_id?: number | null;
|
|
880
931
|
grants?: PluginApiSchemas["ResourceGrantSchema"][];
|
|
881
932
|
};
|
|
882
|
-
ProjectDocumentSummary: {
|
|
883
|
-
document_id: number;
|
|
884
|
-
name: string;
|
|
885
|
-
updated_at: string;
|
|
886
|
-
attached_at: string;
|
|
887
|
-
};
|
|
888
933
|
ProjectListResponse: {
|
|
889
934
|
total_count: number;
|
|
890
935
|
page: number;
|
|
@@ -896,33 +941,32 @@ export interface PluginApiSchemas {
|
|
|
896
941
|
ProjectRead: {
|
|
897
942
|
archived_at: string | null;
|
|
898
943
|
can: PluginApiSchemas["ProjectCan"];
|
|
944
|
+
id: number;
|
|
945
|
+
initiative_id: number;
|
|
946
|
+
community_id: string;
|
|
947
|
+
created_by: string | null;
|
|
948
|
+
created_at: string;
|
|
949
|
+
updated_at: string;
|
|
950
|
+
comments_enabled: boolean;
|
|
951
|
+
tags: PluginApiSchemas["TagSummary"][];
|
|
952
|
+
properties: PluginApiSchemas["PropertySummary"][];
|
|
953
|
+
grants: PluginApiSchemas["ResourceGrantSchema"][];
|
|
899
954
|
name: string;
|
|
900
955
|
description: string | null;
|
|
901
956
|
icon: string | null;
|
|
902
957
|
start_date: string | null;
|
|
903
958
|
end_date: string | null;
|
|
904
|
-
id: number;
|
|
905
959
|
owner_id: string | null;
|
|
906
|
-
initiative_id: number;
|
|
907
|
-
community_id: string | null;
|
|
908
|
-
created_at: string;
|
|
909
|
-
updated_at: string;
|
|
910
960
|
is_template: boolean;
|
|
911
961
|
pinned_at: string | null;
|
|
912
|
-
default_view_mode:
|
|
962
|
+
default_view_mode: "table" | "kanban" | "calendar" | null;
|
|
913
963
|
owner: PluginApiSchemas["PluginPerson"] | null;
|
|
914
964
|
owner_plugin: PluginApiSchemas["OwnerPluginSummary"] | null;
|
|
915
965
|
initiative: PluginApiSchemas["InitiativeSummary"] | null;
|
|
916
|
-
sort_order: number | null;
|
|
917
966
|
is_favorited: boolean;
|
|
918
967
|
last_viewed_at: string | null;
|
|
919
|
-
documents: PluginApiSchemas["ProjectDocumentSummary"][];
|
|
920
968
|
task_summary: PluginApiSchemas["ProjectTaskSummary"];
|
|
921
969
|
task_statuses: PluginApiSchemas["TaskStatusRead"][];
|
|
922
|
-
comments_enabled: boolean;
|
|
923
|
-
tags: PluginApiSchemas["TagSummary"][];
|
|
924
|
-
properties: PluginApiSchemas["PropertySummary"][];
|
|
925
|
-
grants: PluginApiSchemas["ResourceGrantSchema"][];
|
|
926
970
|
};
|
|
927
971
|
ProjectTaskSummary: {
|
|
928
972
|
total: number;
|
|
@@ -975,7 +1019,7 @@ export interface PluginApiSchemas {
|
|
|
975
1019
|
/**
|
|
976
1020
|
* What can carry custom property values: every tool and sub-tool.
|
|
977
1021
|
*/
|
|
978
|
-
PropertyTarget: "project" | "
|
|
1022
|
+
PropertyTarget: "project" | "file" | "queue" | "counter_group" | "calendar" | "dashboard" | "post" | "gallery" | "wiki" | "task" | "queue_item" | "calendar_event" | "counter" | "gallery_image" | "wiki_page";
|
|
979
1023
|
/**
|
|
980
1024
|
* Supported value types for a property definition.
|
|
981
1025
|
*/
|
|
@@ -1000,10 +1044,16 @@ export interface PluginApiSchemas {
|
|
|
1000
1044
|
initiative_id: number;
|
|
1001
1045
|
grants?: PluginApiSchemas["ResourceGrantSchema"][];
|
|
1002
1046
|
};
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1047
|
+
QueueItemCreate: {
|
|
1048
|
+
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
1049
|
+
label: string;
|
|
1050
|
+
position?: number;
|
|
1051
|
+
color?: string | null;
|
|
1052
|
+
notes?: string | null;
|
|
1053
|
+
is_visible?: boolean;
|
|
1054
|
+
user_id?: string | null;
|
|
1055
|
+
tag_ids?: number[] | null;
|
|
1056
|
+
task_ids?: number[] | null;
|
|
1007
1057
|
};
|
|
1008
1058
|
QueueItemRead: {
|
|
1009
1059
|
label: string;
|
|
@@ -1017,17 +1067,10 @@ export interface PluginApiSchemas {
|
|
|
1017
1067
|
user: PluginApiSchemas["PluginPerson"] | null;
|
|
1018
1068
|
tags: PluginApiSchemas["TagSummary"][];
|
|
1019
1069
|
properties: PluginApiSchemas["PropertySummary"][];
|
|
1020
|
-
documents: PluginApiSchemas["QueueItemDocumentRead"][];
|
|
1021
|
-
tasks: PluginApiSchemas["QueueItemTaskRead"][];
|
|
1022
1070
|
attachment_count: number;
|
|
1023
1071
|
held_at_round: number | null;
|
|
1024
1072
|
created_at: string;
|
|
1025
1073
|
};
|
|
1026
|
-
QueueItemTaskRead: {
|
|
1027
|
-
task_id: number;
|
|
1028
|
-
title?: string;
|
|
1029
|
-
attached_at: string;
|
|
1030
|
-
};
|
|
1031
1074
|
QueueItemUpdate: {
|
|
1032
1075
|
properties?: PluginApiSchemas["PropertyValueInput"][] | null;
|
|
1033
1076
|
label?: string | null;
|
|
@@ -1065,7 +1108,7 @@ export interface PluginApiSchemas {
|
|
|
1065
1108
|
is_active: boolean;
|
|
1066
1109
|
preview: PluginApiSchemas["QueueTurnPreview"][] | null;
|
|
1067
1110
|
items: PluginApiSchemas["QueueItemRead"][];
|
|
1068
|
-
|
|
1111
|
+
current_item_id: number | null;
|
|
1069
1112
|
};
|
|
1070
1113
|
/**
|
|
1071
1114
|
* Options for releasing a held queue item back into the rotation.
|
|
@@ -1130,7 +1173,7 @@ export interface PluginApiSchemas {
|
|
|
1130
1173
|
all_initiative_members?: boolean;
|
|
1131
1174
|
plugin_install_id?: number | null;
|
|
1132
1175
|
};
|
|
1133
|
-
SearchEntityType: "calendar" | "calendar_event" | "comment" | "counter" | "counter_group" | "dashboard" | "
|
|
1176
|
+
SearchEntityType: "calendar" | "calendar_event" | "comment" | "counter" | "counter_group" | "dashboard" | "file" | "gallery" | "gallery_image" | "post" | "project" | "queue" | "queue_item" | "tag" | "task" | "wiki" | "wiki_page";
|
|
1134
1177
|
/**
|
|
1135
1178
|
* A jump-to target for the command palette: enough to render and route.
|
|
1136
1179
|
*/
|
|
@@ -1187,7 +1230,7 @@ export interface PluginApiSchemas {
|
|
|
1187
1230
|
/**
|
|
1188
1231
|
* Entity types a bulk tag edit can address.
|
|
1189
1232
|
*/
|
|
1190
|
-
TagTarget: "project" | "
|
|
1233
|
+
TagTarget: "project" | "file" | "queue" | "counter_group" | "calendar" | "dashboard" | "post" | "gallery" | "wiki" | "task" | "queue_item" | "calendar_event" | "gallery_image" | "wiki_page";
|
|
1191
1234
|
TaskCreate: {
|
|
1192
1235
|
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
1193
1236
|
title: string;
|
|
@@ -1324,7 +1367,19 @@ export interface PluginApiSchemas {
|
|
|
1324
1367
|
checklist?: PluginApiSchemas["ChecklistItemInput"][] | null;
|
|
1325
1368
|
scope?: "this" | "following" | "all" | null;
|
|
1326
1369
|
};
|
|
1327
|
-
|
|
1370
|
+
/**
|
|
1371
|
+
* One period on the rail.
|
|
1372
|
+
*/
|
|
1373
|
+
TimelineBucket: {
|
|
1374
|
+
period: string;
|
|
1375
|
+
count: number;
|
|
1376
|
+
anchor: string;
|
|
1377
|
+
anchor_oldest: string;
|
|
1378
|
+
};
|
|
1379
|
+
TimelineResponse: {
|
|
1380
|
+
buckets: PluginApiSchemas["TimelineBucket"][];
|
|
1381
|
+
};
|
|
1382
|
+
Tool: "project" | "file" | "queue" | "counter_group" | "calendar" | "dashboard" | "post" | "gallery" | "wiki";
|
|
1328
1383
|
/**
|
|
1329
1384
|
* What the caller may do to one of a tool's rows
|
|
1330
1385
|
* (`permissions.client_access`).
|
|
@@ -1406,6 +1461,14 @@ export interface PluginApiSchemas {
|
|
|
1406
1461
|
has_prev: boolean;
|
|
1407
1462
|
items: PluginApiSchemas["WikiSummary"][];
|
|
1408
1463
|
};
|
|
1464
|
+
WikiPageCreate: {
|
|
1465
|
+
properties?: PluginApiSchemas["PropertyValueInput"][];
|
|
1466
|
+
title?: string | null;
|
|
1467
|
+
parent_page_id?: number | null;
|
|
1468
|
+
is_draft?: boolean;
|
|
1469
|
+
content?: Record<string, unknown> | null;
|
|
1470
|
+
tag_ids?: number[] | null;
|
|
1471
|
+
};
|
|
1409
1472
|
/**
|
|
1410
1473
|
* One heading written on a page.
|
|
1411
1474
|
*/
|
|
@@ -1417,7 +1480,14 @@ export interface PluginApiSchemas {
|
|
|
1417
1480
|
/**
|
|
1418
1481
|
* What a row in a wiki's navigation actually is.
|
|
1419
1482
|
*/
|
|
1420
|
-
WikiPageKind: "page" | "
|
|
1483
|
+
WikiPageKind: "page" | "file";
|
|
1484
|
+
/**
|
|
1485
|
+
* Where a page should sit after a drag — two facts, sent together.
|
|
1486
|
+
*/
|
|
1487
|
+
WikiPageMove: {
|
|
1488
|
+
parent_page_id?: number | null;
|
|
1489
|
+
position?: number;
|
|
1490
|
+
};
|
|
1421
1491
|
/**
|
|
1422
1492
|
* How a wiki's page tree is sorted.
|
|
1423
1493
|
*/
|
|
@@ -1441,7 +1511,7 @@ export interface PluginApiSchemas {
|
|
|
1441
1511
|
headings: PluginApiSchemas["WikiPageHeading"][];
|
|
1442
1512
|
tags: PluginApiSchemas["TagSummary"][];
|
|
1443
1513
|
properties: PluginApiSchemas["PropertySummary"][];
|
|
1444
|
-
|
|
1514
|
+
file_type: string | null;
|
|
1445
1515
|
file_content_type: string | null;
|
|
1446
1516
|
original_filename: string | null;
|
|
1447
1517
|
smart_link_url: string | null;
|
|
@@ -1454,7 +1524,6 @@ export interface PluginApiSchemas {
|
|
|
1454
1524
|
*/
|
|
1455
1525
|
content: Record<string, unknown>;
|
|
1456
1526
|
content_version: string | null;
|
|
1457
|
-
comment_count: number;
|
|
1458
1527
|
};
|
|
1459
1528
|
/**
|
|
1460
1529
|
* One page as the navigation draws it — no body.
|
|
@@ -1475,7 +1544,7 @@ export interface PluginApiSchemas {
|
|
|
1475
1544
|
headings: PluginApiSchemas["WikiPageHeading"][];
|
|
1476
1545
|
tags: PluginApiSchemas["TagSummary"][];
|
|
1477
1546
|
properties: PluginApiSchemas["PropertySummary"][];
|
|
1478
|
-
|
|
1547
|
+
file_type: string | null;
|
|
1479
1548
|
file_content_type: string | null;
|
|
1480
1549
|
original_filename: string | null;
|
|
1481
1550
|
smart_link_url: string | null;
|
|
@@ -1487,6 +1556,17 @@ export interface PluginApiSchemas {
|
|
|
1487
1556
|
WikiPageTree: {
|
|
1488
1557
|
items: PluginApiSchemas["WikiPageSummary"][];
|
|
1489
1558
|
};
|
|
1559
|
+
/**
|
|
1560
|
+
* A change to one page.
|
|
1561
|
+
*/
|
|
1562
|
+
WikiPageUpdate: {
|
|
1563
|
+
properties?: PluginApiSchemas["PropertyValueInput"][] | null;
|
|
1564
|
+
title?: string | null;
|
|
1565
|
+
is_draft?: boolean | null;
|
|
1566
|
+
content?: Record<string, unknown> | null;
|
|
1567
|
+
content_version?: string | null;
|
|
1568
|
+
tag_ids?: number[] | null;
|
|
1569
|
+
};
|
|
1490
1570
|
/**
|
|
1491
1571
|
* A wiki on its own page. The same shape as its summary: the pages are
|
|
1492
1572
|
* fetched as a tree of their own, because a wiki is navigated rather than
|
|
@@ -1596,7 +1676,7 @@ export interface PluginApiOperations {
|
|
|
1596
1676
|
initiative_id?: number | null;
|
|
1597
1677
|
/**
|
|
1598
1678
|
* Return a lightweight projection (id, name, icon, initiative_id, can)
|
|
1599
|
-
* without
|
|
1679
|
+
* without files, grants, tags, or the nested initiative. For project
|
|
1600
1680
|
* pickers and other list-only callers.
|
|
1601
1681
|
*/
|
|
1602
1682
|
slim?: boolean;
|
|
@@ -1632,14 +1712,9 @@ export interface PluginApiOperations {
|
|
|
1632
1712
|
body: PluginApiSchemas["ProjectCreate"];
|
|
1633
1713
|
answer: PluginApiSchemas["ProjectRead"];
|
|
1634
1714
|
};
|
|
1635
|
-
|
|
1715
|
+
list_files: {
|
|
1636
1716
|
query: {
|
|
1637
1717
|
initiative_id?: number | null;
|
|
1638
|
-
/**
|
|
1639
|
-
* Filter to specific document IDs — for hydrating a known set of
|
|
1640
|
-
* documents without walking a collection. Maximum 100 IDs.
|
|
1641
|
-
*/
|
|
1642
|
-
ids?: number[] | null;
|
|
1643
1718
|
search?: string | null;
|
|
1644
1719
|
/**
|
|
1645
1720
|
* Filter by tag IDs
|
|
@@ -1651,18 +1726,18 @@ export interface PluginApiOperations {
|
|
|
1651
1726
|
*/
|
|
1652
1727
|
property_filters?: string | null;
|
|
1653
1728
|
/**
|
|
1654
|
-
* Filter to
|
|
1729
|
+
* Filter to files with no tags
|
|
1655
1730
|
*/
|
|
1656
1731
|
untagged?: boolean | null;
|
|
1657
1732
|
/**
|
|
1658
|
-
* Only templates (true) or only
|
|
1733
|
+
* Only templates (true) or only files that are not templates (false).
|
|
1659
1734
|
* Omit for both.
|
|
1660
1735
|
*/
|
|
1661
1736
|
is_template?: boolean | null;
|
|
1662
1737
|
/**
|
|
1663
|
-
* Filter by
|
|
1738
|
+
* Filter by file type
|
|
1664
1739
|
*/
|
|
1665
|
-
|
|
1740
|
+
file_type?: PluginApiSchemas["FileType"] | null;
|
|
1666
1741
|
page?: number;
|
|
1667
1742
|
page_size?: number;
|
|
1668
1743
|
/**
|
|
@@ -1679,11 +1754,11 @@ export interface PluginApiOperations {
|
|
|
1679
1754
|
*/
|
|
1680
1755
|
archived?: boolean | null;
|
|
1681
1756
|
};
|
|
1682
|
-
answer: PluginApiSchemas["
|
|
1757
|
+
answer: PluginApiSchemas["FileListResponse"];
|
|
1683
1758
|
};
|
|
1684
|
-
|
|
1685
|
-
body: PluginApiSchemas["
|
|
1686
|
-
answer: PluginApiSchemas["
|
|
1759
|
+
create_file: {
|
|
1760
|
+
body: PluginApiSchemas["FileCreate"];
|
|
1761
|
+
answer: PluginApiSchemas["FileRead"];
|
|
1687
1762
|
};
|
|
1688
1763
|
list_queues: {
|
|
1689
1764
|
query: {
|
|
@@ -2073,9 +2148,12 @@ export interface PluginApiOperations {
|
|
|
2073
2148
|
};
|
|
2074
2149
|
list_comments: {
|
|
2075
2150
|
query: {
|
|
2151
|
+
limit?: number;
|
|
2152
|
+
cursor?: string | null;
|
|
2076
2153
|
task_id?: number | null;
|
|
2077
|
-
|
|
2154
|
+
wiki_page_id?: number | null;
|
|
2078
2155
|
project_id?: number | null;
|
|
2156
|
+
file_id?: number | null;
|
|
2079
2157
|
queue_id?: number | null;
|
|
2080
2158
|
counter_group_id?: number | null;
|
|
2081
2159
|
calendar_id?: number | null;
|
|
@@ -2083,9 +2161,6 @@ export interface PluginApiOperations {
|
|
|
2083
2161
|
post_id?: number | null;
|
|
2084
2162
|
gallery_id?: number | null;
|
|
2085
2163
|
wiki_id?: number | null;
|
|
2086
|
-
wiki_page_id?: number | null;
|
|
2087
|
-
limit?: number;
|
|
2088
|
-
cursor?: string | null;
|
|
2089
2164
|
};
|
|
2090
2165
|
answer: PluginApiSchemas["CommentListResponse"];
|
|
2091
2166
|
};
|
|
@@ -2127,16 +2202,16 @@ export interface PluginApiOperations {
|
|
|
2127
2202
|
};
|
|
2128
2203
|
answer: PluginApiSchemas["InitiativeRead"];
|
|
2129
2204
|
};
|
|
2130
|
-
|
|
2205
|
+
read_file: {
|
|
2131
2206
|
path: {
|
|
2132
|
-
|
|
2207
|
+
file_id: number;
|
|
2133
2208
|
};
|
|
2134
2209
|
query: {
|
|
2135
2210
|
/**
|
|
2136
|
-
* Include the
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
*
|
|
2211
|
+
* Include the file body. Pass false for the metadata alone — a file's
|
|
2212
|
+
* body is the largest thing this API returns, and a caller reacting to a
|
|
2213
|
+
* change (a name, a tag, a property) does not need it. Everything else is
|
|
2214
|
+
* unchanged.
|
|
2140
2215
|
*/
|
|
2141
2216
|
include_content?: boolean;
|
|
2142
2217
|
/**
|
|
@@ -2146,14 +2221,14 @@ export interface PluginApiOperations {
|
|
|
2146
2221
|
*/
|
|
2147
2222
|
include_deleted?: boolean;
|
|
2148
2223
|
};
|
|
2149
|
-
answer: PluginApiSchemas["
|
|
2224
|
+
answer: PluginApiSchemas["FileRead"];
|
|
2150
2225
|
};
|
|
2151
|
-
|
|
2226
|
+
update_file: {
|
|
2152
2227
|
path: {
|
|
2153
|
-
|
|
2228
|
+
file_id: number;
|
|
2154
2229
|
};
|
|
2155
|
-
body: PluginApiSchemas["
|
|
2156
|
-
answer: PluginApiSchemas["
|
|
2230
|
+
body: PluginApiSchemas["FileUpdate"];
|
|
2231
|
+
answer: PluginApiSchemas["FileRead"];
|
|
2157
2232
|
};
|
|
2158
2233
|
read_queue: {
|
|
2159
2234
|
path: {
|
|
@@ -2176,6 +2251,13 @@ export interface PluginApiOperations {
|
|
|
2176
2251
|
body: PluginApiSchemas["QueueUpdate"];
|
|
2177
2252
|
answer: PluginApiSchemas["QueueRead"];
|
|
2178
2253
|
};
|
|
2254
|
+
add_queue_item: {
|
|
2255
|
+
path: {
|
|
2256
|
+
queue_id: number;
|
|
2257
|
+
};
|
|
2258
|
+
body: PluginApiSchemas["QueueItemCreate"];
|
|
2259
|
+
answer: PluginApiSchemas["QueueItemRead"];
|
|
2260
|
+
};
|
|
2179
2261
|
start_queue: {
|
|
2180
2262
|
path: {
|
|
2181
2263
|
queue_id: number;
|
|
@@ -2275,6 +2357,26 @@ export interface PluginApiOperations {
|
|
|
2275
2357
|
body: PluginApiSchemas["CounterGroupUpdate"];
|
|
2276
2358
|
answer: PluginApiSchemas["CounterGroupRead"];
|
|
2277
2359
|
};
|
|
2360
|
+
add_counter: {
|
|
2361
|
+
path: {
|
|
2362
|
+
group_id: number;
|
|
2363
|
+
};
|
|
2364
|
+
body: PluginApiSchemas["CounterCreate"];
|
|
2365
|
+
answer: PluginApiSchemas["CounterRead"];
|
|
2366
|
+
};
|
|
2367
|
+
reset_all_counters: {
|
|
2368
|
+
path: {
|
|
2369
|
+
group_id: number;
|
|
2370
|
+
};
|
|
2371
|
+
answer: PluginApiSchemas["CounterGroupRead"];
|
|
2372
|
+
};
|
|
2373
|
+
sort_counters: {
|
|
2374
|
+
path: {
|
|
2375
|
+
group_id: number;
|
|
2376
|
+
};
|
|
2377
|
+
body: PluginApiSchemas["CounterSortRequest"];
|
|
2378
|
+
answer: PluginApiSchemas["CounterGroupRead"];
|
|
2379
|
+
};
|
|
2278
2380
|
read_counter: {
|
|
2279
2381
|
path: {
|
|
2280
2382
|
counter_id: number;
|
|
@@ -2289,6 +2391,13 @@ export interface PluginApiOperations {
|
|
|
2289
2391
|
};
|
|
2290
2392
|
answer: PluginApiSchemas["CounterRead"];
|
|
2291
2393
|
};
|
|
2394
|
+
update_counter: {
|
|
2395
|
+
path: {
|
|
2396
|
+
counter_id: number;
|
|
2397
|
+
};
|
|
2398
|
+
body: PluginApiSchemas["CounterUpdate"];
|
|
2399
|
+
answer: PluginApiSchemas["CounterRead"];
|
|
2400
|
+
};
|
|
2292
2401
|
duplicate_counter: {
|
|
2293
2402
|
path: {
|
|
2294
2403
|
counter_id: number;
|
|
@@ -2416,6 +2525,66 @@ export interface PluginApiOperations {
|
|
|
2416
2525
|
};
|
|
2417
2526
|
answer: PluginApiSchemas["GalleryImageListResponse"];
|
|
2418
2527
|
};
|
|
2528
|
+
upload_gallery_image: {
|
|
2529
|
+
path: {
|
|
2530
|
+
gallery_id: number;
|
|
2531
|
+
};
|
|
2532
|
+
body: FormData;
|
|
2533
|
+
answer: PluginApiSchemas["GalleryImageRead"];
|
|
2534
|
+
};
|
|
2535
|
+
get_gallery_image_timeline: {
|
|
2536
|
+
path: {
|
|
2537
|
+
gallery_id: number;
|
|
2538
|
+
};
|
|
2539
|
+
query: {
|
|
2540
|
+
tag_ids?: number[] | null;
|
|
2541
|
+
search?: string | null;
|
|
2542
|
+
/**
|
|
2543
|
+
* IANA zone the month boundaries are cut in, e.g. Pacific/Auckland.
|
|
2544
|
+
* Defaults to UTC.
|
|
2545
|
+
*/
|
|
2546
|
+
tz?: string | null;
|
|
2547
|
+
};
|
|
2548
|
+
answer: PluginApiSchemas["TimelineResponse"];
|
|
2549
|
+
};
|
|
2550
|
+
read_gallery_image: {
|
|
2551
|
+
path: {
|
|
2552
|
+
gallery_id: number;
|
|
2553
|
+
image_id: number;
|
|
2554
|
+
};
|
|
2555
|
+
answer: PluginApiSchemas["GalleryImageRead"];
|
|
2556
|
+
};
|
|
2557
|
+
update_gallery_image: {
|
|
2558
|
+
path: {
|
|
2559
|
+
gallery_id: number;
|
|
2560
|
+
image_id: number;
|
|
2561
|
+
};
|
|
2562
|
+
body: PluginApiSchemas["GalleryImageUpdate"];
|
|
2563
|
+
answer: PluginApiSchemas["GalleryImageRead"];
|
|
2564
|
+
};
|
|
2565
|
+
list_gallery_image_versions: {
|
|
2566
|
+
path: {
|
|
2567
|
+
gallery_id: number;
|
|
2568
|
+
image_id: number;
|
|
2569
|
+
};
|
|
2570
|
+
answer: PluginApiSchemas["GalleryImageVersionRead"][];
|
|
2571
|
+
};
|
|
2572
|
+
upload_gallery_image_version: {
|
|
2573
|
+
path: {
|
|
2574
|
+
gallery_id: number;
|
|
2575
|
+
image_id: number;
|
|
2576
|
+
};
|
|
2577
|
+
body: FormData;
|
|
2578
|
+
answer: PluginApiSchemas["GalleryImageVersionRead"];
|
|
2579
|
+
};
|
|
2580
|
+
delete_gallery_image_version: {
|
|
2581
|
+
path: {
|
|
2582
|
+
gallery_id: number;
|
|
2583
|
+
image_id: number;
|
|
2584
|
+
version_id: number;
|
|
2585
|
+
};
|
|
2586
|
+
answer: void;
|
|
2587
|
+
};
|
|
2419
2588
|
read_wiki: {
|
|
2420
2589
|
path: {
|
|
2421
2590
|
wiki_id: number;
|
|
@@ -2435,18 +2604,39 @@ export interface PluginApiOperations {
|
|
|
2435
2604
|
};
|
|
2436
2605
|
answer: PluginApiSchemas["WikiPageTree"];
|
|
2437
2606
|
};
|
|
2607
|
+
create_wiki_page: {
|
|
2608
|
+
path: {
|
|
2609
|
+
wiki_id: number;
|
|
2610
|
+
};
|
|
2611
|
+
body: PluginApiSchemas["WikiPageCreate"];
|
|
2612
|
+
answer: PluginApiSchemas["WikiPageRead"];
|
|
2613
|
+
};
|
|
2438
2614
|
read_wiki_page: {
|
|
2439
2615
|
path: {
|
|
2440
2616
|
page_id: number;
|
|
2441
2617
|
};
|
|
2442
2618
|
answer: PluginApiSchemas["WikiPageRead"];
|
|
2443
2619
|
};
|
|
2620
|
+
update_wiki_page: {
|
|
2621
|
+
path: {
|
|
2622
|
+
page_id: number;
|
|
2623
|
+
};
|
|
2624
|
+
body: PluginApiSchemas["WikiPageUpdate"];
|
|
2625
|
+
answer: PluginApiSchemas["WikiPageRead"];
|
|
2626
|
+
};
|
|
2444
2627
|
duplicate_wiki_page: {
|
|
2445
2628
|
path: {
|
|
2446
2629
|
page_id: number;
|
|
2447
2630
|
};
|
|
2448
2631
|
answer: PluginApiSchemas["WikiPageRead"];
|
|
2449
2632
|
};
|
|
2633
|
+
move_wiki_page: {
|
|
2634
|
+
path: {
|
|
2635
|
+
page_id: number;
|
|
2636
|
+
};
|
|
2637
|
+
body: PluginApiSchemas["WikiPageMove"];
|
|
2638
|
+
answer: PluginApiSchemas["WikiPageRead"];
|
|
2639
|
+
};
|
|
2450
2640
|
read_calendar_event: {
|
|
2451
2641
|
path: {
|
|
2452
2642
|
event_id: number;
|
|
@@ -2541,12 +2731,12 @@ export interface PluginApiOperations {
|
|
|
2541
2731
|
body: PluginApiSchemas["ResourceGrantSchema"][];
|
|
2542
2732
|
answer: PluginApiSchemas["ProjectRead"];
|
|
2543
2733
|
};
|
|
2544
|
-
|
|
2734
|
+
set_file_grants: {
|
|
2545
2735
|
path: {
|
|
2546
|
-
|
|
2736
|
+
file_id: number;
|
|
2547
2737
|
};
|
|
2548
2738
|
body: PluginApiSchemas["ResourceGrantSchema"][];
|
|
2549
|
-
answer: PluginApiSchemas["
|
|
2739
|
+
answer: PluginApiSchemas["FileRead"];
|
|
2550
2740
|
};
|
|
2551
2741
|
set_queue_grants: {
|
|
2552
2742
|
path: {
|
|
@@ -2597,12 +2787,12 @@ export interface PluginApiOperations {
|
|
|
2597
2787
|
body: PluginApiSchemas["ToolDuplicateRequest"] | null;
|
|
2598
2788
|
answer: PluginApiSchemas["ProjectRead"];
|
|
2599
2789
|
};
|
|
2600
|
-
|
|
2790
|
+
duplicate_file: {
|
|
2601
2791
|
path: {
|
|
2602
|
-
|
|
2792
|
+
file_id: number;
|
|
2603
2793
|
};
|
|
2604
2794
|
body: PluginApiSchemas["ToolDuplicateRequest"] | null;
|
|
2605
|
-
answer: PluginApiSchemas["
|
|
2795
|
+
answer: PluginApiSchemas["FileRead"];
|
|
2606
2796
|
};
|
|
2607
2797
|
duplicate_queue: {
|
|
2608
2798
|
path: {
|
|
@@ -2654,7 +2844,7 @@ export interface PluginApiOperations {
|
|
|
2654
2844
|
search: string;
|
|
2655
2845
|
/**
|
|
2656
2846
|
* Restrict to these entity types. Omit for the default scope (calendar,
|
|
2657
|
-
* calendar_event, counter, counter_group, dashboard,
|
|
2847
|
+
* calendar_event, counter, counter_group, dashboard, file, gallery,
|
|
2658
2848
|
* gallery_image, post, project, queue, queue_item, tag, task, wiki,
|
|
2659
2849
|
* wiki_page); naming a type reaches it explicitly.
|
|
2660
2850
|
*/
|
|
@@ -2669,9 +2859,9 @@ export interface PluginApiOperations {
|
|
|
2669
2859
|
*/
|
|
2670
2860
|
is_template?: boolean | null;
|
|
2671
2861
|
/**
|
|
2672
|
-
* The thing being written in, as a reference (`
|
|
2673
|
-
*
|
|
2674
|
-
*
|
|
2862
|
+
* The thing being written in, as a reference (`file:12`). It is left out
|
|
2863
|
+
* of the answer: a thing does not point at itself. A reference that names
|
|
2864
|
+
* nothing narrows nothing.
|
|
2675
2865
|
*/
|
|
2676
2866
|
subject?: string | null;
|
|
2677
2867
|
limit?: number;
|
|
@@ -2750,7 +2940,7 @@ export declare const pluginApiOperations: {
|
|
|
2750
2940
|
readonly path: "/webhooks/subscriptions";
|
|
2751
2941
|
readonly scope: {
|
|
2752
2942
|
readonly per: "event_type";
|
|
2753
|
-
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "
|
|
2943
|
+
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "files:read", "galleries:read", "initiatives:read", "posts:read", "projects:read", "queues:read", "tags:read", "wikis:read"];
|
|
2754
2944
|
};
|
|
2755
2945
|
};
|
|
2756
2946
|
readonly delete_subscription: {
|
|
@@ -2758,7 +2948,7 @@ export declare const pluginApiOperations: {
|
|
|
2758
2948
|
readonly path: "/webhooks/subscriptions/{subscription_id}";
|
|
2759
2949
|
readonly scope: {
|
|
2760
2950
|
readonly per: "event_type";
|
|
2761
|
-
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "
|
|
2951
|
+
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "files:read", "galleries:read", "initiatives:read", "posts:read", "projects:read", "queues:read", "tags:read", "wikis:read"];
|
|
2762
2952
|
};
|
|
2763
2953
|
};
|
|
2764
2954
|
readonly list_projects: {
|
|
@@ -2771,15 +2961,15 @@ export declare const pluginApiOperations: {
|
|
|
2771
2961
|
readonly path: "/projects/";
|
|
2772
2962
|
readonly scope: "projects:write";
|
|
2773
2963
|
};
|
|
2774
|
-
readonly
|
|
2964
|
+
readonly list_files: {
|
|
2775
2965
|
readonly method: "GET";
|
|
2776
|
-
readonly path: "/
|
|
2777
|
-
readonly scope: "
|
|
2966
|
+
readonly path: "/files/";
|
|
2967
|
+
readonly scope: "files:read";
|
|
2778
2968
|
};
|
|
2779
|
-
readonly
|
|
2969
|
+
readonly create_file: {
|
|
2780
2970
|
readonly method: "POST";
|
|
2781
|
-
readonly path: "/
|
|
2782
|
-
readonly scope: "
|
|
2971
|
+
readonly path: "/files/";
|
|
2972
|
+
readonly scope: "files:write";
|
|
2783
2973
|
};
|
|
2784
2974
|
readonly list_queues: {
|
|
2785
2975
|
readonly method: "GET";
|
|
@@ -2927,15 +3117,15 @@ export declare const pluginApiOperations: {
|
|
|
2927
3117
|
readonly path: "/initiatives/{initiative_id}";
|
|
2928
3118
|
readonly scope: "initiatives:read";
|
|
2929
3119
|
};
|
|
2930
|
-
readonly
|
|
3120
|
+
readonly read_file: {
|
|
2931
3121
|
readonly method: "GET";
|
|
2932
|
-
readonly path: "/
|
|
2933
|
-
readonly scope: "
|
|
3122
|
+
readonly path: "/files/{file_id}";
|
|
3123
|
+
readonly scope: "files:read";
|
|
2934
3124
|
};
|
|
2935
|
-
readonly
|
|
3125
|
+
readonly update_file: {
|
|
2936
3126
|
readonly method: "PATCH";
|
|
2937
|
-
readonly path: "/
|
|
2938
|
-
readonly scope: "
|
|
3127
|
+
readonly path: "/files/{file_id}";
|
|
3128
|
+
readonly scope: "files:write";
|
|
2939
3129
|
};
|
|
2940
3130
|
readonly read_queue: {
|
|
2941
3131
|
readonly method: "GET";
|
|
@@ -2947,6 +3137,11 @@ export declare const pluginApiOperations: {
|
|
|
2947
3137
|
readonly path: "/queues/{queue_id}";
|
|
2948
3138
|
readonly scope: "queues:write";
|
|
2949
3139
|
};
|
|
3140
|
+
readonly add_queue_item: {
|
|
3141
|
+
readonly method: "POST";
|
|
3142
|
+
readonly path: "/queues/{queue_id}/items";
|
|
3143
|
+
readonly scope: "queues:write";
|
|
3144
|
+
};
|
|
2950
3145
|
readonly start_queue: {
|
|
2951
3146
|
readonly method: "POST";
|
|
2952
3147
|
readonly path: "/queues/{queue_id}/start";
|
|
@@ -3012,11 +3207,31 @@ export declare const pluginApiOperations: {
|
|
|
3012
3207
|
readonly path: "/counter-groups/{group_id}";
|
|
3013
3208
|
readonly scope: "counter_groups:write";
|
|
3014
3209
|
};
|
|
3210
|
+
readonly add_counter: {
|
|
3211
|
+
readonly method: "POST";
|
|
3212
|
+
readonly path: "/counter-groups/{group_id}/counters";
|
|
3213
|
+
readonly scope: "counter_groups:write";
|
|
3214
|
+
};
|
|
3215
|
+
readonly reset_all_counters: {
|
|
3216
|
+
readonly method: "POST";
|
|
3217
|
+
readonly path: "/counter-groups/{group_id}/reset-all";
|
|
3218
|
+
readonly scope: "counter_groups:write";
|
|
3219
|
+
};
|
|
3220
|
+
readonly sort_counters: {
|
|
3221
|
+
readonly method: "POST";
|
|
3222
|
+
readonly path: "/counter-groups/{group_id}/sort";
|
|
3223
|
+
readonly scope: "counter_groups:write";
|
|
3224
|
+
};
|
|
3015
3225
|
readonly read_counter: {
|
|
3016
3226
|
readonly method: "GET";
|
|
3017
3227
|
readonly path: "/counters/{counter_id}";
|
|
3018
3228
|
readonly scope: "counter_groups:read";
|
|
3019
3229
|
};
|
|
3230
|
+
readonly update_counter: {
|
|
3231
|
+
readonly method: "PATCH";
|
|
3232
|
+
readonly path: "/counters/{counter_id}";
|
|
3233
|
+
readonly scope: "counter_groups:write";
|
|
3234
|
+
};
|
|
3020
3235
|
readonly duplicate_counter: {
|
|
3021
3236
|
readonly method: "POST";
|
|
3022
3237
|
readonly path: "/counters/{counter_id}/duplicate";
|
|
@@ -3077,6 +3292,41 @@ export declare const pluginApiOperations: {
|
|
|
3077
3292
|
readonly path: "/galleries/{gallery_id}/images";
|
|
3078
3293
|
readonly scope: "galleries:read";
|
|
3079
3294
|
};
|
|
3295
|
+
readonly upload_gallery_image: {
|
|
3296
|
+
readonly method: "POST";
|
|
3297
|
+
readonly path: "/galleries/{gallery_id}/images";
|
|
3298
|
+
readonly scope: "galleries:write";
|
|
3299
|
+
};
|
|
3300
|
+
readonly get_gallery_image_timeline: {
|
|
3301
|
+
readonly method: "GET";
|
|
3302
|
+
readonly path: "/galleries/{gallery_id}/images/timeline";
|
|
3303
|
+
readonly scope: "galleries:read";
|
|
3304
|
+
};
|
|
3305
|
+
readonly read_gallery_image: {
|
|
3306
|
+
readonly method: "GET";
|
|
3307
|
+
readonly path: "/galleries/{gallery_id}/images/{image_id}";
|
|
3308
|
+
readonly scope: "galleries:read";
|
|
3309
|
+
};
|
|
3310
|
+
readonly update_gallery_image: {
|
|
3311
|
+
readonly method: "PATCH";
|
|
3312
|
+
readonly path: "/galleries/{gallery_id}/images/{image_id}";
|
|
3313
|
+
readonly scope: "galleries:write";
|
|
3314
|
+
};
|
|
3315
|
+
readonly list_gallery_image_versions: {
|
|
3316
|
+
readonly method: "GET";
|
|
3317
|
+
readonly path: "/galleries/{gallery_id}/images/{image_id}/versions";
|
|
3318
|
+
readonly scope: "galleries:read";
|
|
3319
|
+
};
|
|
3320
|
+
readonly upload_gallery_image_version: {
|
|
3321
|
+
readonly method: "POST";
|
|
3322
|
+
readonly path: "/galleries/{gallery_id}/images/{image_id}/versions";
|
|
3323
|
+
readonly scope: "galleries:write";
|
|
3324
|
+
};
|
|
3325
|
+
readonly delete_gallery_image_version: {
|
|
3326
|
+
readonly method: "DELETE";
|
|
3327
|
+
readonly path: "/galleries/{gallery_id}/images/{image_id}/versions/{version_id}";
|
|
3328
|
+
readonly scope: "galleries:write";
|
|
3329
|
+
};
|
|
3080
3330
|
readonly read_wiki: {
|
|
3081
3331
|
readonly method: "GET";
|
|
3082
3332
|
readonly path: "/wikis/{wiki_id}";
|
|
@@ -3092,16 +3342,31 @@ export declare const pluginApiOperations: {
|
|
|
3092
3342
|
readonly path: "/wikis/{wiki_id}/pages";
|
|
3093
3343
|
readonly scope: "wikis:read";
|
|
3094
3344
|
};
|
|
3345
|
+
readonly create_wiki_page: {
|
|
3346
|
+
readonly method: "POST";
|
|
3347
|
+
readonly path: "/wikis/{wiki_id}/pages";
|
|
3348
|
+
readonly scope: "wikis:write";
|
|
3349
|
+
};
|
|
3095
3350
|
readonly read_wiki_page: {
|
|
3096
3351
|
readonly method: "GET";
|
|
3097
3352
|
readonly path: "/wiki-pages/{page_id}";
|
|
3098
3353
|
readonly scope: "wikis:read";
|
|
3099
3354
|
};
|
|
3355
|
+
readonly update_wiki_page: {
|
|
3356
|
+
readonly method: "PATCH";
|
|
3357
|
+
readonly path: "/wiki-pages/{page_id}";
|
|
3358
|
+
readonly scope: "wikis:write";
|
|
3359
|
+
};
|
|
3100
3360
|
readonly duplicate_wiki_page: {
|
|
3101
3361
|
readonly method: "POST";
|
|
3102
3362
|
readonly path: "/wiki-pages/{page_id}/duplicate";
|
|
3103
3363
|
readonly scope: "wikis:write";
|
|
3104
3364
|
};
|
|
3365
|
+
readonly move_wiki_page: {
|
|
3366
|
+
readonly method: "POST";
|
|
3367
|
+
readonly path: "/wiki-pages/{page_id}/move";
|
|
3368
|
+
readonly scope: "wikis:write";
|
|
3369
|
+
};
|
|
3105
3370
|
readonly read_calendar_event: {
|
|
3106
3371
|
readonly method: "GET";
|
|
3107
3372
|
readonly path: "/calendar-events/{event_id}";
|
|
@@ -3162,9 +3427,9 @@ export declare const pluginApiOperations: {
|
|
|
3162
3427
|
readonly path: "/projects/{project_id}/grants";
|
|
3163
3428
|
readonly scope: "sharing:write";
|
|
3164
3429
|
};
|
|
3165
|
-
readonly
|
|
3430
|
+
readonly set_file_grants: {
|
|
3166
3431
|
readonly method: "PUT";
|
|
3167
|
-
readonly path: "/
|
|
3432
|
+
readonly path: "/files/{file_id}/grants";
|
|
3168
3433
|
readonly scope: "sharing:write";
|
|
3169
3434
|
};
|
|
3170
3435
|
readonly set_queue_grants: {
|
|
@@ -3202,10 +3467,10 @@ export declare const pluginApiOperations: {
|
|
|
3202
3467
|
readonly path: "/projects/{project_id}/duplicate";
|
|
3203
3468
|
readonly scope: "projects:write";
|
|
3204
3469
|
};
|
|
3205
|
-
readonly
|
|
3470
|
+
readonly duplicate_file: {
|
|
3206
3471
|
readonly method: "POST";
|
|
3207
|
-
readonly path: "/
|
|
3208
|
-
readonly scope: "
|
|
3472
|
+
readonly path: "/files/{file_id}/duplicate";
|
|
3473
|
+
readonly scope: "files:write";
|
|
3209
3474
|
};
|
|
3210
3475
|
readonly duplicate_queue: {
|
|
3211
3476
|
readonly method: "POST";
|
|
@@ -3242,7 +3507,7 @@ export declare const pluginApiOperations: {
|
|
|
3242
3507
|
readonly path: "/search/suggest";
|
|
3243
3508
|
readonly scope: {
|
|
3244
3509
|
readonly per: "entity_type";
|
|
3245
|
-
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "
|
|
3510
|
+
readonly any_of: readonly ["calendars:read", "comments:read", "counter_groups:read", "dashboards:read", "files:read", "galleries:read", "posts:read", "projects:read", "queues:read", "tags:read", "wikis:read"];
|
|
3246
3511
|
};
|
|
3247
3512
|
};
|
|
3248
3513
|
readonly list_property_definitions: {
|
|
@@ -3261,7 +3526,7 @@ export declare const pluginApiOperations: {
|
|
|
3261
3526
|
readonly counter: "counter_groups:write";
|
|
3262
3527
|
readonly counter_group: "counter_groups:write";
|
|
3263
3528
|
readonly dashboard: "dashboards:write";
|
|
3264
|
-
readonly
|
|
3529
|
+
readonly file: "files:write";
|
|
3265
3530
|
readonly gallery: "galleries:write";
|
|
3266
3531
|
readonly gallery_image: "galleries:write";
|
|
3267
3532
|
readonly post: "posts:write";
|
|
@@ -3283,7 +3548,7 @@ export declare const pluginApiOperations: {
|
|
|
3283
3548
|
readonly calendar: "calendars:write";
|
|
3284
3549
|
readonly counter_group: "counter_groups:write";
|
|
3285
3550
|
readonly dashboard: "dashboards:write";
|
|
3286
|
-
readonly
|
|
3551
|
+
readonly file: "files:write";
|
|
3287
3552
|
readonly gallery: "galleries:write";
|
|
3288
3553
|
readonly post: "posts:write";
|
|
3289
3554
|
readonly project: "projects:write";
|
|
@@ -3312,7 +3577,7 @@ export declare class PluginApi {
|
|
|
3312
3577
|
/**
|
|
3313
3578
|
* Register a new webhook subscription.
|
|
3314
3579
|
*
|
|
3315
|
-
* `POST /webhooks/subscriptions`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `
|
|
3580
|
+
* `POST /webhooks/subscriptions`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `files:read`, `galleries:read`, `initiatives:read`, `posts:read`, `projects:read`, `queues:read`, `tags:read`, `wikis:read`.
|
|
3316
3581
|
*/
|
|
3317
3582
|
createSubscription(args: {
|
|
3318
3583
|
body: PluginApiOperations["create_subscription"]["body"];
|
|
@@ -3323,7 +3588,7 @@ export declare class PluginApi {
|
|
|
3323
3588
|
* installed plug-in reaches only the subscriptions it registered, and any
|
|
3324
3589
|
* other is a 404.
|
|
3325
3590
|
*
|
|
3326
|
-
* `DELETE /webhooks/subscriptions/{subscription_id}`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `
|
|
3591
|
+
* `DELETE /webhooks/subscriptions/{subscription_id}`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `files:read`, `galleries:read`, `initiatives:read`, `posts:read`, `projects:read`, `queues:read`, `tags:read`, `wikis:read`.
|
|
3327
3592
|
*/
|
|
3328
3593
|
deleteSubscription(args: {
|
|
3329
3594
|
path: PluginApiOperations["delete_subscription"]["path"];
|
|
@@ -3345,21 +3610,21 @@ export declare class PluginApi {
|
|
|
3345
3610
|
body: PluginApiOperations["create_project"]["body"];
|
|
3346
3611
|
}): Promise<PluginApiOperations["create_project"]["answer"]>;
|
|
3347
3612
|
/**
|
|
3348
|
-
* List
|
|
3613
|
+
* List files in the active guild visible to the current user.
|
|
3349
3614
|
*
|
|
3350
|
-
* `GET /
|
|
3615
|
+
* `GET /files/`, needs `files:read`.
|
|
3351
3616
|
*/
|
|
3352
|
-
|
|
3353
|
-
query?: PluginApiOperations["
|
|
3354
|
-
}): Promise<PluginApiOperations["
|
|
3617
|
+
listFiles(args?: {
|
|
3618
|
+
query?: PluginApiOperations["list_files"]["query"];
|
|
3619
|
+
}): Promise<PluginApiOperations["list_files"]["answer"]>;
|
|
3355
3620
|
/**
|
|
3356
|
-
* Create
|
|
3621
|
+
* Create File
|
|
3357
3622
|
*
|
|
3358
|
-
* `POST /
|
|
3623
|
+
* `POST /files/`, needs `files:write`.
|
|
3359
3624
|
*/
|
|
3360
|
-
|
|
3361
|
-
body: PluginApiOperations["
|
|
3362
|
-
}): Promise<PluginApiOperations["
|
|
3625
|
+
createFile(args: {
|
|
3626
|
+
body: PluginApiOperations["create_file"]["body"];
|
|
3627
|
+
}): Promise<PluginApiOperations["create_file"]["answer"]>;
|
|
3363
3628
|
/**
|
|
3364
3629
|
* List queues visible to the current user.
|
|
3365
3630
|
*
|
|
@@ -3608,23 +3873,23 @@ export declare class PluginApi {
|
|
|
3608
3873
|
query?: PluginApiOperations["get_initiative"]["query"];
|
|
3609
3874
|
}): Promise<PluginApiOperations["get_initiative"]["answer"]>;
|
|
3610
3875
|
/**
|
|
3611
|
-
* Read
|
|
3876
|
+
* Read File
|
|
3612
3877
|
*
|
|
3613
|
-
* `GET /
|
|
3878
|
+
* `GET /files/{file_id}`, needs `files:read`.
|
|
3614
3879
|
*/
|
|
3615
|
-
|
|
3616
|
-
path: PluginApiOperations["
|
|
3617
|
-
query?: PluginApiOperations["
|
|
3618
|
-
}): Promise<PluginApiOperations["
|
|
3880
|
+
readFile(args: {
|
|
3881
|
+
path: PluginApiOperations["read_file"]["path"];
|
|
3882
|
+
query?: PluginApiOperations["read_file"]["query"];
|
|
3883
|
+
}): Promise<PluginApiOperations["read_file"]["answer"]>;
|
|
3619
3884
|
/**
|
|
3620
|
-
* Update
|
|
3885
|
+
* Update File
|
|
3621
3886
|
*
|
|
3622
|
-
* `PATCH /
|
|
3887
|
+
* `PATCH /files/{file_id}`, needs `files:write`.
|
|
3623
3888
|
*/
|
|
3624
|
-
|
|
3625
|
-
path: PluginApiOperations["
|
|
3626
|
-
body: PluginApiOperations["
|
|
3627
|
-
}): Promise<PluginApiOperations["
|
|
3889
|
+
updateFile(args: {
|
|
3890
|
+
path: PluginApiOperations["update_file"]["path"];
|
|
3891
|
+
body: PluginApiOperations["update_file"]["body"];
|
|
3892
|
+
}): Promise<PluginApiOperations["update_file"]["answer"]>;
|
|
3628
3893
|
/**
|
|
3629
3894
|
* Read Queue
|
|
3630
3895
|
*
|
|
@@ -3643,6 +3908,15 @@ export declare class PluginApi {
|
|
|
3643
3908
|
path: PluginApiOperations["update_queue"]["path"];
|
|
3644
3909
|
body: PluginApiOperations["update_queue"]["body"];
|
|
3645
3910
|
}): Promise<PluginApiOperations["update_queue"]["answer"]>;
|
|
3911
|
+
/**
|
|
3912
|
+
* Add an item to a queue. Requires write access.
|
|
3913
|
+
*
|
|
3914
|
+
* `POST /queues/{queue_id}/items`, needs `queues:write`.
|
|
3915
|
+
*/
|
|
3916
|
+
addQueueItem(args: {
|
|
3917
|
+
path: PluginApiOperations["add_queue_item"]["path"];
|
|
3918
|
+
body: PluginApiOperations["add_queue_item"]["body"];
|
|
3919
|
+
}): Promise<PluginApiOperations["add_queue_item"]["answer"]>;
|
|
3646
3920
|
/**
|
|
3647
3921
|
* Start the queue: set active, reset to first item, round 1.
|
|
3648
3922
|
*
|
|
@@ -3753,6 +4027,32 @@ export declare class PluginApi {
|
|
|
3753
4027
|
path: PluginApiOperations["update_counter_group"]["path"];
|
|
3754
4028
|
body: PluginApiOperations["update_counter_group"]["body"];
|
|
3755
4029
|
}): Promise<PluginApiOperations["update_counter_group"]["answer"]>;
|
|
4030
|
+
/**
|
|
4031
|
+
* Add Counter
|
|
4032
|
+
*
|
|
4033
|
+
* `POST /counter-groups/{group_id}/counters`, needs `counter_groups:write`.
|
|
4034
|
+
*/
|
|
4035
|
+
addCounter(args: {
|
|
4036
|
+
path: PluginApiOperations["add_counter"]["path"];
|
|
4037
|
+
body: PluginApiOperations["add_counter"]["body"];
|
|
4038
|
+
}): Promise<PluginApiOperations["add_counter"]["answer"]>;
|
|
4039
|
+
/**
|
|
4040
|
+
* Reset All Counters
|
|
4041
|
+
*
|
|
4042
|
+
* `POST /counter-groups/{group_id}/reset-all`, needs `counter_groups:write`.
|
|
4043
|
+
*/
|
|
4044
|
+
resetAllCounters(args: {
|
|
4045
|
+
path: PluginApiOperations["reset_all_counters"]["path"];
|
|
4046
|
+
}): Promise<PluginApiOperations["reset_all_counters"]["answer"]>;
|
|
4047
|
+
/**
|
|
4048
|
+
* Sort Counters
|
|
4049
|
+
*
|
|
4050
|
+
* `POST /counter-groups/{group_id}/sort`, needs `counter_groups:write`.
|
|
4051
|
+
*/
|
|
4052
|
+
sortCounters(args: {
|
|
4053
|
+
path: PluginApiOperations["sort_counters"]["path"];
|
|
4054
|
+
body: PluginApiOperations["sort_counters"]["body"];
|
|
4055
|
+
}): Promise<PluginApiOperations["sort_counters"]["answer"]>;
|
|
3756
4056
|
/**
|
|
3757
4057
|
* One counter by id — the read-back for a `counters.*` event.
|
|
3758
4058
|
*
|
|
@@ -3762,6 +4062,15 @@ export declare class PluginApi {
|
|
|
3762
4062
|
path: PluginApiOperations["read_counter"]["path"];
|
|
3763
4063
|
query?: PluginApiOperations["read_counter"]["query"];
|
|
3764
4064
|
}): Promise<PluginApiOperations["read_counter"]["answer"]>;
|
|
4065
|
+
/**
|
|
4066
|
+
* Update Counter
|
|
4067
|
+
*
|
|
4068
|
+
* `PATCH /counters/{counter_id}`, needs `counter_groups:write`.
|
|
4069
|
+
*/
|
|
4070
|
+
updateCounter(args: {
|
|
4071
|
+
path: PluginApiOperations["update_counter"]["path"];
|
|
4072
|
+
body: PluginApiOperations["update_counter"]["body"];
|
|
4073
|
+
}): Promise<PluginApiOperations["update_counter"]["answer"]>;
|
|
3765
4074
|
/**
|
|
3766
4075
|
* Copy the counter to the end of its group as "<name> (Copy)", with its
|
|
3767
4076
|
* count, tags and properties.
|
|
@@ -3873,6 +4182,72 @@ export declare class PluginApi {
|
|
|
3873
4182
|
path: PluginApiOperations["list_gallery_images"]["path"];
|
|
3874
4183
|
query?: PluginApiOperations["list_gallery_images"]["query"];
|
|
3875
4184
|
}): Promise<PluginApiOperations["list_gallery_images"]["answer"]>;
|
|
4185
|
+
/**
|
|
4186
|
+
* Add one picture to a gallery. Requires write access.
|
|
4187
|
+
*
|
|
4188
|
+
* `POST /galleries/{gallery_id}/images`, needs `galleries:write`.
|
|
4189
|
+
*/
|
|
4190
|
+
uploadGalleryImage(args: {
|
|
4191
|
+
path: PluginApiOperations["upload_gallery_image"]["path"];
|
|
4192
|
+
body: PluginApiOperations["upload_gallery_image"]["body"];
|
|
4193
|
+
}): Promise<PluginApiOperations["upload_gallery_image"]["answer"]>;
|
|
4194
|
+
/**
|
|
4195
|
+
* The months this gallery has pictures in, newest first — what the timeline
|
|
4196
|
+
* rail is drawn from. Takes the same filters the list does, so the rail is a
|
|
4197
|
+
* picture of the list as it currently stands.
|
|
4198
|
+
*
|
|
4199
|
+
* `GET /galleries/{gallery_id}/images/timeline`, needs `galleries:read`.
|
|
4200
|
+
*/
|
|
4201
|
+
getGalleryImageTimeline(args: {
|
|
4202
|
+
path: PluginApiOperations["get_gallery_image_timeline"]["path"];
|
|
4203
|
+
query?: PluginApiOperations["get_gallery_image_timeline"]["query"];
|
|
4204
|
+
}): Promise<PluginApiOperations["get_gallery_image_timeline"]["answer"]>;
|
|
4205
|
+
/**
|
|
4206
|
+
* Read Gallery Image
|
|
4207
|
+
*
|
|
4208
|
+
* `GET /galleries/{gallery_id}/images/{image_id}`, needs `galleries:read`.
|
|
4209
|
+
*/
|
|
4210
|
+
readGalleryImage(args: {
|
|
4211
|
+
path: PluginApiOperations["read_gallery_image"]["path"];
|
|
4212
|
+
}): Promise<PluginApiOperations["read_gallery_image"]["answer"]>;
|
|
4213
|
+
/**
|
|
4214
|
+
* Retitle, caption, retag or set the properties of a picture. Requires write
|
|
4215
|
+
* access on the gallery.
|
|
4216
|
+
*
|
|
4217
|
+
* `PATCH /galleries/{gallery_id}/images/{image_id}`, needs `galleries:write`.
|
|
4218
|
+
*/
|
|
4219
|
+
updateGalleryImage(args: {
|
|
4220
|
+
path: PluginApiOperations["update_gallery_image"]["path"];
|
|
4221
|
+
body: PluginApiOperations["update_gallery_image"]["body"];
|
|
4222
|
+
}): Promise<PluginApiOperations["update_gallery_image"]["answer"]>;
|
|
4223
|
+
/**
|
|
4224
|
+
* Every stored rendition of a picture, newest first.
|
|
4225
|
+
*
|
|
4226
|
+
* `GET /galleries/{gallery_id}/images/{image_id}/versions`, needs `galleries:read`.
|
|
4227
|
+
*/
|
|
4228
|
+
listGalleryImageVersions(args: {
|
|
4229
|
+
path: PluginApiOperations["list_gallery_image_versions"]["path"];
|
|
4230
|
+
}): Promise<PluginApiOperations["list_gallery_image_versions"]["answer"]>;
|
|
4231
|
+
/**
|
|
4232
|
+
* Replace a picture with a new rendition, keeping the old one as history.
|
|
4233
|
+
* Requires write access on the gallery.
|
|
4234
|
+
*
|
|
4235
|
+
* `POST /galleries/{gallery_id}/images/{image_id}/versions`, needs `galleries:write`.
|
|
4236
|
+
*/
|
|
4237
|
+
uploadGalleryImageVersion(args: {
|
|
4238
|
+
path: PluginApiOperations["upload_gallery_image_version"]["path"];
|
|
4239
|
+
body: PluginApiOperations["upload_gallery_image_version"]["body"];
|
|
4240
|
+
}): Promise<PluginApiOperations["upload_gallery_image_version"]["answer"]>;
|
|
4241
|
+
/**
|
|
4242
|
+
* Delete one rendition of a picture. Owner only. Deleting the current one
|
|
4243
|
+
* promotes the previous; deleting the last is refused — remove the picture
|
|
4244
|
+
* instead.
|
|
4245
|
+
*
|
|
4246
|
+
* `DELETE /galleries/{gallery_id}/images/{image_id}/versions/{version_id}`, needs `galleries:write`.
|
|
4247
|
+
*/
|
|
4248
|
+
deleteGalleryImageVersion(args: {
|
|
4249
|
+
path: PluginApiOperations["delete_gallery_image_version"]["path"];
|
|
4250
|
+
}): Promise<PluginApiOperations["delete_gallery_image_version"]["answer"]>;
|
|
3876
4251
|
/**
|
|
3877
4252
|
* Read Wiki
|
|
3878
4253
|
*
|
|
@@ -3898,6 +4273,16 @@ export declare class PluginApi {
|
|
|
3898
4273
|
listWikiPages(args: {
|
|
3899
4274
|
path: PluginApiOperations["list_wiki_pages"]["path"];
|
|
3900
4275
|
}): Promise<PluginApiOperations["list_wiki_pages"]["answer"]>;
|
|
4276
|
+
/**
|
|
4277
|
+
* Add a page. Write access on the wiki is the whole gate — a page is the
|
|
4278
|
+
* wiki's content.
|
|
4279
|
+
*
|
|
4280
|
+
* `POST /wikis/{wiki_id}/pages`, needs `wikis:write`.
|
|
4281
|
+
*/
|
|
4282
|
+
createWikiPage(args: {
|
|
4283
|
+
path: PluginApiOperations["create_wiki_page"]["path"];
|
|
4284
|
+
body: PluginApiOperations["create_wiki_page"]["body"];
|
|
4285
|
+
}): Promise<PluginApiOperations["create_wiki_page"]["answer"]>;
|
|
3901
4286
|
/**
|
|
3902
4287
|
* One page by its own id, which is all a link to it, a mention or a stored
|
|
3903
4288
|
* notification names.
|
|
@@ -3907,6 +4292,15 @@ export declare class PluginApi {
|
|
|
3907
4292
|
readWikiPage(args: {
|
|
3908
4293
|
path: PluginApiOperations["read_wiki_page"]["path"];
|
|
3909
4294
|
}): Promise<PluginApiOperations["read_wiki_page"]["answer"]>;
|
|
4295
|
+
/**
|
|
4296
|
+
* Update Wiki Page
|
|
4297
|
+
*
|
|
4298
|
+
* `PATCH /wiki-pages/{page_id}`, needs `wikis:write`.
|
|
4299
|
+
*/
|
|
4300
|
+
updateWikiPage(args: {
|
|
4301
|
+
path: PluginApiOperations["update_wiki_page"]["path"];
|
|
4302
|
+
body: PluginApiOperations["update_wiki_page"]["body"];
|
|
4303
|
+
}): Promise<PluginApiOperations["update_wiki_page"]["answer"]>;
|
|
3910
4304
|
/**
|
|
3911
4305
|
* Copy the page, without the pages under it, to the end of where it is filed,
|
|
3912
4306
|
* as "<title> (Copy)", with its tags, links and properties.
|
|
@@ -3916,6 +4310,15 @@ export declare class PluginApi {
|
|
|
3916
4310
|
duplicateWikiPage(args: {
|
|
3917
4311
|
path: PluginApiOperations["duplicate_wiki_page"]["path"];
|
|
3918
4312
|
}): Promise<PluginApiOperations["duplicate_wiki_page"]["answer"]>;
|
|
4313
|
+
/**
|
|
4314
|
+
* File a page and place it there in one request — what a drag is.
|
|
4315
|
+
*
|
|
4316
|
+
* `POST /wiki-pages/{page_id}/move`, needs `wikis:write`.
|
|
4317
|
+
*/
|
|
4318
|
+
moveWikiPage(args: {
|
|
4319
|
+
path: PluginApiOperations["move_wiki_page"]["path"];
|
|
4320
|
+
body: PluginApiOperations["move_wiki_page"]["body"];
|
|
4321
|
+
}): Promise<PluginApiOperations["move_wiki_page"]["answer"]>;
|
|
3919
4322
|
/**
|
|
3920
4323
|
* Read Calendar Event
|
|
3921
4324
|
*
|
|
@@ -4031,16 +4434,16 @@ export declare class PluginApi {
|
|
|
4031
4434
|
body: PluginApiOperations["set_project_grants"]["body"];
|
|
4032
4435
|
}): Promise<PluginApiOperations["set_project_grants"]["answer"]>;
|
|
4033
4436
|
/**
|
|
4034
|
-
* Replace the
|
|
4035
|
-
*
|
|
4437
|
+
* Replace the file's entire sharing state in one call — the body is the full
|
|
4438
|
+
* list of grants (all-initiative-members / per-user / per-role). Every
|
|
4036
4439
|
* non-owner grant is rebuilt from it; the owner is always preserved.
|
|
4037
4440
|
*
|
|
4038
|
-
* `PUT /
|
|
4441
|
+
* `PUT /files/{file_id}/grants`, needs `sharing:write`.
|
|
4039
4442
|
*/
|
|
4040
|
-
|
|
4041
|
-
path: PluginApiOperations["
|
|
4042
|
-
body: PluginApiOperations["
|
|
4043
|
-
}): Promise<PluginApiOperations["
|
|
4443
|
+
setFileGrants(args: {
|
|
4444
|
+
path: PluginApiOperations["set_file_grants"]["path"];
|
|
4445
|
+
body: PluginApiOperations["set_file_grants"]["body"];
|
|
4446
|
+
}): Promise<PluginApiOperations["set_file_grants"]["answer"]>;
|
|
4044
4447
|
/**
|
|
4045
4448
|
* Replace the queue's entire sharing state in one call — the body is the full
|
|
4046
4449
|
* list of grants (all-initiative-members / per-user / per-role). Every
|
|
@@ -4087,8 +4490,8 @@ export declare class PluginApi {
|
|
|
4087
4490
|
}): Promise<PluginApiOperations["set_post_grants"]["answer"]>;
|
|
4088
4491
|
/**
|
|
4089
4492
|
* Replace the gallery's entire sharing state in one call — the body is the
|
|
4090
|
-
* full list of grants
|
|
4091
|
-
* always preserved.
|
|
4493
|
+
* full list of grants (all-initiative-members / per-user / per-role). Every
|
|
4494
|
+
* non-owner grant is rebuilt from it; the owner is always preserved.
|
|
4092
4495
|
*
|
|
4093
4496
|
* `PUT /galleries/{gallery_id}/grants`, needs `sharing:write`.
|
|
4094
4497
|
*/
|
|
@@ -4097,7 +4500,9 @@ export declare class PluginApi {
|
|
|
4097
4500
|
body: PluginApiOperations["set_gallery_grants"]["body"];
|
|
4098
4501
|
}): Promise<PluginApiOperations["set_gallery_grants"]["answer"]>;
|
|
4099
4502
|
/**
|
|
4100
|
-
*
|
|
4503
|
+
* Replace the wiki's entire sharing state in one call — the body is the full
|
|
4504
|
+
* list of grants (all-initiative-members / per-user / per-role). Every
|
|
4505
|
+
* non-owner grant is rebuilt from it; the owner is always preserved.
|
|
4101
4506
|
*
|
|
4102
4507
|
* `PUT /wikis/{wiki_id}/grants`, needs `sharing:write`.
|
|
4103
4508
|
*/
|
|
@@ -4125,12 +4530,12 @@ export declare class PluginApi {
|
|
|
4125
4530
|
* initiative, and carries the tags its maker may set: an installed plug-in's
|
|
4126
4531
|
* copy carries them only when it holds the scope to tag.
|
|
4127
4532
|
*
|
|
4128
|
-
* `POST /
|
|
4533
|
+
* `POST /files/{file_id}/duplicate`, needs `files:write`.
|
|
4129
4534
|
*/
|
|
4130
|
-
|
|
4131
|
-
path: PluginApiOperations["
|
|
4132
|
-
body?: PluginApiOperations["
|
|
4133
|
-
}): Promise<PluginApiOperations["
|
|
4535
|
+
duplicateFile(args: {
|
|
4536
|
+
path: PluginApiOperations["duplicate_file"]["path"];
|
|
4537
|
+
body?: PluginApiOperations["duplicate_file"]["body"];
|
|
4538
|
+
}): Promise<PluginApiOperations["duplicate_file"]["answer"]>;
|
|
4134
4539
|
/**
|
|
4135
4540
|
* Copy it, with everything inside it, into an initiative: its own unless the
|
|
4136
4541
|
* body names another. Read is enough to copy a template; anything else needs
|
|
@@ -4212,7 +4617,7 @@ export declare class PluginApi {
|
|
|
4212
4617
|
/**
|
|
4213
4618
|
* Titles for the command palette — a way to reach one thing quickly.
|
|
4214
4619
|
*
|
|
4215
|
-
* `GET /search/suggest`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `
|
|
4620
|
+
* `GET /search/suggest`, needs one of `calendars:read`, `comments:read`, `counter_groups:read`, `dashboards:read`, `files:read`, `galleries:read`, `posts:read`, `projects:read`, `queues:read`, `tags:read`, `wikis:read`.
|
|
4216
4621
|
*/
|
|
4217
4622
|
suggestCommunity(args: {
|
|
4218
4623
|
query: PluginApiOperations["suggest_community"]["query"];
|