backlog-js 0.16.0 → 0.17.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.
@@ -0,0 +1,2047 @@
1
+ declare namespace types_d_exports {
2
+ export { ActivityType, ClassicRoleType, CustomFieldType, Fetch, IssueTypeColor, Language, NormalRoleType, ProjectStatusColor, RoleType, TextFormattingRule, WebhookActivityId };
3
+ }
4
+ type TextFormattingRule = "backlog" | "markdown";
5
+ declare enum ClassicRoleType {
6
+ Admin = 1,
7
+ User = 2,
8
+ Reporter = 3,
9
+ Viewer = 4,
10
+ GuestReporter = 5,
11
+ GuestViewer = 6
12
+ }
13
+ declare enum NormalRoleType {
14
+ Admin = 1,
15
+ MemberOrGuest = 2,
16
+ MemberOrGuestForAddIssues = 3,
17
+ MemberOrGuestForViewIssues = 4
18
+ }
19
+ type RoleType = ClassicRoleType | NormalRoleType;
20
+ type Language = "en" | "ja" | null;
21
+ declare enum ActivityType {
22
+ Undefined = -1,
23
+ IssueCreated = 1,
24
+ IssueUpdated = 2,
25
+ IssueCommented = 3,
26
+ IssueDeleted = 4,
27
+ WikiCreated = 5,
28
+ WikiUpdated = 6,
29
+ WikiDeleted = 7,
30
+ FileAdded = 8,
31
+ FileUpdated = 9,
32
+ FileDeleted = 10,
33
+ SvnCommitted = 11,
34
+ GitPushed = 12,
35
+ GitRepositoryCreated = 13,
36
+ IssueMultiUpdated = 14,
37
+ ProjectUserAdded = 15,
38
+ ProjectUserRemoved = 16,
39
+ NotifyAdded = 17,
40
+ PullRequestAdded = 18,
41
+ PullRequestUpdated = 19,
42
+ PullRequestCommented = 20,
43
+ PullRequestMerged = 21,
44
+ MilestoneCreated = 22,
45
+ MilestoneUpdated = 23,
46
+ MilestoneDeleted = 24,
47
+ ProjectGroupAdded = 25,
48
+ ProjectGroupDeleted = 26,
49
+ IssuesDatesUpdated = 35,
50
+ StatusDeleted = 34,
51
+ DocumentCreated = 36,
52
+ DocumentDeleted = 37,
53
+ DocumentTitleUpdated = 38,
54
+ DocumentCommentCreated = 40,
55
+ DocumentCommentUpdated = 41,
56
+ DocumentCommentDeleted = 42,
57
+ DocumentCommentReplyCreated = 43,
58
+ DocumentCommentReplyUpdated = 44,
59
+ DocumentCommentReplyDeleted = 45,
60
+ DocumentAttachmentCreated = 46,
61
+ IssueMultiCreated = 47,
62
+ DocumentMultiCreated = 48
63
+ }
64
+ type IssueTypeColor = "#e30000" | "#990000" | "#934981" | "#814fbc" | "#2779ca" | "#007e9a" | "#7ea800" | "#ff9200" | "#ff3265" | "#666665";
65
+ type ProjectStatusColor = "#ea2c00" | "#e87758" | "#e07b9a" | "#868cb7" | "#3b9dbd" | "#4caf93" | "#b0be3c" | "#eda62a" | "#f42858" | "#393939";
66
+ declare enum CustomFieldType {
67
+ Text = 1,
68
+ TextArea = 2,
69
+ Numeric = 3,
70
+ Date = 4,
71
+ SingleList = 5,
72
+ MultipleList = 6,
73
+ CheckBox = 7,
74
+ Radio = 8
75
+ }
76
+ type WebhookActivityId = number;
77
+ type Fetch = typeof globalThis.fetch;
78
+ declare namespace option_d_exports {
79
+ export { Document$1 as Document, Issue$1 as Issue, Notification$1 as Notification, OAuth2$2 as OAuth2, Order, Project$1 as Project, PullRequest$1 as PullRequest, Space$1 as Space, Team$1 as Team, User$1 as User, WatchingList$1 as WatchingList, Wiki$1 as Wiki };
80
+ }
81
+ type Order = "asc" | "desc";
82
+ declare namespace Notification$1 {
83
+ interface GetNotificationsParams {
84
+ minId?: number;
85
+ maxId?: number;
86
+ count?: number;
87
+ order?: Order;
88
+ }
89
+ interface GetNotificationsCountParams {
90
+ alreadyRead: boolean;
91
+ resourceAlreadyRead: boolean;
92
+ }
93
+ }
94
+ declare namespace Document$1 {
95
+ interface GetDocumentsParams {
96
+ projectId?: number[];
97
+ keyword?: string;
98
+ sort?: "created" | "updated";
99
+ order?: Order;
100
+ offset: number;
101
+ count?: number;
102
+ }
103
+ interface AddDocumentParams {
104
+ projectId: number;
105
+ title?: string;
106
+ content?: string;
107
+ emoji?: string;
108
+ parentId?: string;
109
+ addLast?: boolean;
110
+ }
111
+ }
112
+ declare namespace Space$1 {
113
+ interface GetActivitiesParams {
114
+ activityTypeId?: ActivityType[];
115
+ minId?: number;
116
+ maxId?: number;
117
+ count?: number;
118
+ order?: Order;
119
+ }
120
+ interface PutSpaceNotificationParams {
121
+ content: string;
122
+ }
123
+ }
124
+ declare namespace User$1 {
125
+ interface PostUserParams {
126
+ userId: string;
127
+ password: string;
128
+ name: string;
129
+ mailAddress: string;
130
+ roleType: RoleType;
131
+ }
132
+ interface PatchUserParams {
133
+ password?: string;
134
+ name?: string;
135
+ mailAddress?: string;
136
+ roleType?: RoleType;
137
+ }
138
+ interface GetUserActivitiesParams {
139
+ activityTypeId?: ActivityType[];
140
+ minId?: number;
141
+ maxId?: number;
142
+ count?: number;
143
+ order?: Order;
144
+ }
145
+ interface GetUserStarsParams {
146
+ minId?: number;
147
+ maxId?: number;
148
+ count?: number;
149
+ order?: Order;
150
+ }
151
+ interface GetUserStarsCountParams {
152
+ since?: string;
153
+ until?: string;
154
+ }
155
+ interface GetRecentlyViewedParams {
156
+ order?: Order;
157
+ offset?: number;
158
+ count?: number;
159
+ }
160
+ }
161
+ declare namespace WatchingList$1 {
162
+ interface GetWatchingListParams {
163
+ order?: Order;
164
+ sort?: "created" | "updated" | "issueUpdated";
165
+ count?: number;
166
+ offset?: number;
167
+ resourceAlreadyRead?: boolean;
168
+ issueId?: number[];
169
+ }
170
+ interface GetWatchingListCountParams {
171
+ resourceAlreadyRead?: boolean;
172
+ alreadyRead?: boolean;
173
+ }
174
+ interface PostWatchingListItemParams {
175
+ issueIdOrKey: string | number;
176
+ note: string;
177
+ }
178
+ }
179
+ declare namespace Team$1 {
180
+ interface GetTeamsParams {
181
+ order?: Order;
182
+ offset?: number;
183
+ count?: number;
184
+ }
185
+ interface PostTeamParams {
186
+ name: string;
187
+ members?: number[];
188
+ }
189
+ interface PatchTeamParams {
190
+ name?: string;
191
+ members?: number[];
192
+ }
193
+ }
194
+ declare namespace Project$1 {
195
+ interface PostProjectParams {
196
+ name: string;
197
+ key: string;
198
+ chartEnabled: boolean;
199
+ projectLeaderCanEditProjectLeader?: boolean;
200
+ subtaskingEnabled: boolean;
201
+ grandchildIssueEnabled?: boolean;
202
+ textFormattingRule: TextFormattingRule;
203
+ }
204
+ interface PatchProjectParams {
205
+ name?: string;
206
+ key?: string;
207
+ chartEnabled?: boolean;
208
+ subtaskingEnabled?: boolean;
209
+ grandchildIssueEnabled?: boolean;
210
+ projectLeaderCanEditProjectLeader?: boolean;
211
+ textFormattingRule?: TextFormattingRule;
212
+ archived?: boolean;
213
+ }
214
+ interface GetProjectsParams {
215
+ archived?: boolean;
216
+ all?: boolean;
217
+ }
218
+ interface DeleteProjectUsersParams {
219
+ userId: number;
220
+ }
221
+ interface PostProjectAdministrators {
222
+ userId: number;
223
+ }
224
+ interface DeleteProjectAdministrators {
225
+ userId: number;
226
+ }
227
+ interface PostIssueTypeParams {
228
+ name: string;
229
+ color: IssueTypeColor;
230
+ }
231
+ interface PatchIssueTypeParams {
232
+ name?: string;
233
+ color?: IssueTypeColor;
234
+ }
235
+ interface DeleteIssueTypeParams {
236
+ substituteIssueTypeId: number;
237
+ }
238
+ interface PostCategoriesParams {
239
+ name: string;
240
+ }
241
+ interface PatchCategoriesParams {
242
+ name: string;
243
+ }
244
+ interface PostVersionsParams {
245
+ name: string;
246
+ description?: string;
247
+ startDate?: string;
248
+ releaseDueDate?: string;
249
+ }
250
+ interface PatchVersionsParams {
251
+ name: string;
252
+ description?: string;
253
+ startDate?: string;
254
+ releaseDueDate?: string;
255
+ archived?: boolean;
256
+ }
257
+ interface PostCustomFieldParams {
258
+ typeId: CustomFieldType;
259
+ name: string;
260
+ applicableIssueTypes?: number[];
261
+ description?: string;
262
+ required?: boolean;
263
+ }
264
+ interface PostCustomFieldWithNumericParams extends PostCustomFieldParams {
265
+ min?: number;
266
+ max?: number;
267
+ initialValue?: number;
268
+ unit?: string;
269
+ }
270
+ interface PostCustomFieldWithDateParams extends PostCustomFieldParams {
271
+ min?: string;
272
+ max?: string;
273
+ initialValueType?: number;
274
+ initialDate?: string;
275
+ initialShift?: number;
276
+ }
277
+ interface PostCustomFieldWithListParams extends PostCustomFieldParams {
278
+ items?: string[];
279
+ allowInput?: boolean;
280
+ allowAddItem?: boolean;
281
+ }
282
+ interface PatchCustomFieldParams {
283
+ name?: string;
284
+ applicableIssueTypes?: number[];
285
+ description?: string;
286
+ required?: boolean;
287
+ }
288
+ interface PatchCustomFieldWithNumericParams extends PatchCustomFieldParams {
289
+ min?: number;
290
+ max?: number;
291
+ initialValue?: number;
292
+ unit?: string;
293
+ }
294
+ interface PatchCustomFieldWithDateParams extends PatchCustomFieldParams {
295
+ min?: string;
296
+ max?: string;
297
+ initialValueType?: number;
298
+ initialDate?: string;
299
+ initialShift?: number;
300
+ }
301
+ interface PatchCustomFieldWithListParams extends PatchCustomFieldParams {
302
+ items?: string[];
303
+ allowInput?: boolean;
304
+ allowAddItem?: boolean;
305
+ }
306
+ interface PostCustomFieldItemParams {
307
+ name: string;
308
+ }
309
+ interface PatchCustomFieldItemParams {
310
+ name: string;
311
+ }
312
+ interface GetSharedFilesParams {
313
+ order?: Order;
314
+ offset?: number;
315
+ count?: number;
316
+ }
317
+ interface PostWebhookParams {
318
+ name?: string;
319
+ description?: string;
320
+ hookUrl?: string;
321
+ allEvent?: boolean;
322
+ activityTypeIds?: WebhookActivityId[];
323
+ }
324
+ interface PatchWebhookParams {
325
+ name?: string;
326
+ description?: string;
327
+ hookUrl?: string;
328
+ allEvent?: boolean;
329
+ activityTypeIds?: number[];
330
+ }
331
+ interface PostStarParams {
332
+ issueId?: number;
333
+ commentId?: number;
334
+ wikiId?: number;
335
+ pullRequestId?: number;
336
+ pullRequestCommentId?: number;
337
+ }
338
+ interface PostStatusParams {
339
+ name: string;
340
+ color: ProjectStatusColor;
341
+ }
342
+ interface PatchStatusParams {
343
+ name?: string;
344
+ color?: ProjectStatusColor;
345
+ }
346
+ }
347
+ declare namespace Issue$1 {
348
+ interface PostIssueParams {
349
+ projectId: number;
350
+ summary: string;
351
+ priorityId: number;
352
+ issueTypeId: number;
353
+ parentIssueId?: number;
354
+ description?: string;
355
+ startDate?: string;
356
+ dueDate?: string;
357
+ estimatedHours?: number;
358
+ actualHours?: number;
359
+ categoryId?: number[];
360
+ versionId?: number[];
361
+ milestoneId?: number[];
362
+ assigneeId?: number;
363
+ notifiedUserId?: number[];
364
+ attachmentId?: number[];
365
+ [customField_: string]: any;
366
+ }
367
+ interface PatchIssueParams {
368
+ summary?: string;
369
+ parentIssueId?: number;
370
+ description?: string;
371
+ statusId?: number;
372
+ resolutionId?: number;
373
+ startDate?: string;
374
+ dueDate?: string;
375
+ estimatedHours?: number;
376
+ actualHours?: number;
377
+ issueTypeId?: number;
378
+ categoryId?: number[];
379
+ versionId?: number[];
380
+ milestoneId?: number[];
381
+ priorityId?: number;
382
+ assigneeId?: number;
383
+ notifiedUserId?: number[];
384
+ attachmentId?: number[];
385
+ comment?: string;
386
+ [customField_: string]: any;
387
+ }
388
+ interface GetIssuesParams {
389
+ projectId?: number[];
390
+ issueTypeId?: number[];
391
+ categoryId?: number[];
392
+ versionId?: number[];
393
+ milestoneId?: number[];
394
+ statusId?: number[];
395
+ priorityId?: number[];
396
+ assigneeId?: number[];
397
+ createdUserId?: number[];
398
+ resolutionId?: number[];
399
+ parentChild?: ParentChildType;
400
+ attachment?: boolean;
401
+ sharedFile?: boolean;
402
+ sort?: SortKey;
403
+ order?: Order;
404
+ offset?: number;
405
+ count?: number;
406
+ expand?: IssueExpand[];
407
+ createdSince?: string;
408
+ createdUntil?: string;
409
+ updatedSince?: string;
410
+ updatedUntil?: string;
411
+ startDateSince?: string;
412
+ startDateUntil?: string;
413
+ dueDateSince?: string;
414
+ dueDateUntil?: string;
415
+ hasDueDate?: boolean;
416
+ id?: number[];
417
+ parentIssueId?: number[];
418
+ keyword?: string;
419
+ [customField_: string]: any;
420
+ }
421
+ enum ParentChildType {
422
+ All = 0,
423
+ NotChild = 1,
424
+ /** @deprecated Use {@link ChildOrGrandchild}. */
425
+ Child = 2,
426
+ ChildOrGrandchild = 2,
427
+ NotChildNotParent = 3,
428
+ /** @deprecated Use {@link HasChildren}. */
429
+ Parent = 4,
430
+ HasChildren = 4,
431
+ GrandchildOnly = 5,
432
+ ChildOnly = 6,
433
+ TopLevelOnly = 7,
434
+ ExcludeGrandchild = 8,
435
+ ExcludeTopLevel = 9,
436
+ LeafOnly = 10
437
+ }
438
+ type IssueExpand = "childIssueSummary";
439
+ interface GetIssueParams {
440
+ expand?: IssueExpand[];
441
+ }
442
+ type SortKey = "issueType" | "category" | "version" | "milestone" | "summary" | "status" | "priority" | "attachment" | "sharedFile" | "created" | "createdUser" | "updated" | "updatedUser" | "assignee" | "startDate" | "dueDate" | "estimatedHours" | "actualHours" | "childIssue";
443
+ interface GetIssueCommentsParams {
444
+ minId?: number;
445
+ maxId?: number;
446
+ count?: number;
447
+ order?: Order;
448
+ }
449
+ interface PostIssueCommentsParams {
450
+ content: string;
451
+ notifiedUserId?: number[];
452
+ attachmentId?: number[];
453
+ }
454
+ interface PatchIssueCommentParams {
455
+ content: string;
456
+ }
457
+ interface IssueCommentNotifications {
458
+ notifiedUserId: number[];
459
+ }
460
+ interface LinkIssueSharedFilesParams {
461
+ fileId: number[];
462
+ }
463
+ }
464
+ declare namespace PullRequest$1 {
465
+ interface GetPullRequestsParams {
466
+ statusId?: number[];
467
+ assigneeId?: number[];
468
+ issueId?: number[];
469
+ createdUserId?: number[];
470
+ offset?: number;
471
+ count?: number;
472
+ }
473
+ interface PostPullRequestParams {
474
+ summary: string;
475
+ description: string;
476
+ base: string;
477
+ branch: string;
478
+ issueId?: number;
479
+ assigneeId?: number;
480
+ notifiedUserId?: number[];
481
+ attachmentId?: number[];
482
+ }
483
+ interface PatchPullRequestParams {
484
+ summary?: string;
485
+ description?: string;
486
+ issueId?: number;
487
+ assigneeId?: number;
488
+ notifiedUserId?: number[];
489
+ comment?: string[];
490
+ }
491
+ interface GetPullRequestCommentsParams {
492
+ minId?: number;
493
+ maxId?: number;
494
+ count?: number;
495
+ order?: Order;
496
+ }
497
+ interface PostPullRequestCommentsParams {
498
+ content: string;
499
+ notifiedUserId?: number[];
500
+ }
501
+ interface PatchPullRequestCommentsParams {
502
+ content: string;
503
+ }
504
+ }
505
+ declare namespace Wiki$1 {
506
+ interface GetWikiParams {
507
+ projectIdOrKey: string | number;
508
+ keyword?: string;
509
+ }
510
+ interface PostWikiParams {
511
+ projectId: number;
512
+ name: string;
513
+ content: string;
514
+ mailNotify?: boolean;
515
+ }
516
+ interface PatchWikiParams {
517
+ name?: string;
518
+ content?: string;
519
+ mailNotify?: boolean;
520
+ }
521
+ interface GetWikisHistoryParams {
522
+ minId?: number;
523
+ maxId?: number;
524
+ count?: number;
525
+ order?: Order;
526
+ }
527
+ }
528
+ declare namespace OAuth2$2 {
529
+ interface Credentials {
530
+ clientId: string;
531
+ clientSecret: string;
532
+ }
533
+ }
534
+ declare namespace entity_d_exports {
535
+ export { Activity, ChangeLog, CommentNotification, CustomFieldValue, DiskUsage, Document, File, Git, Issue, License, Notification, OAuth2$1 as OAuth2, Project, PullRequest, RateLimit, Space, Star, Team, User, WatchingList, Webhook, Wiki };
536
+ }
537
+ declare namespace File {
538
+ type FileData = NodeFileData | BrowserFileData;
539
+ interface NodeFileData {
540
+ body: ReadableStream;
541
+ url: string;
542
+ filename: string;
543
+ }
544
+ interface BrowserFileData {
545
+ body: any;
546
+ url: string;
547
+ blob?: () => Promise<Blob>;
548
+ }
549
+ interface FileInfo {
550
+ id: number;
551
+ name: string;
552
+ size: number;
553
+ }
554
+ interface IssueFileInfo extends FileInfo {
555
+ createdUser: User.User;
556
+ created: string;
557
+ }
558
+ interface WikiFileInfo extends FileInfo {
559
+ createdUser: User.User;
560
+ created: string;
561
+ }
562
+ interface PullRequestFileInfo extends FileInfo {
563
+ createdUser: User.User;
564
+ created: string;
565
+ }
566
+ interface DocumentFileInfo extends FileInfo {
567
+ createdUser: User.User;
568
+ created: string;
569
+ }
570
+ }
571
+ declare namespace OAuth2$1 {
572
+ interface AccessToken {
573
+ access_token: string;
574
+ token_type: string;
575
+ expires_in: number;
576
+ refresh_token: string;
577
+ }
578
+ }
579
+ declare namespace Space {
580
+ interface Space {
581
+ spaceKey: string;
582
+ name: string;
583
+ ownerId: number;
584
+ lang: string;
585
+ timezone: string;
586
+ reportSendTime: string;
587
+ textFormattingRule: TextFormattingRule;
588
+ created: string;
589
+ updated: string;
590
+ }
591
+ interface Notification {
592
+ content: string;
593
+ updated: string;
594
+ }
595
+ }
596
+ declare namespace Project {
597
+ interface Project {
598
+ id: number;
599
+ projectKey: string;
600
+ name: string;
601
+ chartEnabled: boolean;
602
+ useResolvedForChart: boolean;
603
+ subtaskingEnabled: boolean;
604
+ projectLeaderCanEditProjectLeader: boolean;
605
+ useWiki: boolean;
606
+ useFileSharing: boolean;
607
+ useWikiTreeView: boolean;
608
+ useOriginalImageSizeAtWiki: boolean;
609
+ useSubversion: boolean;
610
+ useGit: boolean;
611
+ textFormattingRule: TextFormattingRule;
612
+ archived: boolean;
613
+ displayOrder: number;
614
+ useDevAttributes: boolean;
615
+ grandchildIssueEnabled?: boolean;
616
+ }
617
+ interface RecentlyViewedProject {
618
+ project: Project;
619
+ updated: string;
620
+ }
621
+ interface ProjectStatus {
622
+ id: number;
623
+ projectId: number;
624
+ name: string;
625
+ color: ProjectStatusColor;
626
+ displayOrder: number;
627
+ }
628
+ interface Category {
629
+ id: number;
630
+ projectId: number;
631
+ name: string;
632
+ displayOrder: number;
633
+ }
634
+ interface Version {
635
+ id: number;
636
+ projectId: number;
637
+ name: string;
638
+ description?: string;
639
+ startDate?: string;
640
+ releaseDueDate?: string;
641
+ archived: boolean;
642
+ displayOrder: number;
643
+ }
644
+ interface CustomFieldItem {
645
+ id: number;
646
+ name: string;
647
+ displayOrder: number;
648
+ }
649
+ interface CustomFieldInitialDate {
650
+ id: number;
651
+ shift?: number;
652
+ date?: string;
653
+ }
654
+ interface CustomField {
655
+ id: number;
656
+ projectId: number;
657
+ typeId: CustomFieldType;
658
+ name: string;
659
+ description: string;
660
+ required: boolean;
661
+ useIssueType: boolean;
662
+ applicableIssueTypes: number[];
663
+ displayOrder: number;
664
+ version: number;
665
+ min?: number | string | null;
666
+ max?: number | string | null;
667
+ initialValue?: number | null;
668
+ unit?: string | null;
669
+ initialDate?: CustomFieldInitialDate | null;
670
+ items?: CustomFieldItem[];
671
+ allowAddItem?: boolean;
672
+ allowInput?: boolean;
673
+ }
674
+ interface SharedFile {
675
+ id: number;
676
+ projectId: number;
677
+ type: string;
678
+ dir: string;
679
+ name: string;
680
+ size: number;
681
+ createdUser: User.User;
682
+ created: string;
683
+ updatedUser: User.User;
684
+ updated: string;
685
+ }
686
+ }
687
+ declare namespace User {
688
+ interface User {
689
+ id: number;
690
+ userId: string;
691
+ name: string;
692
+ roleType: RoleType;
693
+ lang: Language;
694
+ mailAddress: string;
695
+ lastLoginTime: string;
696
+ }
697
+ }
698
+ declare namespace Activity {
699
+ interface ActivityChange {
700
+ field: string;
701
+ field_text: string;
702
+ new_value: string;
703
+ old_value: string;
704
+ type: string;
705
+ }
706
+ interface ActivityAttachment {
707
+ id: number;
708
+ name: string;
709
+ size: number;
710
+ }
711
+ interface ActivitySharedFile {
712
+ id: number;
713
+ dir: string;
714
+ name: string;
715
+ size: number;
716
+ }
717
+ interface ActivityExternalFileLink {
718
+ name: string;
719
+ url: string;
720
+ }
721
+ interface ActivityComment {
722
+ id: number;
723
+ content: string;
724
+ }
725
+ interface IssueCreatedContent {
726
+ id: number;
727
+ key_id: number;
728
+ summary: string;
729
+ description: string;
730
+ }
731
+ interface IssueContent {
732
+ id: number;
733
+ key_id: number;
734
+ summary: string;
735
+ description: string;
736
+ comment: ActivityComment;
737
+ changes: ActivityChange[];
738
+ attachments: ActivityAttachment[];
739
+ shared_files: ActivitySharedFile[];
740
+ external_file_links: ActivityExternalFileLink[];
741
+ }
742
+ interface IssueDeletedContent {
743
+ id: number;
744
+ key_id: number;
745
+ }
746
+ interface MultiUpdateLink {
747
+ id: number;
748
+ key_id: number;
749
+ title: string;
750
+ comment: ActivityComment;
751
+ }
752
+ interface MultiUpdateChange {
753
+ field: string;
754
+ new_value: string;
755
+ type: string;
756
+ }
757
+ interface IssueMultiUpdateContent {
758
+ tx_id: number;
759
+ comment: {
760
+ content: string;
761
+ };
762
+ link: MultiUpdateLink[];
763
+ changes: MultiUpdateChange[];
764
+ }
765
+ interface IssueMultiCreatedLink {
766
+ id: number;
767
+ key_id: number;
768
+ title: string;
769
+ }
770
+ interface IssueMultiCreatedContent {
771
+ link: IssueMultiCreatedLink[];
772
+ }
773
+ interface WikiAttachment {
774
+ id: number;
775
+ name: string;
776
+ size: number;
777
+ }
778
+ interface WikiContent {
779
+ id: number;
780
+ name: string;
781
+ content: string;
782
+ diff: string;
783
+ version: number;
784
+ attachments: WikiAttachment[];
785
+ shared_files: ActivitySharedFile[];
786
+ }
787
+ interface FileContent {
788
+ id: number;
789
+ dir: string;
790
+ name: string;
791
+ size: number;
792
+ }
793
+ interface SvnContent {
794
+ rev: string;
795
+ comment: string;
796
+ }
797
+ interface GitRevision {
798
+ rev: string;
799
+ comment: string;
800
+ }
801
+ interface GitRepository {
802
+ id: number;
803
+ name: string;
804
+ description: string;
805
+ }
806
+ interface GitPushedContent {
807
+ repository: GitRepository;
808
+ change_type: string;
809
+ revision_type: string;
810
+ ref: string;
811
+ revision_count: number;
812
+ revisions: GitRevision[];
813
+ }
814
+ interface GitRepositoryCreatedContent {
815
+ repository: GitRepository;
816
+ }
817
+ interface ProjectMemberUpdatedContent {
818
+ users: User.User[];
819
+ group_project_activities: {
820
+ id: number;
821
+ type: number;
822
+ }[];
823
+ comment: string;
824
+ }
825
+ interface PullRequestChange {
826
+ field: string;
827
+ new_value: string;
828
+ old_value: string;
829
+ }
830
+ interface PullRequestIssue {
831
+ id: number;
832
+ key_id: number;
833
+ issue_key?: string;
834
+ summary: string;
835
+ description: string;
836
+ }
837
+ interface PullRequestContent {
838
+ id: number;
839
+ number: number;
840
+ summary: string;
841
+ description: string;
842
+ comment: ActivityComment | null;
843
+ changes: PullRequestChange[];
844
+ issue: PullRequestIssue | null;
845
+ repository: GitRepository;
846
+ }
847
+ interface VersionContent {
848
+ id: number;
849
+ name: string;
850
+ start_date: string;
851
+ reference_date: string;
852
+ description: string;
853
+ }
854
+ interface VersionChange {
855
+ field: string;
856
+ new_value: string;
857
+ old_value: string;
858
+ }
859
+ interface VersionUpdatedContent {
860
+ id: number;
861
+ name: string;
862
+ changes: VersionChange[];
863
+ }
864
+ interface TeamSnapshot {
865
+ id: number;
866
+ name: string;
867
+ }
868
+ interface ProjectTeamContent {
869
+ parties: TeamSnapshot[];
870
+ }
871
+ interface StatusDeletedContent {
872
+ deletedStatus: {
873
+ name: string;
874
+ };
875
+ link: IssueMultiCreatedLink[];
876
+ change: MultiUpdateChange | null;
877
+ }
878
+ interface DocumentContent {
879
+ id: string;
880
+ title: string;
881
+ }
882
+ interface DocumentMultiContent {
883
+ documents: DocumentContent[];
884
+ }
885
+ type ActivityContent = IssueCreatedContent | IssueContent | IssueDeletedContent | IssueMultiUpdateContent | IssueMultiCreatedContent | WikiContent | FileContent | SvnContent | GitPushedContent | GitRepositoryCreatedContent | ProjectMemberUpdatedContent | PullRequestContent | VersionContent | VersionUpdatedContent | ProjectTeamContent | StatusDeletedContent | DocumentContent | DocumentMultiContent;
886
+ interface Activity {
887
+ id: number;
888
+ project: Project.Project;
889
+ type: ActivityType;
890
+ content: ActivityContent;
891
+ notifications: [];
892
+ createdUser: User.User;
893
+ created: string;
894
+ }
895
+ }
896
+ declare namespace DiskUsage {
897
+ interface DiskUsage {
898
+ issue: number;
899
+ wiki: number;
900
+ file: number;
901
+ subversion: number;
902
+ git: number;
903
+ gitLFS: number;
904
+ }
905
+ interface ProjectDiskUsage extends DiskUsage {
906
+ projectId: number;
907
+ }
908
+ interface SpaceDiskUsage extends DiskUsage {
909
+ capacity: number;
910
+ details: ProjectDiskUsage[];
911
+ }
912
+ }
913
+ declare namespace CommentNotification {
914
+ interface CommentNotification {
915
+ id: number;
916
+ alreadyRead: boolean;
917
+ reason: number;
918
+ user: User.User;
919
+ resourceAlreadyRead: boolean;
920
+ }
921
+ }
922
+ declare namespace Document {
923
+ interface Document {
924
+ id: string;
925
+ projectId: number;
926
+ title: string;
927
+ plain: string;
928
+ json: string;
929
+ statusId: number;
930
+ emoji: string | null;
931
+ attachments: File.DocumentFileInfo[];
932
+ tags: Tag[];
933
+ createdUser: User.User;
934
+ created: string;
935
+ updatedUser: User.User;
936
+ updated: string;
937
+ }
938
+ interface Tag {
939
+ id: number;
940
+ name: string;
941
+ }
942
+ interface ActiveTrashTree {
943
+ id: string;
944
+ children: DocumentTreeNode[];
945
+ }
946
+ interface DocumentTreeNode {
947
+ id: string;
948
+ name?: string;
949
+ children: DocumentTreeNode[];
950
+ statusId?: number;
951
+ emoji?: string;
952
+ emojiType?: string;
953
+ updated?: string;
954
+ }
955
+ interface DocumentTree {
956
+ projectId: string;
957
+ activeTree?: ActiveTrashTree;
958
+ trashTree?: ActiveTrashTree;
959
+ }
960
+ }
961
+ declare namespace CustomFieldValue {
962
+ interface CustomFieldValueItem {
963
+ id: number;
964
+ name: string;
965
+ displayOrder: number;
966
+ }
967
+ interface TextCustomFieldValue {
968
+ id: number;
969
+ fieldTypeId: CustomFieldType.Text | CustomFieldType.TextArea;
970
+ name: string;
971
+ value: string | null;
972
+ }
973
+ interface NumericCustomFieldValue {
974
+ id: number;
975
+ fieldTypeId: CustomFieldType.Numeric;
976
+ name: string;
977
+ value: number | null;
978
+ }
979
+ interface DateCustomFieldValue {
980
+ id: number;
981
+ fieldTypeId: CustomFieldType.Date;
982
+ name: string;
983
+ value: string | null;
984
+ }
985
+ interface SingleListCustomFieldValue {
986
+ id: number;
987
+ fieldTypeId: CustomFieldType.SingleList;
988
+ name: string;
989
+ value: CustomFieldValueItem | null;
990
+ }
991
+ interface MultipleListCustomFieldValue {
992
+ id: number;
993
+ fieldTypeId: CustomFieldType.MultipleList;
994
+ name: string;
995
+ value: CustomFieldValueItem[];
996
+ }
997
+ interface CheckBoxCustomFieldValue {
998
+ id: number;
999
+ fieldTypeId: CustomFieldType.CheckBox;
1000
+ name: string;
1001
+ value: CustomFieldValueItem[];
1002
+ otherValue: string | null;
1003
+ }
1004
+ interface RadioCustomFieldValue {
1005
+ id: number;
1006
+ fieldTypeId: CustomFieldType.Radio;
1007
+ name: string;
1008
+ value: CustomFieldValueItem | null;
1009
+ otherValue: string | null;
1010
+ }
1011
+ type CustomFieldValue = TextCustomFieldValue | NumericCustomFieldValue | DateCustomFieldValue | SingleListCustomFieldValue | MultipleListCustomFieldValue | CheckBoxCustomFieldValue | RadioCustomFieldValue;
1012
+ }
1013
+ declare namespace Issue {
1014
+ interface IssueType {
1015
+ id: number;
1016
+ projectId: number;
1017
+ name: string;
1018
+ color: IssueTypeColor;
1019
+ displayOrder: number;
1020
+ templateSummary?: string;
1021
+ templateDescription?: string;
1022
+ }
1023
+ interface Priority {
1024
+ id: number;
1025
+ name: string;
1026
+ }
1027
+ interface Resolution {
1028
+ id: number;
1029
+ name: string;
1030
+ }
1031
+ interface Issue {
1032
+ id: number;
1033
+ projectId: number;
1034
+ issueKey: string;
1035
+ keyId: number;
1036
+ issueType: IssueType;
1037
+ summary: string;
1038
+ description: string;
1039
+ resolution?: Resolution;
1040
+ priority: Priority;
1041
+ status: Project.ProjectStatus;
1042
+ assignee?: User.User;
1043
+ category: Project.Category[];
1044
+ versions: Project.Version[];
1045
+ milestone: Project.Version[];
1046
+ startDate?: string;
1047
+ dueDate?: string;
1048
+ estimatedHours?: number;
1049
+ actualHours?: number;
1050
+ parentIssueId?: number;
1051
+ createdUser: User.User;
1052
+ created: string;
1053
+ updatedUser: User.User;
1054
+ updated: string;
1055
+ customFields: CustomFieldValue.CustomFieldValue[];
1056
+ attachments: File.IssueFileInfo[];
1057
+ sharedFiles: Project.SharedFile[];
1058
+ stars: Star.Star[];
1059
+ childIssueSummary?: ChildIssueSummary;
1060
+ }
1061
+ interface ChildIssueSummary {
1062
+ total: number;
1063
+ closed: number;
1064
+ }
1065
+ interface RecentlyViewedIssue {
1066
+ issue: Issue;
1067
+ updated: string;
1068
+ }
1069
+ interface IssueCount {
1070
+ count: number;
1071
+ }
1072
+ interface IssueCommentCount {
1073
+ count: number;
1074
+ }
1075
+ interface Comment {
1076
+ id: number;
1077
+ projectId: number;
1078
+ issueId: number;
1079
+ content: string;
1080
+ changeLog: ChangeLog.IssueChangeLog[];
1081
+ createdUser: User.User;
1082
+ created: string;
1083
+ updated: string;
1084
+ stars: Star.Star[];
1085
+ notifications: CommentNotification.CommentNotification[];
1086
+ }
1087
+ }
1088
+ declare namespace Star {
1089
+ interface Star {
1090
+ id: number;
1091
+ comment?: string;
1092
+ url: string;
1093
+ title: string;
1094
+ presenter: User.User;
1095
+ created: string;
1096
+ }
1097
+ interface StarCount {
1098
+ count: number;
1099
+ }
1100
+ }
1101
+ declare namespace Wiki {
1102
+ interface Tag {
1103
+ id: number;
1104
+ name: string;
1105
+ }
1106
+ interface History {
1107
+ pageId: number;
1108
+ version: number;
1109
+ name: string;
1110
+ content: string;
1111
+ createdUser: User.User;
1112
+ created: string;
1113
+ }
1114
+ interface WikiListItem {
1115
+ id: number;
1116
+ projectId: number;
1117
+ name: string;
1118
+ tags: Tag[];
1119
+ createdUser: User.User;
1120
+ created: string;
1121
+ updatedUser: User.User;
1122
+ updated: string;
1123
+ }
1124
+ interface Wiki {
1125
+ id: number;
1126
+ projectId: number;
1127
+ name: string;
1128
+ content: string;
1129
+ tags: Tag[];
1130
+ attachments: File.WikiFileInfo[];
1131
+ sharedFiles: Project.SharedFile[];
1132
+ stars: Star.Star[];
1133
+ createdUser: User.User;
1134
+ created: string;
1135
+ updatedUser: User.User;
1136
+ updated: string;
1137
+ }
1138
+ interface RecentlyViewedWiki {
1139
+ page: WikiListItem;
1140
+ updated: string;
1141
+ }
1142
+ interface WikiCount {
1143
+ count: number;
1144
+ }
1145
+ }
1146
+ declare namespace PullRequest {
1147
+ interface Status {
1148
+ id: number;
1149
+ name: string;
1150
+ }
1151
+ interface PullRequest {
1152
+ id: number;
1153
+ projectId: number;
1154
+ repositoryId: number;
1155
+ number: number;
1156
+ summary: string;
1157
+ description: string;
1158
+ base: string;
1159
+ branch: string;
1160
+ status: Status;
1161
+ assignee?: User.User;
1162
+ issue: Issue.Issue;
1163
+ baseCommit?: string;
1164
+ branchCommit?: string;
1165
+ mergeCommit?: string;
1166
+ closeAt?: string;
1167
+ mergeAt?: string;
1168
+ createdUser: User.User;
1169
+ created: string;
1170
+ updatedUser: User.User;
1171
+ updated: string;
1172
+ attachments: File.PullRequestFileInfo[];
1173
+ stars: Star.Star[];
1174
+ }
1175
+ interface Comment {
1176
+ id: number;
1177
+ content: string;
1178
+ changeLog: ChangeLog.PullRequestChangeLog[];
1179
+ createdUser: User.User;
1180
+ created: string;
1181
+ updated: string;
1182
+ stars: Star.Star[];
1183
+ notifications: CommentNotification.CommentNotification[];
1184
+ }
1185
+ interface PullRequestCount {
1186
+ count: number;
1187
+ }
1188
+ interface PullRequestCommentCount {
1189
+ count: number;
1190
+ }
1191
+ }
1192
+ declare namespace ChangeLog {
1193
+ interface ChangeLog {
1194
+ field: string;
1195
+ newValue: string;
1196
+ originalValue: string;
1197
+ }
1198
+ interface AttachmentInfo {
1199
+ id: number;
1200
+ type: string;
1201
+ }
1202
+ interface AttributeInfo {
1203
+ id: number;
1204
+ typeId: number;
1205
+ }
1206
+ interface NotificationInfo {
1207
+ type: string;
1208
+ }
1209
+ interface IssueChangeLog extends ChangeLog {
1210
+ attachmentInfo: AttachmentInfo;
1211
+ attributeInfo: AttributeInfo;
1212
+ notificationInfo: NotificationInfo;
1213
+ }
1214
+ type PullRequestChangeLog = ChangeLog;
1215
+ }
1216
+ declare namespace Git {
1217
+ interface GitRepository {
1218
+ id: number;
1219
+ projectId: number;
1220
+ name: string;
1221
+ description: string;
1222
+ hookUrl?: string;
1223
+ httpUrl: string;
1224
+ sshUrl: string;
1225
+ displayOrder: number;
1226
+ pushedAt?: string;
1227
+ createdUser: User.User;
1228
+ created: string;
1229
+ updatedUser: User.User;
1230
+ updated: string;
1231
+ }
1232
+ }
1233
+ declare namespace WatchingList {
1234
+ interface WatchingListItem {
1235
+ id: number;
1236
+ resourceAlreadyRead: boolean;
1237
+ note: string;
1238
+ type: string;
1239
+ issue: Issue.Issue;
1240
+ lastContentUpdated: string;
1241
+ created: string;
1242
+ updated: string;
1243
+ }
1244
+ interface WatchingListCount {
1245
+ count: number;
1246
+ }
1247
+ }
1248
+ declare namespace Team {
1249
+ interface Team {
1250
+ id: number;
1251
+ name: string;
1252
+ members: User.User[];
1253
+ displayOrder?: number;
1254
+ createdUser: User.User;
1255
+ created: string;
1256
+ updatedUser: User.User;
1257
+ updated: string;
1258
+ }
1259
+ }
1260
+ declare namespace Notification {
1261
+ interface Notification {
1262
+ id: number;
1263
+ alreadyRead: boolean;
1264
+ reason: number;
1265
+ resourceAlreadyRead: boolean;
1266
+ project: Project.Project;
1267
+ issue?: Issue.Issue;
1268
+ comment?: Issue.Comment;
1269
+ pullRequest?: PullRequest.PullRequest;
1270
+ pullRequestComment?: PullRequest.Comment;
1271
+ sender: User.User;
1272
+ created: string;
1273
+ }
1274
+ interface NotificationCount {
1275
+ count: number;
1276
+ }
1277
+ }
1278
+ declare namespace Webhook {
1279
+ interface Webhook {
1280
+ id: number;
1281
+ name: string;
1282
+ description: string;
1283
+ hookUrl: string;
1284
+ allEvent: boolean;
1285
+ activityTypeIds: WebhookActivityId[];
1286
+ createdUser: User.User;
1287
+ created: string;
1288
+ updatedUser: User.User;
1289
+ updated: string;
1290
+ }
1291
+ }
1292
+ declare namespace License {
1293
+ interface License {
1294
+ active: boolean;
1295
+ attachmentLimit: number;
1296
+ attachmentLimitPerFile: number;
1297
+ attachmentNumLimit: number;
1298
+ attribute: boolean;
1299
+ attributeLimit: number;
1300
+ burndown: boolean;
1301
+ commentLimit: number;
1302
+ componentLimit: number;
1303
+ fileSharing: boolean;
1304
+ gantt: boolean;
1305
+ git: boolean;
1306
+ grandchildIssueEnabled?: boolean;
1307
+ issueLimit: number;
1308
+ licenceTypeId: number;
1309
+ limitDate: string;
1310
+ nulabAccount: boolean;
1311
+ parentChildIssue: boolean;
1312
+ postIssueByMail: boolean;
1313
+ projectLimit: number;
1314
+ pullRequestAttachmentLimitPerFile: number;
1315
+ pullRequestAttachmentNumLimit: number;
1316
+ remoteAddress: boolean;
1317
+ remoteAddressLimit: number;
1318
+ startedOn: string;
1319
+ storageLimit: number;
1320
+ subversion: boolean;
1321
+ subversionExternal: boolean;
1322
+ userLimit: number;
1323
+ versionLimit: number;
1324
+ wikiAttachment: boolean;
1325
+ wikiAttachmentLimitPerFile: number;
1326
+ wikiAttachmentNumLimit: number;
1327
+ }
1328
+ }
1329
+ declare namespace RateLimit {
1330
+ interface RateLimit {
1331
+ rateLimit: ApiRateLimits;
1332
+ }
1333
+ interface ApiRateLimits {
1334
+ read: ApiRateLimit;
1335
+ update: ApiRateLimit;
1336
+ search: ApiRateLimit;
1337
+ icon: ApiRateLimit;
1338
+ }
1339
+ interface ApiRateLimit {
1340
+ limit: number;
1341
+ remaining: number;
1342
+ reset: number;
1343
+ }
1344
+ }
1345
+ //#endregion
1346
+ //#region src/request.d.ts
1347
+ declare class Request {
1348
+ private configure;
1349
+ private readonly fetch;
1350
+ constructor(configure: {
1351
+ host: string;
1352
+ apiKey?: string;
1353
+ accessToken?: string;
1354
+ timeout?: number;
1355
+ fetch?: Fetch;
1356
+ userAgent?: string;
1357
+ });
1358
+ get<T>(path: string, params?: any): Promise<T>;
1359
+ post<T>(path: string, params?: any): Promise<T>;
1360
+ put<T>(path: string, params: any): Promise<T>;
1361
+ patch<T>(path: string, params: any): Promise<T>;
1362
+ delete<T>(path: string, params?: any): Promise<T>;
1363
+ request(options: {
1364
+ method: string;
1365
+ path: string;
1366
+ params?: Params | FormData;
1367
+ }): Promise<Response>;
1368
+ checkStatus(response: Response): Promise<Response>;
1369
+ parseJSON<T>(response: Response): Promise<T>;
1370
+ private toQueryString;
1371
+ get webAppBaseURL(): string;
1372
+ get restBaseURL(): string;
1373
+ }
1374
+ type Params = {
1375
+ [index: string]: number | string | number[] | string[];
1376
+ };
1377
+ //#endregion
1378
+ //#region src/backlog.d.ts
1379
+ declare class Backlog extends Request {
1380
+ constructor(configure: {
1381
+ host: string;
1382
+ apiKey?: string;
1383
+ accessToken?: string;
1384
+ timeout?: number;
1385
+ fetch?: Fetch;
1386
+ userAgent?: string;
1387
+ });
1388
+ /**
1389
+ * https://developer.nulab.com/docs/backlog/api/2/get-space/
1390
+ */
1391
+ getSpace(): Promise<Space.Space>;
1392
+ /**
1393
+ * https://developer.nulab.com/docs/backlog/api/2/get-recent-updates/
1394
+ */
1395
+ getSpaceActivities(params: Space$1.GetActivitiesParams): Promise<Activity.Activity[]>;
1396
+ /**
1397
+ * https://developer.nulab.com/docs/backlog/api/2/get-space-logo/
1398
+ */
1399
+ getSpaceIcon(): Promise<File.FileData>;
1400
+ /**
1401
+ * https://developer.nulab.com/docs/backlog/api/2/get-space-notification/
1402
+ */
1403
+ getSpaceNotification(): Promise<Space.Notification>;
1404
+ /**
1405
+ * https://developer.nulab.com/docs/backlog/api/2/update-space-notification/
1406
+ */
1407
+ putSpaceNotification(params: Space$1.PutSpaceNotificationParams): Promise<Space.Notification>;
1408
+ /**
1409
+ * https://developer.nulab.com/docs/backlog/api/2/get-space-disk-usage/
1410
+ */
1411
+ getSpaceDiskUsage(): Promise<DiskUsage.SpaceDiskUsage>;
1412
+ /**
1413
+ * https://developer.nulab.com/docs/backlog/api/2/post-attachment-file/
1414
+ */
1415
+ postSpaceAttachment(form: FormData): Promise<File.FileInfo>;
1416
+ /**
1417
+ * https://developer.nulab.com/docs/backlog/api/2/get-user-list/
1418
+ */
1419
+ getUsers(): Promise<User.User[]>;
1420
+ /**
1421
+ * https://developer.nulab.com/docs/backlog/api/2/get-user/
1422
+ */
1423
+ getUser(userId: number): Promise<User.User>;
1424
+ /**
1425
+ * https://developer.nulab.com/docs/backlog/api/2/add-user/
1426
+ */
1427
+ postUser(params: User$1.PostUserParams): Promise<User.User>;
1428
+ /**
1429
+ * https://developer.nulab.com/docs/backlog/api/2/update-user/
1430
+ */
1431
+ patchUser(userId: number, params: User$1.PatchUserParams): Promise<User.User>;
1432
+ /**
1433
+ * https://developer.nulab.com/docs/backlog/api/2/delete-user/
1434
+ */
1435
+ deleteUser(userId: number): Promise<User.User>;
1436
+ /**
1437
+ * https://developer.nulab.com/docs/backlog/api/2/get-own-user/
1438
+ */
1439
+ getMyself(): Promise<User.User>;
1440
+ /**
1441
+ * https://developer.nulab.com/docs/backlog/api/2/get-user-icon/
1442
+ */
1443
+ getUserIcon(userId: number): Promise<File.FileData>;
1444
+ /**
1445
+ * https://developer.nulab.com/docs/backlog/api/2/get-user-recent-updates/
1446
+ */
1447
+ getUserActivities(userId: number, params: User$1.GetUserActivitiesParams): Promise<Activity.Activity[]>;
1448
+ /**
1449
+ * https://developer.nulab.com/docs/backlog/api/2/get-received-star-list/
1450
+ */
1451
+ getUserStars(userId: number, params: User$1.GetUserStarsParams): Promise<Star.Star[]>;
1452
+ /**
1453
+ * https://developer.nulab.com/docs/backlog/api/2/count-user-received-stars/
1454
+ */
1455
+ getUserStarsCount(userId: number, params: User$1.GetUserStarsCountParams): Promise<Star.StarCount>;
1456
+ /**
1457
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-issues/
1458
+ */
1459
+ getRecentlyViewedIssues(params: User$1.GetRecentlyViewedParams): Promise<Issue.RecentlyViewedIssue[]>;
1460
+ /**
1461
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-projects/
1462
+ */
1463
+ getRecentlyViewedProjects(params: User$1.GetRecentlyViewedParams): Promise<Project.RecentlyViewedProject[]>;
1464
+ /**
1465
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-wikis/
1466
+ */
1467
+ getRecentlyViewedWikis(params: User$1.GetRecentlyViewedParams): Promise<Wiki.RecentlyViewedWiki[]>;
1468
+ /**
1469
+ * https://developer.nulab.com/docs/backlog/api/2/get-status-list-of-project/
1470
+ */
1471
+ getProjectStatuses(projectIdOrKey: string | number): Promise<Project.ProjectStatus[]>;
1472
+ /**
1473
+ * https://developer.nulab.com/docs/backlog/api/2/get-resolution-list/
1474
+ */
1475
+ getResolutions(): Promise<Issue.Resolution[]>;
1476
+ /**
1477
+ * https://developer.nulab.com/docs/backlog/api/2/get-priority-list/
1478
+ */
1479
+ getPriorities(): Promise<Issue.Priority[]>;
1480
+ /**
1481
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-list/
1482
+ */
1483
+ getProjects(params?: Project$1.GetProjectsParams): Promise<Project.Project[]>;
1484
+ /**
1485
+ * https://developer.nulab.com/docs/backlog/api/2/add-project/
1486
+ */
1487
+ postProject(params: Project$1.PostProjectParams): Promise<Project.Project>;
1488
+ /**
1489
+ * https://developer.nulab.com/docs/backlog/api/2/get-project/
1490
+ */
1491
+ getProject(projectIdOrKey: string | number): Promise<Project.Project>;
1492
+ /**
1493
+ * https://developer.nulab.com/docs/backlog/api/2/update-project/
1494
+ */
1495
+ patchProject(projectIdOrKey: string | number, params: Project$1.PatchProjectParams): Promise<Project.Project>;
1496
+ /**
1497
+ * https://developer.nulab.com/docs/backlog/api/2/delete-project/
1498
+ */
1499
+ deleteProject(projectIdOrKey: string | number): Promise<Project.Project>;
1500
+ /**
1501
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-icon/
1502
+ */
1503
+ getProjectIcon(projectIdOrKey: string | number): Promise<File.FileData>;
1504
+ /**
1505
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-recent-updates/
1506
+ */
1507
+ getProjectActivities(projectIdOrKey: string | number, params: Space$1.GetActivitiesParams): Promise<Activity.Activity[]>;
1508
+ /**
1509
+ * https://developer.nulab.com/docs/backlog/api/2/add-project-user/
1510
+ */
1511
+ postProjectUser(projectIdOrKey: string | number, userId: string): Promise<User.User>;
1512
+ /**
1513
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-user-list/
1514
+ */
1515
+ getProjectUsers(projectIdOrKey: string | number): Promise<User.User[]>;
1516
+ /**
1517
+ * https://developer.nulab.com/docs/backlog/api/2/delete-project-user/
1518
+ */
1519
+ deleteProjectUsers(projectIdOrKey: string | number, params: Project$1.DeleteProjectUsersParams): Promise<User.User>;
1520
+ /**
1521
+ * https://developer.nulab.com/docs/backlog/api/2/add-project-administrator/
1522
+ */
1523
+ postProjectAdministrators(projectIdOrKey: string | number, params: Project$1.PostProjectAdministrators): Promise<User.User>;
1524
+ /**
1525
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-project-administrators/
1526
+ */
1527
+ getProjectAdministrators(projectIdOrKey: string | number): Promise<User.User[]>;
1528
+ /**
1529
+ * https://developer.nulab.com/docs/backlog/api/2/delete-project-administrator/
1530
+ */
1531
+ deleteProjectAdministrators(projectIdOrKey: string | number, params: Project$1.DeleteProjectAdministrators): Promise<User.User>;
1532
+ /**
1533
+ * https://developer.nulab.com/docs/backlog/api/2/add-status/
1534
+ */
1535
+ postProjectStatus(projectIdOrKey: string | number, params: Project$1.PostStatusParams): Promise<Project.ProjectStatus>;
1536
+ /**
1537
+ * https://developer.nulab.com/docs/backlog/api/2/update-status/
1538
+ */
1539
+ patchProjectStatus(projectIdOrKey: string | number, id: number, params: Project$1.PatchStatusParams): Promise<Project.ProjectStatus>;
1540
+ /**
1541
+ * https://developer.nulab.com/docs/backlog/api/2/delete-status/
1542
+ */
1543
+ deleteProjectStatus(projectIdOrKey: string | number, id: number, substituteStatusId: number): Promise<Project.ProjectStatus>;
1544
+ /**
1545
+ * https://developer.nulab.com/docs/backlog/api/2/update-order-of-status/
1546
+ */
1547
+ patchProjectStatusOrder(projectIdOrKey: string | number, statusId: number[]): Promise<Project.ProjectStatus[]>;
1548
+ /**
1549
+ * https://developer.nulab.com/docs/backlog/api/2/get-issue-type-list/
1550
+ */
1551
+ getIssueTypes(projectIdOrKey: string | number): Promise<Issue.IssueType[]>;
1552
+ /**
1553
+ * https://developer.nulab.com/docs/backlog/api/2/add-issue-type/
1554
+ */
1555
+ postIssueType(projectIdOrKey: string | number, params: Project$1.PostIssueTypeParams): Promise<Issue.IssueType>;
1556
+ /**
1557
+ * https://developer.nulab.com/docs/backlog/api/2/update-issue-type/
1558
+ */
1559
+ patchIssueType(projectIdOrKey: string | number, id: number, params: Project$1.PatchIssueTypeParams): Promise<Issue.IssueType>;
1560
+ /**
1561
+ * https://developer.nulab.com/docs/backlog/api/2/delete-issue-type/
1562
+ */
1563
+ deleteIssueType(projectIdOrKey: string | number, id: number, params: Project$1.DeleteIssueTypeParams): Promise<Issue.IssueType>;
1564
+ /**
1565
+ * https://developer.nulab.com/docs/backlog/api/2/get-category-list/
1566
+ */
1567
+ getCategories(projectIdOrKey: string | number): Promise<Project.Category[]>;
1568
+ /**
1569
+ * https://developer.nulab.com/docs/backlog/api/2/add-category/
1570
+ */
1571
+ postCategories(projectIdOrKey: string | number, params: Project$1.PostCategoriesParams): Promise<Project.Category>;
1572
+ /**
1573
+ * https://developer.nulab.com/docs/backlog/api/2/update-category/
1574
+ */
1575
+ patchCategories(projectIdOrKey: string | number, id: number, params: Project$1.PatchCategoriesParams): Promise<Project.Category>;
1576
+ /**
1577
+ * https://developer.nulab.com/docs/backlog/api/2/delete-category/
1578
+ */
1579
+ deleteCategories(projectIdOrKey: string | number, id: number): Promise<Project.Category>;
1580
+ /**
1581
+ * https://developer.nulab.com/docs/backlog/api/2/get-version-milestone-list/
1582
+ */
1583
+ getVersions(projectIdOrKey: string | number): Promise<Project.Version[]>;
1584
+ /**
1585
+ * https://developer.nulab.com/docs/backlog/api/2/add-version-milestone/
1586
+ */
1587
+ postVersions(projectIdOrKey: string | number, params: Project$1.PostVersionsParams): Promise<Project.Version>;
1588
+ /**
1589
+ * https://developer.nulab.com/docs/backlog/api/2/update-version-milestone/
1590
+ */
1591
+ patchVersions(projectIdOrKey: string | number, id: number, params: Project$1.PatchVersionsParams): Promise<Project.Version>;
1592
+ /**
1593
+ * https://developer.nulab.com/docs/backlog/api/2/delete-version/
1594
+ */
1595
+ deleteVersions(projectIdOrKey: string | number, id: number): Promise<Project.Version>;
1596
+ /**
1597
+ * https://developer.nulab.com/docs/backlog/api/2/get-custom-field-list/
1598
+ */
1599
+ getCustomFields(projectIdOrKey: string | number): Promise<Project.CustomField[]>;
1600
+ /**
1601
+ * https://developer.nulab.com/docs/backlog/api/2/add-custom-field/
1602
+ */
1603
+ postCustomField(projectIdOrKey: string | number, params: Project$1.PostCustomFieldParams | Project$1.PostCustomFieldWithNumericParams | Project$1.PostCustomFieldWithDateParams | Project$1.PostCustomFieldWithListParams): Promise<Project.CustomField>;
1604
+ /**
1605
+ * https://developer.nulab.com/docs/backlog/api/2/update-custom-field/
1606
+ */
1607
+ patchCustomField(projectIdOrKey: string | number, id: number, params: Project$1.PatchCustomFieldParams | Project$1.PatchCustomFieldWithNumericParams | Project$1.PatchCustomFieldWithDateParams | Project$1.PatchCustomFieldWithListParams): Promise<Project.CustomField>;
1608
+ /**
1609
+ * https://developer.nulab.com/docs/backlog/api/2/delete-custom-field/
1610
+ */
1611
+ deleteCustomField(projectIdOrKey: string | number, id: number): Promise<Project.CustomField>;
1612
+ /**
1613
+ * https://developer.nulab.com/docs/backlog/api/2/add-list-item-for-list-type-custom-field/
1614
+ */
1615
+ postCustomFieldItem(projectIdOrKey: string | number, id: number, params: Project$1.PostCustomFieldItemParams): Promise<Project.CustomField>;
1616
+ /**
1617
+ * https://developer.nulab.com/docs/backlog/api/2/update-list-item-for-list-type-custom-field/
1618
+ */
1619
+ patchCustomFieldItem(projectIdOrKey: string | number, id: number, itemId: number, params: Project$1.PatchCustomFieldItemParams): Promise<Project.CustomField>;
1620
+ /**
1621
+ * https://developer.nulab.com/docs/backlog/api/2/delete-list-item-for-list-type-custom-field/
1622
+ */
1623
+ deleteCustomFieldItem(projectIdOrKey: string | number, id: number, itemId: number): Promise<Project.CustomField>;
1624
+ /**
1625
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-shared-files/
1626
+ */
1627
+ getSharedFiles(projectIdOrKey: string | number, path: string, params: Project$1.GetSharedFilesParams): Promise<Project.SharedFile[]>;
1628
+ /**
1629
+ * https://developer.nulab.com/docs/backlog/api/2/get-file/
1630
+ */
1631
+ getSharedFile(projectIdOrKey: string | number, sharedFileId: number): Promise<File.FileData>;
1632
+ /**
1633
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-disk-usage/
1634
+ */
1635
+ getProjectsDiskUsage(projectIdOrKey: string | number): Promise<DiskUsage.ProjectDiskUsage>;
1636
+ /**
1637
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-webhooks/
1638
+ */
1639
+ getWebhooks(projectIdOrKey: string | number): Promise<Webhook.Webhook[]>;
1640
+ /**
1641
+ * https://developer.nulab.com/docs/backlog/api/2/add-webhook/
1642
+ */
1643
+ postWebhook(projectIdOrKey: string | number, params: Project$1.PostWebhookParams): Promise<Webhook.Webhook>;
1644
+ /**
1645
+ * https://developer.nulab.com/docs/backlog/api/2/get-webhook/
1646
+ */
1647
+ getWebhook(projectIdOrKey: string | number, webhookId: string): Promise<Webhook.Webhook>;
1648
+ /**
1649
+ * https://developer.nulab.com/docs/backlog/api/2/update-webhook/
1650
+ */
1651
+ patchWebhook(projectIdOrKey: string | number, webhookId: string, params: Project$1.PatchWebhookParams): Promise<Webhook.Webhook>;
1652
+ /**
1653
+ * https://developer.nulab.com/docs/backlog/api/2/delete-webhook/
1654
+ */
1655
+ deleteWebhook(projectIdOrKey: string | number, webhookId: string): Promise<Webhook.Webhook>;
1656
+ /**
1657
+ * https://developer.nulab.com/docs/backlog/api/2/get-issue-list/
1658
+ */
1659
+ getIssues(params?: Issue$1.GetIssuesParams): Promise<Issue.Issue[]>;
1660
+ /**
1661
+ * https://developer.nulab.com/docs/backlog/api/2/count-issue/
1662
+ */
1663
+ getIssuesCount(params?: Issue$1.GetIssuesParams): Promise<Issue.IssueCount>;
1664
+ /**
1665
+ * https://developer.nulab.com/docs/backlog/api/2/add-issue/
1666
+ */
1667
+ postIssue(params: Issue$1.PostIssueParams): Promise<Issue.Issue>;
1668
+ /**
1669
+ * https://developer.nulab.com/docs/backlog/api/2/update-issue/
1670
+ */
1671
+ patchIssue(issueIdOrKey: string | number, params: Issue$1.PatchIssueParams): Promise<Issue.Issue>;
1672
+ /**
1673
+ * https://developer.nulab.com/docs/backlog/api/2/get-issue/
1674
+ */
1675
+ getIssue(issueIdOrKey: string | number, params?: Issue$1.GetIssueParams): Promise<Issue.Issue>;
1676
+ /**
1677
+ * https://developer.nulab.com/docs/backlog/api/2/delete-issue/
1678
+ */
1679
+ deleteIssue(issueIdOrKey: string | number): Promise<Issue.Issue>;
1680
+ /**
1681
+ * https://developer.nulab.com/docs/backlog/api/2/get-comment-list/
1682
+ */
1683
+ getIssueComments(issueIdOrKey: string | number, params: Issue$1.GetIssueCommentsParams): Promise<Issue.Comment[]>;
1684
+ /**
1685
+ * https://developer.nulab.com/docs/backlog/api/2/add-comment/
1686
+ */
1687
+ postIssueComments(issueIdOrKey: string | number, params: Issue$1.PostIssueCommentsParams): Promise<Issue.Comment>;
1688
+ /**
1689
+ * https://developer.nulab.com/docs/backlog/api/2/count-comment/
1690
+ */
1691
+ getIssueCommentsCount(issueIdOrKey: string | number): Promise<Issue.IssueCommentCount>;
1692
+ /**
1693
+ * https://developer.nulab.com/docs/backlog/api/2/get-comment/
1694
+ */
1695
+ getIssueComment(issueIdOrKey: string | number, commentId: number): Promise<Issue.Comment>;
1696
+ /**
1697
+ * https://developer.nulab.com/docs/backlog/api/2/delete-comment/
1698
+ */
1699
+ deleteIssueComment(issueIdOrKey: string | number, commentId: number): Promise<Issue.Comment>;
1700
+ /**
1701
+ * https://developer.nulab.com/docs/backlog/api/2/update-comment/
1702
+ */
1703
+ patchIssueComment(issueIdOrKey: string | number, commentId: number, params: Issue$1.PatchIssueCommentParams): Promise<Issue.Comment>;
1704
+ /**
1705
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-comment-notifications/
1706
+ */
1707
+ getIssueCommentNotifications(issueIdOrKey: string | number, commentId: number): Promise<CommentNotification.CommentNotification[]>;
1708
+ /**
1709
+ * https://developer.nulab.com/docs/backlog/api/2/add-comment-notification/
1710
+ */
1711
+ postIssueCommentNotifications(issueIdOrKey: string | number, commentId: number, prams: Issue$1.IssueCommentNotifications): Promise<Issue.Comment>;
1712
+ /**
1713
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-issue-attachments/
1714
+ */
1715
+ getIssueAttachments(issueIdOrKey: string | number): Promise<File.IssueFileInfo[]>;
1716
+ /**
1717
+ * https://developer.nulab.com/docs/backlog/api/2/get-issue-attachment/
1718
+ */
1719
+ getIssueAttachment(issueIdOrKey: string | number, attachmentId: number): Promise<File.FileData>;
1720
+ /**
1721
+ * https://developer.nulab.com/docs/backlog/api/2/delete-issue-attachment/
1722
+ */
1723
+ deleteIssueAttachment(issueIdOrKey: string | number, attachmentId: string): Promise<File.IssueFileInfo>;
1724
+ /**
1725
+ * https://developer.nulab.com/docs/backlog/api/2/get-issue-participant-list/
1726
+ */
1727
+ getIssueParticipants(issueIdOrKey: string | number): Promise<User.User[]>;
1728
+ /**
1729
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-linked-shared-files/
1730
+ */
1731
+ getIssueSharedFiles(issueIdOrKey: string | number): Promise<Project.SharedFile[]>;
1732
+ /**
1733
+ * https://developer.nulab.com/docs/backlog/api/2/link-shared-files-to-issue/
1734
+ */
1735
+ linkIssueSharedFiles(issueIdOrKey: string | number, params: Issue$1.LinkIssueSharedFilesParams): Promise<Project.SharedFile[]>;
1736
+ /**
1737
+ * https://developer.nulab.com/docs/backlog/api/2/remove-link-to-shared-file-from-issue/
1738
+ */
1739
+ unlinkIssueSharedFile(issueIdOrKey: string | number, id: number): Promise<Project.SharedFile>;
1740
+ /**
1741
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-list/
1742
+ */
1743
+ getWikis(params: Wiki$1.GetWikiParams): Promise<Wiki.WikiListItem[]>;
1744
+ /**
1745
+ * https://developer.nulab.com/docs/backlog/api/2/count-wiki-page/
1746
+ */
1747
+ getWikisCount(projectIdOrKey: string | number): Promise<Wiki.WikiCount>;
1748
+ /**
1749
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-tag-list/
1750
+ */
1751
+ getWikisTags(projectIdOrKey: string | number): Promise<Wiki.Tag[]>;
1752
+ /**
1753
+ * https://developer.nulab.com/docs/backlog/api/2/add-wiki-page/
1754
+ */
1755
+ postWiki(params: Wiki$1.PostWikiParams): Promise<Wiki.Wiki>;
1756
+ /**
1757
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page/
1758
+ */
1759
+ getWiki(wikiId: number): Promise<Wiki.Wiki>;
1760
+ /**
1761
+ * https://developer.nulab.com/docs/backlog/api/2/update-wiki-page/
1762
+ */
1763
+ patchWiki(wikiId: number, params: Wiki$1.PatchWikiParams): Promise<Wiki.Wiki>;
1764
+ /**
1765
+ * https://developer.nulab.com/docs/backlog/api/2/delete-wiki-page/
1766
+ */
1767
+ deleteWiki(wikiId: number, mailNotify: boolean): Promise<Wiki.Wiki>;
1768
+ /**
1769
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-wiki-attachments/
1770
+ */
1771
+ getWikisAttachments(wikiId: number): Promise<File.WikiFileInfo[]>;
1772
+ /**
1773
+ * https://developer.nulab.com/docs/backlog/api/2/attach-file-to-wiki/
1774
+ */
1775
+ postWikisAttachments(wikiId: number, attachmentId: number[]): Promise<File.WikiFileInfo[]>;
1776
+ /**
1777
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-attachment/
1778
+ */
1779
+ getWikiAttachment(wikiId: number, attachmentId: number): Promise<File.FileData>;
1780
+ /**
1781
+ * https://developer.nulab.com/docs/backlog/api/2/remove-wiki-attachment/
1782
+ */
1783
+ deleteWikisAttachments(wikiId: number, attachmentId: number): Promise<File.WikiFileInfo>;
1784
+ /**
1785
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-shared-files-on-wiki/
1786
+ */
1787
+ getWikisSharedFiles(wikiId: number): Promise<Project.SharedFile[]>;
1788
+ /**
1789
+ * https://developer.nulab.com/docs/backlog/api/2/link-shared-files-to-wiki/
1790
+ */
1791
+ linkWikisSharedFiles(wikiId: number, fileId: number[]): Promise<Project.SharedFile[]>;
1792
+ /**
1793
+ * https://developer.nulab.com/docs/backlog/api/2/remove-link-to-shared-file-from-wiki/
1794
+ */
1795
+ unlinkWikisSharedFiles(wikiId: number, id: number): Promise<Project.SharedFile>;
1796
+ /**
1797
+ * https://developer.nulab.com/docs/backlog/api/get-document-list/
1798
+ */
1799
+ getDocuments(params: Document$1.GetDocumentsParams): Promise<Document.Document[]>;
1800
+ /**
1801
+ * https://developer.nulab.com/docs/backlog/api/get-document-tree/
1802
+ */
1803
+ getDocumentTree(projectIdOrKey: string | number): Promise<Document.DocumentTree>;
1804
+ /**
1805
+ * https://developer.nulab.com/docs/backlog/api/get-document/
1806
+ */
1807
+ getDocument(documentId: string): Promise<Document.Document>;
1808
+ /**
1809
+ * https://developer.nulab.com/docs/backlog/api/get-document-attachments/
1810
+ */
1811
+ downloadDocumentAttachment(documentId: string, attachmentId: number): Promise<File.FileData>;
1812
+ /**
1813
+ * https://developer.nulab.com/docs/backlog/api/2/add-document/
1814
+ */
1815
+ addDocument(params: Document$1.AddDocumentParams): Promise<Document.Document>;
1816
+ /**
1817
+ * https://developer.nulab.com/docs/backlog/api/2/delete-document/
1818
+ */
1819
+ deleteDocument(documentId: string): Promise<Document.Document>;
1820
+ /**
1821
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-history/
1822
+ */
1823
+ getWikisHistory(wikiId: number, params: Wiki$1.GetWikisHistoryParams): Promise<Wiki.History[]>;
1824
+ /**
1825
+ * https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-star/
1826
+ */
1827
+ getWikisStars(wikiId: number): Promise<Star.Star[]>;
1828
+ /**
1829
+ * https://developer.nulab.com/docs/backlog/api/2/add-star/
1830
+ */
1831
+ postStar(params: Project$1.PostStarParams): Promise<void>;
1832
+ /**
1833
+ * https://developer.nulab.com/docs/backlog/api/2/remove-star/
1834
+ */
1835
+ removeStar(starId: number): Promise<void>;
1836
+ /**
1837
+ * https://developer.nulab.com/docs/backlog/api/2/get-notification/
1838
+ */
1839
+ getNotifications(params: Notification$1.GetNotificationsParams): Promise<Notification.Notification[]>;
1840
+ /**
1841
+ * https://developer.nulab.com/docs/backlog/api/2/count-notification/
1842
+ */
1843
+ getNotificationsCount(params: Notification$1.GetNotificationsCountParams): Promise<Notification.NotificationCount>;
1844
+ /**
1845
+ * https://developer.nulab.com/docs/backlog/api/2/reset-unread-notification-count/
1846
+ */
1847
+ resetNotificationsMarkAsRead(): Promise<Notification.NotificationCount>;
1848
+ /**
1849
+ * https://developer.nulab.com/docs/backlog/api/2/read-notification/
1850
+ */
1851
+ markAsReadNotification(id: number): Promise<void>;
1852
+ /**
1853
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-git-repositories/
1854
+ */
1855
+ getGitRepositories(projectIdOrKey: string | number): Promise<Git.GitRepository[]>;
1856
+ /**
1857
+ * https://developer.nulab.com/docs/backlog/api/2/get-git-repository/
1858
+ */
1859
+ getGitRepository(projectIdOrKey: string | number, repoIdOrName: string): Promise<Git.GitRepository>;
1860
+ /**
1861
+ * https://developer.nulab.com/docs/backlog/api/2/get-pull-request-list/
1862
+ */
1863
+ getPullRequests(projectIdOrKey: string | number, repoIdOrName: string, params: PullRequest$1.GetPullRequestsParams): Promise<PullRequest.PullRequest[]>;
1864
+ /**
1865
+ * https://developer.nulab.com/docs/backlog/api/2/get-number-of-pull-requests/
1866
+ */
1867
+ getPullRequestsCount(projectIdOrKey: string | number, repoIdOrName: string, params: PullRequest$1.GetPullRequestsParams): Promise<PullRequest.PullRequestCount>;
1868
+ /**
1869
+ * https://developer.nulab.com/docs/backlog/api/2/add-pull-request/
1870
+ */
1871
+ postPullRequest(projectIdOrKey: string | number, repoIdOrName: string, params: PullRequest$1.PostPullRequestParams): Promise<PullRequest.PullRequest>;
1872
+ /**
1873
+ * https://developer.nulab.com/docs/backlog/api/2/get-pull-request/
1874
+ */
1875
+ getPullRequest(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<PullRequest.PullRequest>;
1876
+ /**
1877
+ * https://developer.nulab.com/docs/backlog/api/2/update-pull-request/
1878
+ */
1879
+ patchPullRequest(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: PullRequest$1.PatchPullRequestParams): Promise<PullRequest.PullRequest>;
1880
+ /**
1881
+ * https://developer.nulab.com/docs/backlog/api/2/get-pull-request-comment/
1882
+ */
1883
+ getPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: PullRequest$1.GetPullRequestCommentsParams): Promise<PullRequest.Comment[]>;
1884
+ /**
1885
+ * https://developer.nulab.com/docs/backlog/api/2/add-pull-request-comment/
1886
+ */
1887
+ postPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: PullRequest$1.PostPullRequestCommentsParams): Promise<PullRequest.Comment>;
1888
+ /**
1889
+ * https://developer.nulab.com/docs/backlog/api/2/get-number-of-pull-request-comments/
1890
+ */
1891
+ getPullRequestCommentsCount(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<PullRequest.PullRequestCommentCount>;
1892
+ /**
1893
+ * https://developer.nulab.com/docs/backlog/api/2/update-pull-request-comment-information/
1894
+ */
1895
+ patchPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, commentId: number, params: PullRequest$1.PatchPullRequestCommentsParams): Promise<PullRequest.Comment>;
1896
+ /**
1897
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-pull-request-attachment/
1898
+ */
1899
+ getPullRequestAttachments(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<File.PullRequestFileInfo[]>;
1900
+ /**
1901
+ * https://developer.nulab.com/docs/backlog/api/2/download-pull-request-attachment/
1902
+ */
1903
+ getPullRequestAttachment(projectIdOrKey: string | number, repoIdOrName: string, number: number, attachmentId: number): Promise<File.FileData>;
1904
+ /**
1905
+ * https://developer.nulab.com/docs/backlog/api/2/delete-pull-request-attachments/
1906
+ */
1907
+ deletePullRequestAttachment(projectIdOrKey: string | number, repoIdOrName: string, number: number, attachmentId: number): Promise<File.PullRequestFileInfo>;
1908
+ /**
1909
+ * https://developer.nulab.com/docs/backlog/api/2/get-watching-list
1910
+ */
1911
+ getWatchingListItems(userId: number, params?: WatchingList$1.GetWatchingListParams): Promise<WatchingList.WatchingListItem[]>;
1912
+ /**
1913
+ * https://developer.nulab.com/docs/backlog/api/2/count-watching
1914
+ */
1915
+ getWatchingListCount(userId: number, params?: WatchingList$1.GetWatchingListCountParams): Promise<WatchingList.WatchingListCount>;
1916
+ /**
1917
+ * https://developer.nulab.com/docs/backlog/api/2/get-watching
1918
+ */
1919
+ getWatchingListItem(watchId: number): Promise<WatchingList.WatchingListItem>;
1920
+ /**
1921
+ * https://developer.nulab.com/docs/backlog/api/2/add-watching
1922
+ */
1923
+ postWatchingListItem(params: WatchingList$1.PostWatchingListItemParams): Promise<WatchingList.WatchingListItem>;
1924
+ /**
1925
+ * https://developer.nulab.com/docs/backlog/api/2/update-watching
1926
+ */
1927
+ patchWatchingListItem(watchId: number, note: string): Promise<WatchingList.WatchingListItem>;
1928
+ /**
1929
+ * https://developer.nulab.com/docs/backlog/api/2/delete-watching
1930
+ */
1931
+ deletehWatchingListItem(watchId: number): Promise<WatchingList.WatchingListItem>;
1932
+ /**
1933
+ * https://developer.nulab.com/docs/backlog/api/2/mark-watching-as-read
1934
+ */
1935
+ resetWatchingListItemAsRead(watchId: number): Promise<void>;
1936
+ /**
1937
+ * https://developer.nulab.com/docs/backlog/api/2/get-licence
1938
+ */
1939
+ getLicence(): Promise<License.License>;
1940
+ /**
1941
+ * https://developer.nulab.com/docs/backlog/api/2/get-list-of-teams/
1942
+ */
1943
+ getTeams(params?: Team$1.GetTeamsParams): Promise<Team.Team[]>;
1944
+ /**
1945
+ * https://developer.nulab.com/docs/backlog/api/2/add-team/
1946
+ */
1947
+ postTeam(params: Team$1.PostTeamParams): Promise<Team.Team>;
1948
+ /**
1949
+ * https://developer.nulab.com/docs/backlog/api/2/get-team/
1950
+ */
1951
+ getTeam(teamId: number): Promise<Team.Team>;
1952
+ /**
1953
+ * https://developer.nulab.com/docs/backlog/api/2/update-team/
1954
+ */
1955
+ patchTeam(teamId: number, params: Team$1.PatchTeamParams): Promise<Team.Team>;
1956
+ /**
1957
+ * https://developer.nulab.com/docs/backlog/api/2/delete-team/
1958
+ */
1959
+ deleteTeam(teamId: number): Promise<Team.Team>;
1960
+ /**
1961
+ * https://developer.nulab.com/docs/backlog/api/2/get-team-icon/
1962
+ */
1963
+ getTeamIcon(teamId: number): Promise<File.FileData>;
1964
+ /**
1965
+ * https://developer.nulab.com/docs/backlog/api/2/get-project-team-list/
1966
+ */
1967
+ getProjectTeams(projectIdOrKey: string | number): Promise<Team.Team[]>;
1968
+ /**
1969
+ * https://developer.nulab.com/docs/backlog/api/2/add-project-team/
1970
+ */
1971
+ postProjectTeam(projectIdOrKey: string | number, teamId: number): Promise<Team.Team>;
1972
+ /**
1973
+ * https://developer.nulab.com/docs/backlog/api/2/delete-project-team/
1974
+ */
1975
+ deleteProjectTeam(projectIdOrKey: string | number, teamId: number): Promise<Team.Team>;
1976
+ /**
1977
+ * https://developer.nulab.com/docs/backlog/api/2/get-rate-limit/
1978
+ */
1979
+ getRateLimit(): Promise<RateLimit.RateLimit>;
1980
+ private download;
1981
+ private upload;
1982
+ private parseFileData;
1983
+ }
1984
+ //#endregion
1985
+ //#region src/oauth2.d.ts
1986
+ declare class OAuth2 {
1987
+ private credentials;
1988
+ private timeout?;
1989
+ private fetch?;
1990
+ constructor(credentials: OAuth2$2.Credentials, timeout?: number, fetch?: Fetch);
1991
+ getAuthorizationURL(options: {
1992
+ host: string;
1993
+ redirectUri?: string;
1994
+ state?: string;
1995
+ }): string;
1996
+ getAccessToken(options: {
1997
+ host: string;
1998
+ code: string;
1999
+ redirectUri?: string;
2000
+ }): Promise<OAuth2$1.AccessToken>;
2001
+ refreshAccessToken(options: {
2002
+ host: string;
2003
+ refreshToken: string;
2004
+ }): Promise<OAuth2$1.AccessToken>;
2005
+ }
2006
+ declare namespace error_d_exports {
2007
+ export { BacklogApiError, BacklogAuthError, BacklogError, BacklogErrorMessage, BacklogErrorNameType, UnexpectedError };
2008
+ }
2009
+ declare class BacklogError extends Error {
2010
+ private _name;
2011
+ private _url;
2012
+ private _status;
2013
+ private _body?;
2014
+ private _response;
2015
+ constructor(name: BacklogErrorNameType, response: Response, body?: {
2016
+ errors: BacklogErrorMessage[];
2017
+ });
2018
+ get name(): BacklogErrorNameType;
2019
+ get url(): string;
2020
+ get status(): number;
2021
+ get body(): {
2022
+ errors: BacklogErrorMessage[];
2023
+ } | undefined;
2024
+ get response(): Response;
2025
+ }
2026
+ declare class BacklogApiError extends BacklogError {
2027
+ constructor(response: Response, body?: {
2028
+ errors: BacklogErrorMessage[];
2029
+ });
2030
+ }
2031
+ declare class BacklogAuthError extends BacklogError {
2032
+ constructor(response: Response, body?: {
2033
+ errors: BacklogErrorMessage[];
2034
+ });
2035
+ }
2036
+ declare class UnexpectedError extends BacklogError {
2037
+ constructor(response: Response);
2038
+ }
2039
+ interface BacklogErrorMessage {
2040
+ message: string;
2041
+ code: number;
2042
+ errorInfo: string;
2043
+ moreInfo: string;
2044
+ }
2045
+ type BacklogErrorNameType = "BacklogApiError" | "BacklogAuthError" | "UnexpectedError";
2046
+ //#endregion
2047
+ export { Backlog, entity_d_exports as Entity, error_d_exports as Error, OAuth2, option_d_exports as Option, types_d_exports as Types };