forked from MrRefactoring/jira.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathissues.ts
1119 lines (1078 loc) · 51.8 KB
/
issues.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import * as Models from './models';
import * as Parameters from './parameters';
import { Callback } from '../callback';
import { Client } from '../clients';
import { RequestConfig } from '../requestConfig';
export class Issues {
constructor(private client: Client) {}
/**
* Returns all issue events.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getEvents<T = Models.IssueEvent[]>(callback: Callback<T>): Promise<void>;
/**
* Returns all issue events.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getEvents<T = Models.IssueEvent[]>(callback?: never): Promise<T>;
async getEvents<T = Models.IssueEvent[]>(callback?: Callback<T>): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/events',
method: 'GET',
};
return this.client.sendRequest(config, callback);
}
/**
* Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be
* applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties
* set.
*
* The content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue
* or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are
* the same fields that appear on the issue's create screen. Note that the `description`, `environment`, and any
* `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
* fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
*
* Creating a subtask differs from creating an issue as follows:
*
* - `issueType` must be set to a subtask issue type (use [ Get create issue
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* - `parent` must contain the ID or key of the parent issue.
*
* In a next-gen project any issue may be made a child providing that the parent and child are members of the same
* project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
* projects_ and _Create issues_ [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in
* which the issue or subtask is created.
*/
async createIssue<T = Models.CreatedIssue>(parameters: Parameters.CreateIssue, callback: Callback<T>): Promise<void>;
/**
* Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be
* applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties
* set.
*
* The content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue
* or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are
* the same fields that appear on the issue's create screen. Note that the `description`, `environment`, and any
* `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
* fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
*
* Creating a subtask differs from creating an issue as follows:
*
* - `issueType` must be set to a subtask issue type (use [ Get create issue
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* - `parent` must contain the ID or key of the parent issue.
*
* In a next-gen project any issue may be made a child providing that the parent and child are members of the same
* project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
* projects_ and _Create issues_ [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in
* which the issue or subtask is created.
*/
async createIssue<T = Models.CreatedIssue>(parameters: Parameters.CreateIssue, callback?: never): Promise<T>;
async createIssue<T = Models.CreatedIssue>(
parameters: Parameters.CreateIssue,
callback?: Callback<T>,
): Promise<void | T> {
if (parameters.fields?.description && typeof parameters.fields.description === 'string') {
parameters.fields.description = {
type: 'doc',
version: 1,
content: [
{
type: 'paragraph',
content: [
{
text: parameters.fields.description,
type: 'text',
},
],
},
],
};
}
const config: RequestConfig = {
url: '/rest/api/3/issue',
method: 'POST',
params: {
updateHistory: parameters.updateHistory,
},
data: {
fields: parameters.fields,
historyMetadata: parameters.historyMetadata,
properties: parameters.properties,
transition: parameters.transition,
update: parameters.update,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status
* of the submitted request.
*
* You can use the [get
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
* and [cancel
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post)
* APIs to manage the request.
*
* **Note that:**
*
* - You can't archive subtasks directly, only through their parent issues
* - You can only archive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*
* **Rate limiting:** Only a single request per user can be active at any given time.
*/
async archiveIssuesAsync<T = unknown>(
parameters: Parameters.ArchiveIssuesAsync,
callback: Callback<T>,
): Promise<void>;
/**
* Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status
* of the submitted request.
*
* You can use the [get
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
* and [cancel
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post)
* APIs to manage the request.
*
* **Note that:**
*
* - You can't archive subtasks directly, only through their parent issues
* - You can only archive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*
* **Rate limiting:** Only a single request per user can be active at any given time.
*/
async archiveIssuesAsync<T = unknown>(parameters: Parameters.ArchiveIssuesAsync, callback?: never): Promise<T>;
async archiveIssuesAsync<T = unknown>(
parameters: Parameters.ArchiveIssuesAsync,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/issue/archive',
method: 'POST',
data: {
jql: parameters.jql,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the
* issue(s) archived in the process and the errors encountered, if any.
*
* **Note that:**
*
* - You can't archive subtasks directly, only through their parent issues
* - You can only archive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*/
async archiveIssues<T = Models.IssueArchivalSync>(
parameters: Parameters.ArchiveIssues,
callback: Callback<T>,
): Promise<void>;
/**
* Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the
* issue(s) archived in the process and the errors encountered, if any.
*
* **Note that:**
*
* - You can't archive subtasks directly, only through their parent issues
* - You can only archive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*/
async archiveIssues<T = Models.IssueArchivalSync>(parameters: Parameters.ArchiveIssues, callback?: never): Promise<T>;
async archiveIssues<T = Models.IssueArchivalSync>(
parameters: Parameters.ArchiveIssues,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/issue/archive',
method: 'PUT',
data: {
issueIdsOrKeys: parameters.issueIdsOrKeys,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Creates upto **50** issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may
* be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue
* properties set.
*
* The content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the
* issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These
* are the same fields that appear on the issues' create screens. Note that the `description`, `environment`, and any
* `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
* fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
*
* Creating a subtask differs from creating an issue as follows:
*
* - `issueType` must be set to a subtask issue type (use [ Get create issue
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* - `parent` the must contain the ID or key of the parent issue.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
* projects_ and _Create issues_ [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in
* which each issue or subtask is created.
*/
async createIssues<T = Models.CreatedIssues>(
parameters: Parameters.CreateIssues | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Creates upto **50** issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may
* be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue
* properties set.
*
* The content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the
* issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These
* are the same fields that appear on the issues' create screens. Note that the `description`, `environment`, and any
* `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom
* fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
*
* Creating a subtask differs from creating an issue as follows:
*
* - `issueType` must be set to a subtask issue type (use [ Get create issue
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* - `parent` the must contain the ID or key of the parent issue.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse
* projects_ and _Create issues_ [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in
* which each issue or subtask is created.
*/
async createIssues<T = Models.CreatedIssues>(parameters?: Parameters.CreateIssues, callback?: never): Promise<T>;
async createIssues<T = Models.CreatedIssues>(
parameters?: Parameters.CreateIssues,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/issue/bulk',
method: 'POST',
data: {
issueUpdates: parameters?.issueUpdates,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns details of projects, issue types within projects, and, when requested, the create screen fields for each
* issue type for the user. Use the information to populate the requests in [ Create
* issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
*
* The request can be restricted to specific projects or issue types using the query parameters. The response will
* contain information for the valid projects, issue types, or project and issue type combinations requested. Note
* that invalid project, issue type, or project and issue type combinations do not generate errors.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Create
* issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
*/
async getCreateIssueMeta<T = Models.IssueCreateMetadata>(
parameters: Parameters.GetCreateIssueMeta | undefined,
callback: Callback<T>,
): Promise<void>;
/**
* Returns details of projects, issue types within projects, and, when requested, the create screen fields for each
* issue type for the user. Use the information to populate the requests in [ Create
* issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
*
* The request can be restricted to specific projects or issue types using the query parameters. The response will
* contain information for the valid projects, issue types, or project and issue type combinations requested. Note
* that invalid project, issue type, or project and issue type combinations do not generate errors.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Create
* issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
*/
async getCreateIssueMeta<T = Models.IssueCreateMetadata>(
parameters?: Parameters.GetCreateIssueMeta,
callback?: never,
): Promise<T>;
async getCreateIssueMeta<T = Models.IssueCreateMetadata>(
parameters?: Parameters.GetCreateIssueMeta,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/issue/createmeta',
method: 'GET',
params: {
projectIds: parameters?.projectIds,
projectKeys: parameters?.projectKeys,
issuetypeIds: parameters?.issuetypeIds,
issuetypeNames: parameters?.issuetypeNames,
expand: parameters?.expand,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the
* issue(s) unarchived in the process and the errors encountered, if any.
*
* **Note that:**
*
* - You can't unarchive subtasks directly, only through their parent issues
* - You can only unarchive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*/
async unarchiveIssues<T = Models.IssueArchivalSync>(
parameters: Parameters.UnarchiveIssues,
callback: Callback<T>,
): Promise<void>;
/**
* Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the
* issue(s) unarchived in the process and the errors encountered, if any.
*
* **Note that:**
*
* - You can't unarchive subtasks directly, only through their parent issues
* - You can only unarchive issues from software, service management, and business projects
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Jira
* admin or site admin: [global permission](https://confluence.atlassian.com/x/x4dKLg)
*
* **License required:** Premium or Enterprise
*
* **Signed-in users only:** This API can't be accessed anonymously.
*/
async unarchiveIssues<T = Models.IssueArchivalSync>(
parameters: Parameters.UnarchiveIssues,
callback?: never,
): Promise<T>;
async unarchiveIssues<T = Models.IssueArchivalSync>(
parameters: Parameters.UnarchiveIssues,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: '/rest/api/3/issue/unarchive',
method: 'PUT',
data: {
issueIdsOrKeys: parameters.issueIdsOrKeys,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns the details for an issue.
*
* The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive
* search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or
* other redirect is **not** returned. The issue key returned in the response is the key of the issue found.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback: Callback<T>): Promise<void>;
/**
* Returns the details for an issue.
*
* The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive
* search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or
* other redirect is **not** returned. The issue key returned in the response is the key of the issue found.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback?: never): Promise<T>;
async getIssue<T = Models.Issue>(parameters: Parameters.GetIssue, callback?: Callback<T>): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}`,
method: 'GET',
params: {
fields: parameters.fields,
fieldsByKeys: parameters.fieldsByKeys,
expand: parameters.expand,
properties: parameters.properties,
updateHistory: parameters.updateHistory,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Edits an issue. A transition may be applied and issue properties updated as part of the edit.
*
* The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are
* determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
*
* The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting
* `update.parent.set.none` to _true_. Note that the `description`, `environment`, and any `textarea` type custom
* fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`)
* accept a string and don't handle Atlassian Document Format content.
*
* Connect apps having an app user with _Administer Jira_ [global
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with _Administer
* Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security
* configuration using `overrideScreenSecurity` and `overrideEditableFlag`.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ and _Edit issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
* that the issue is in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async editIssue<T = void>(parameters: Parameters.EditIssue, callback: Callback<T>): Promise<void>;
/**
* Edits an issue. A transition may be applied and issue properties updated as part of the edit.
*
* The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are
* determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
*
* The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting
* `update.parent.set.none` to _true_. Note that the `description`, `environment`, and any `textarea` type custom
* fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`)
* accept a string and don't handle Atlassian Document Format content.
*
* Connect apps having an app user with _Administer Jira_ [global
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with _Administer
* Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen security
* configuration using `overrideScreenSecurity` and `overrideEditableFlag`.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ and _Edit issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
* that the issue is in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async editIssue<T = void>(parameters: Parameters.EditIssue, callback?: never): Promise<T>;
async editIssue<T = void>(parameters: Parameters.EditIssue, callback?: Callback<T>): Promise<void | T> {
if (parameters.fields?.description && typeof parameters.fields.description === 'string') {
const {
fields: { description },
} = await this.getIssue({ issueIdOrKey: parameters.issueIdOrKey });
parameters.fields.description = {
type: 'doc',
version: description?.version ?? 1,
content: [
{
type: 'paragraph',
content: [
{
text: parameters.fields.description,
type: 'text',
},
],
},
],
};
}
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}`,
method: 'PUT',
params: {
notifyUsers: parameters.notifyUsers,
overrideScreenSecurity: parameters.overrideScreenSecurity,
overrideEditableFlag: parameters.overrideEditableFlag,
returnIssue: parameters.returnIssue,
expand: parameters.expand,
},
data: {
fields: parameters.fields,
historyMetadata: parameters.historyMetadata,
properties: parameters.properties,
transition: parameters.transition,
update: parameters.update,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Deletes an issue.
*
* An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`.
* This causes the issue's subtasks to be deleted with the issue.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ and _Delete issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the
* project containing the issue.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async deleteIssue<T = void>(parameters: Parameters.DeleteIssue, callback: Callback<T>): Promise<void>;
/**
* Deletes an issue.
*
* An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`.
* This causes the issue's subtasks to be deleted with the issue.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ and _Delete issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the
* project containing the issue.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async deleteIssue<T = void>(parameters: Parameters.DeleteIssue, callback?: never): Promise<T>;
async deleteIssue<T = void>(parameters: Parameters.DeleteIssue, callback?: Callback<T>): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}`,
method: 'DELETE',
params: {
deleteSubtasks: parameters.deleteSubtasks,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Assigns an issue to a user. Use this operation when the calling user does not have the _Edit Issues_ permission but
* has the _Assign issue_ permission for the project that the issue is in.
*
* If `name` or `accountId` is set to:
*
* - `"-1"`, the issue is assigned to the default assignee for the project.
* - `null`, the issue is set to unassigned.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse Projects_ and _Assign Issues_ [ project permission](https://confluence.atlassian.com/x/yodKLg) for the
* project that the issue is in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async assignIssue<T = void>(parameters: Parameters.AssignIssue, callback: Callback<T>): Promise<void>;
/**
* Assigns an issue to a user. Use this operation when the calling user does not have the _Edit Issues_ permission but
* has the _Assign issue_ permission for the project that the issue is in.
*
* If `name` or `accountId` is set to:
*
* - `"-1"`, the issue is assigned to the default assignee for the project.
* - `null`, the issue is set to unassigned.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse Projects_ and _Assign Issues_ [ project permission](https://confluence.atlassian.com/x/yodKLg) for the
* project that the issue is in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async assignIssue<T = void>(parameters: Parameters.AssignIssue, callback?: never): Promise<T>;
async assignIssue<T = void>(parameters: Parameters.AssignIssue, callback?: Callback<T>): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/assignee`,
method: 'PUT',
data: {
accountId: parameters.accountId,
accountType: parameters.accountType,
active: parameters.active,
applicationRoles: parameters.applicationRoles,
avatarUrls: parameters.avatarUrls,
displayName: parameters.displayName,
emailAddress: parameters.emailAddress,
expand: parameters.expand,
groups: parameters.groups,
key: parameters.key,
locale: parameters.locale,
name: parameters.name,
self: parameters.self,
timeZone: parameters.timeZone,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of all
* changelogs for an issue sorted by date, starting from the oldest.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getChangeLogs<T = Models.PageChangelog>(
parameters: Parameters.GetChangeLogs,
callback: Callback<T>,
): Promise<void>;
/**
* Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of all
* changelogs for an issue sorted by date, starting from the oldest.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getChangeLogs<T = Models.PageChangelog>(parameters: Parameters.GetChangeLogs, callback?: never): Promise<T>;
async getChangeLogs<T = Models.PageChangelog>(
parameters: Parameters.GetChangeLogs,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/changelog`,
method: 'GET',
params: {
startAt: parameters.startAt,
maxResults: parameters.maxResults,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns changelogs for an issue specified by a list of changelog IDs.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getChangeLogsByIds<T = Models.PageOfChangelogs>(
parameters: Parameters.GetChangeLogsByIds,
callback: Callback<T>,
): Promise<void>;
/**
* Returns changelogs for an issue specified by a list of changelog IDs.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async getChangeLogsByIds<T = Models.PageOfChangelogs>(
parameters: Parameters.GetChangeLogsByIds,
callback?: never,
): Promise<T>;
async getChangeLogsByIds<T = Models.PageOfChangelogs>(
parameters: Parameters.GetChangeLogsByIds,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/changelog/list`,
method: 'POST',
data: {
changelogIds: parameters.changelogIds,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to
* populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put).
*
* This endpoint will check for these conditions:
*
* 1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type
* scheme configuration. `overrideScreenSecurity=true` skips this condition.
* 2. Field is visible in the [field
* configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/).
* `overrideScreenSecurity=true` skips this condition.
* 3. Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if
* attachments are enabled. Assignee only shows if user has permissions to assign the issue.
* 4. If a field is custom then it must have valid custom field context, applicable for its project and issue type. All
* system fields are assumed to have context in all projects and all issue types.
* 5. Issue has a project, issue type, and status defined.
* 6. Issue is assigned to a valid workflow, and the current status has assigned a workflow step.
* `overrideEditableFlag=true` skips this condition.
* 7. The current workflow step is editable. This is true by default, but [can be disabled by
* setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) the
* `jira.issue.editable` property to `false`. `overrideEditableFlag=true` skips this condition.
* 8. User has [Edit issues
* permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).
* 9. Workflow permissions allow editing a field. This is true by default but [can be
* modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) using
* `jira.permission.*` workflow properties.
*
* Fields hidden using [Issue layout settings
* page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain
* editable.
*
* Connect apps having an app user with _Administer Jira_ [global
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with _Administer
* Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg), can return additional details using:
*
* - `overrideScreenSecurity` When this flag is `true`, then this endpoint skips checking if fields are available
* through screens, and field configuration (conditions 1. and 2. from the list above).
* - `overrideEditableFlag` When this flag is `true`, then this endpoint skips checking if workflow is present and if
* the current step is editable (conditions 6. and 7. from the list above).
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*
* Note: For any fields to be editable the user must have the _Edit issues_ [project
* permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
*/
async getEditIssueMeta<T = Models.IssueUpdateMetadata>(
parameters: Parameters.GetEditIssueMeta,
callback: Callback<T>,
): Promise<void>;
/**
* Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to
* populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put).
*
* This endpoint will check for these conditions:
*
* 1. Field is available on a field screen - through screen, screen scheme, issue type screen scheme, and issue type
* scheme configuration. `overrideScreenSecurity=true` skips this condition.
* 2. Field is visible in the [field
* configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/).
* `overrideScreenSecurity=true` skips this condition.
* 3. Field is shown on the issue: each field has different conditions here. For example: Attachment field only shows if
* attachments are enabled. Assignee only shows if user has permissions to assign the issue.
* 4. If a field is custom then it must have valid custom field context, applicable for its project and issue type. All
* system fields are assumed to have context in all projects and all issue types.
* 5. Issue has a project, issue type, and status defined.
* 6. Issue is assigned to a valid workflow, and the current status has assigned a workflow step.
* `overrideEditableFlag=true` skips this condition.
* 7. The current workflow step is editable. This is true by default, but [can be disabled by
* setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) the
* `jira.issue.editable` property to `false`. `overrideEditableFlag=true` skips this condition.
* 8. User has [Edit issues
* permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).
* 9. Workflow permissions allow editing a field. This is true by default but [can be
* modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/) using
* `jira.permission.*` workflow properties.
*
* Fields hidden using [Issue layout settings
* page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/) remain
* editable.
*
* Connect apps having an app user with _Administer Jira_ [global
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting on behalf of users with _Administer
* Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg), can return additional details using:
*
* - `overrideScreenSecurity` When this flag is `true`, then this endpoint skips checking if fields are available
* through screens, and field configuration (conditions 1. and 2. from the list above).
* - `overrideEditableFlag` When this flag is `true`, then this endpoint skips checking if workflow is present and if
* the current step is editable (conditions 6. and 7. from the list above).
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*
* Note: For any fields to be editable the user must have the _Edit issues_ [project
* permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
*/
async getEditIssueMeta<T = Models.IssueUpdateMetadata>(
parameters: Parameters.GetEditIssueMeta,
callback?: never,
): Promise<T>;
async getEditIssueMeta<T = Models.IssueUpdateMetadata>(
parameters: Parameters.GetEditIssueMeta,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/editmeta`,
method: 'GET',
params: {
overrideScreenSecurity: parameters.overrideScreenSecurity,
overrideEditableFlag: parameters.overrideEditableFlag,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Creates an email notification for an issue and adds it to the mail queue.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async notify<T = void>(parameters: Parameters.Notify, callback: Callback<T>): Promise<void>;
/**
* Creates an email notification for an issue and adds it to the mail queue.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
*
* - _Browse Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*/
async notify<T = void>(parameters: Parameters.Notify, callback?: never): Promise<T>;
async notify<T = void>(parameters: Parameters.Notify, callback?: Callback<T>): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/notify`,
method: 'POST',
data: {
htmlBody: parameters.htmlBody,
restrict: parameters.restrict,
subject: parameters.subject,
textBody: parameters.textBody,
to: parameters.to,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's
* status.
*
* Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its
* status, the response will return any empty transitions list.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: A list or
* transition is returned only when the user has:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*
* However, if the user does not have the _Transition issues_ [ project
* permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.
*/
async getTransitions<T = Models.Transitions>(
parameters: Parameters.GetTransitions,
callback: Callback<T>,
): Promise<void>;
/**
* Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's
* status.
*
* Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its
* status, the response will return any empty transitions list.
*
* This operation can be accessed anonymously.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required: A list or
* transition is returned only when the user has:**
*
* - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is
* in.
* - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission
* to view the issue.
*
* However, if the user does not have the _Transition issues_ [ project
* permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.
*/
async getTransitions<T = Models.Transitions>(parameters: Parameters.GetTransitions, callback?: never): Promise<T>;
async getTransitions<T = Models.Transitions>(
parameters: Parameters.GetTransitions,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/3/issue/${parameters.issueIdOrKey}/transitions`,
method: 'GET',
params: {
expand: parameters.expand,
transitionId: parameters.transitionId,
skipRemoteOnlyCondition: parameters.skipRemoteOnlyCondition,
includeUnavailableTransitions: parameters.includeUnavailableTransitions,
sortByOpsBarAndStatus: parameters.sortByOpsBarAndStatus,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
*
* SortByCategory To update the fields on the transition screen, specify the fields in the `fields` or `update`
* parameters in the request body. Get details about the fields using [ Get
* transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the `transitions.fields` expand.
*
* This operation can be accessed anonymously.