@resolution/jira-api-client 0.4.2 → 0.4.5

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.
Files changed (327) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +4 -0
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +28 -4
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +24 -1
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/models/common.d.ts +6 -0
  7. package/lib/openapi/platform/models/common.js +12 -1
  8. package/lib/openapi/platform/models/common.js.map +1 -1
  9. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  10. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  11. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  12. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  13. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  14. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  15. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  16. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  17. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  18. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  19. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  20. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  21. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  22. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  23. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  24. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  25. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  26. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  27. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  28. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  29. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  30. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  31. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  32. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  33. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  34. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  35. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  36. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  37. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  38. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  39. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  40. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  41. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  42. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  43. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  44. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  45. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  46. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  47. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  48. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  49. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  50. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  51. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  52. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  53. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  54. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  55. package/lib/openapi/platform/services/GroupsService.js +385 -382
  56. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  57. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  58. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  59. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  61. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  62. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  63. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  64. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  65. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  66. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  67. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  68. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  70. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  71. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  73. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  74. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  76. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  77. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  80. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  82. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  83. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  85. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  86. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  88. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  89. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  91. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  92. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  94. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  95. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  97. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  98. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  100. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  101. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  103. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  104. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  106. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  107. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  109. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  110. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  112. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  113. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  115. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  116. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  118. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  119. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  121. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  122. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  124. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  125. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  127. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  128. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  130. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  131. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  133. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  134. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  136. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  137. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  138. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  139. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  140. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  141. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  142. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  143. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  144. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  145. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  146. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  147. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  148. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  149. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  150. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  151. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  152. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  153. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  154. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  155. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  156. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  157. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  158. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  159. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  160. package/lib/openapi/platform/services/JqlService.js +635 -632
  161. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  162. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  163. package/lib/openapi/platform/services/LabelsService.js +41 -38
  164. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  165. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  166. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  167. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  168. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  169. package/lib/openapi/platform/services/MyselfService.js +321 -318
  170. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  171. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  172. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  173. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  174. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  175. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  176. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  177. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  178. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  179. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  180. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  181. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  182. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  184. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  185. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  187. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  188. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  190. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  191. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  193. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  194. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  196. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  197. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  199. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  200. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  202. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  203. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  205. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  206. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  208. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  209. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  210. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  211. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  212. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  213. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  214. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  215. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  216. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  217. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  218. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  219. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  220. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  221. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  222. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  223. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  224. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  225. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  226. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  227. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  228. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  229. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  230. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  231. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  232. package/lib/openapi/platform/services/ScreensService.js +281 -278
  233. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  234. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  235. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  236. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  237. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  238. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  239. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  240. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  241. package/lib/openapi/platform/services/StatusService.js +271 -268
  242. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  243. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  244. package/lib/openapi/platform/services/TasksService.js +93 -90
  245. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  246. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  247. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  248. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  249. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  250. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  251. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  252. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  253. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  254. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  255. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  256. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  257. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  258. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  259. package/lib/openapi/platform/services/UsersService.js +637 -634
  260. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  261. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  262. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  263. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  264. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  265. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  266. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  268. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  269. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  271. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  272. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  274. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  275. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  276. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  277. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  278. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  279. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  280. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  281. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  282. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  283. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  284. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  285. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  286. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  287. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  288. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  289. package/lib/openapi/software/services/BacklogService.js +81 -78
  290. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  291. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  292. package/lib/openapi/software/services/BoardService.js +2048 -2045
  293. package/lib/openapi/software/services/BoardService.js.map +1 -1
  294. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  295. package/lib/openapi/software/services/BuildsService.js +164 -161
  296. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  297. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  298. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  299. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  300. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  301. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  302. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  303. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  304. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  305. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  306. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  307. package/lib/openapi/software/services/EpicService.js +597 -594
  308. package/lib/openapi/software/services/EpicService.js.map +1 -1
  309. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  310. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  311. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  312. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  313. package/lib/openapi/software/services/IssueService.js +359 -356
  314. package/lib/openapi/software/services/IssueService.js.map +1 -1
  315. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  316. package/lib/openapi/software/services/OperationsService.js +301 -298
  317. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  318. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  319. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  320. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  321. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  322. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  323. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  324. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  325. package/lib/openapi/software/services/SprintService.js +594 -591
  326. package/lib/openapi/software/services/SprintService.js.map +1 -1
  327. package/package.json +4 -3
@@ -28,1859 +28,1862 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
28
28
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues
29
29
  */
30
30
  class IssuesService extends CommonHttpService_1.CommonHttpService {
31
- /**
32
- * Enables admins to archive up to 1000 issues in a single request using issue
33
- * ID/key, returning details of the issue(s) archived in the process and the
34
- * errors encountered, if any.
35
- *
36
- * **Note that:**
37
- *
38
- * * you can't archive subtasks directly, only through their parent issues
39
- * * you can only archive issues from software, service management, and business
40
- * projects
41
- *
42
- * **[Permissions](#permissions) required:** Jira admin or site admin: [global
43
- * permission](https://confluence.atlassian.com/x/x4dKLg)
44
- *
45
- * **License required:** Premium or Enterprise
46
- *
47
- * **Signed-in users only:** This API can't be accessed anonymously.
48
- *
49
- * @returns Returned if there is at least one valid issue to archive in the request. The
50
- * return message will include the count of archived issues and subtasks, as well
51
- * as error details for issues which failed to get archived.
52
- *
53
- * example: {
54
- * "errors": {
55
- * "issueIsSubtask": {
56
- * "count": 3,
57
- * "issueIdsOrKeys": [
58
- * "ST-1",
59
- * "ST-2",
60
- * "ST-3"
61
- * ],
62
- * "message": "Issue is subtask."
63
- * },
64
- * "issuesInArchivedProjects": {
65
- * "count": 2,
66
- * "issueIdsOrKeys": [
67
- * "AR-1",
68
- * "AR-2"
69
- * ],
70
- * "message": "Issue exists in archived project."
71
- * },
72
- * "issuesInUnlicensedProjects": {
73
- * "count": 3,
74
- * "issueIdsOrKeys": [
75
- * "UL-1",
76
- * "UL-2",
77
- * "UL-3"
78
- * ],
79
- * "message": "Issues with these IDs are in unlicensed projects."
80
- * },
81
- * "issuesNotFound": {
82
- * "count": 3,
83
- * "issueIdsOrKeys": [
84
- * "PR-1",
85
- * "PR-2",
86
- * "PR-3"
87
- * ],
88
- * "message": "Issue not found."
89
- * }
90
- * },
91
- * "numberOfIssuesUpdated": 10
92
- * }
93
- * @path {PUT} /rest/api/3/issue/archive
94
- * @scopes-current write:jira-work
95
- * @scopes-beta write:issue:jira
96
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-put
97
- */
98
- archiveIssues({ issueArchivalSyncRequest, }) {
99
- return this.getClientInstance()
100
- .request({
101
- path: "/rest/api/3/issue/archive",
102
- method: "PUT",
103
- headers: {
104
- "Content-Type": "application/json",
105
- },
106
- body: issueArchivalSyncRequest,
107
- })
108
- .then(this.getClientInstance().responseHandler({
109
- 200: {
110
- "application/json": "json",
111
- },
112
- }))
113
- .then(commonHttpClient.castResponse())
114
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.archiveIssues.response"))
115
- .then(commonHttpClient.getBody);
116
- }
117
- /**
118
- * Enables admins to archive up to 100,000 issues in a single request using JQL,
119
- * returning the URL to check the status of the submitted request.
120
- *
121
- * You can use the [get
122
- * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
123
- * and [cancel
124
- * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post)
125
- * APIs to manage the request.
126
- *
127
- * **Note that:**
128
- *
129
- * * you can't archive subtasks directly, only through their parent issues
130
- * * you can only archive issues from software, service management, and business
131
- * projects
132
- *
133
- * **[Permissions](#permissions) required:** Jira admin or site admin: [global
134
- * permission](https://confluence.atlassian.com/x/x4dKLg)
135
- *
136
- * **License required:** Premium or Enterprise
137
- *
138
- * **Signed-in users only:** This API can't be accessed anonymously.
139
- *
140
- * **Rate limiting:** Only a single request per jira instance can be active at any
141
- * given time.
142
- *
143
- * @returns Returns the URL to check the status of the submitted request.
144
- *
145
- * example: "https://your-domain.atlassian.net/rest/api/3/task/1010"
146
- * @path {POST} /rest/api/3/issue/archive
147
- * @scopes-current write:jira-work
148
- * @scopes-beta write:issue:jira
149
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-post
150
- */
151
- archiveIssuesAsync({ archiveIssueAsyncRequest, }) {
152
- return this.getClientInstance()
153
- .request({
154
- path: "/rest/api/3/issue/archive",
155
- method: "POST",
156
- headers: {
157
- "Content-Type": "application/json",
158
- },
159
- body: archiveIssueAsyncRequest,
160
- })
161
- .then(this.getClientInstance().responseHandler({
162
- 202: {
163
- "application/json": "json",
164
- },
165
- }))
166
- .then(commonHttpClient.castResponse())
167
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.archiveIssuesAsync.response"))
168
- .then(commonHttpClient.getBody);
169
- }
170
- /**
171
- * Assigns an issue to a user. Use this operation when the calling user does not
172
- * have the *Edit Issues* permission but has the *Assign issue* permission for the
173
- * project that the issue is in.
174
- *
175
- * If `name` or `accountId` is set to:
176
- *
177
- * * `"-1"`, the issue is assigned to the default assignee for the project.
178
- * * `null`, the issue is set to unassigned.
179
- *
180
- * This operation can be accessed anonymously.
181
- *
182
- * **[Permissions](#permissions) required:**
183
- *
184
- * * *Browse Projects* and *Assign Issues* [ project
185
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
186
- * issue is in.
187
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
188
- * configured, issue-level security permission to view the issue.
189
- *
190
- * @returns Returned if the request is successful.
191
- * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/assignee
192
- * @scopes-current write:jira-work
193
- * @scopes-beta write:issue:jira
194
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-assignee-put
195
- */
196
- assignIssue({ issueIdOrKey, user, }) {
197
- return this.getClientInstance()
198
- .request({
199
- path: "/rest/api/3/issue/{issueIdOrKey}/assignee",
200
- method: "PUT",
201
- pathParams: {
202
- issueIdOrKey,
203
- },
204
- headers: {
205
- "Content-Type": "application/json",
206
- },
207
- body: user,
208
- })
209
- .then(this.getClientInstance().responseHandler({
210
- 204: {
211
- "application/json": "json",
212
- },
213
- }))
214
- .then(commonHttpClient.castResponse())
215
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.assignIssue.response"))
216
- .then(commonHttpClient.getBody);
217
- }
218
- /**
219
- * Creates an issue or, where the option to create subtasks is enabled in Jira, a
220
- * subtask. A transition may be applied, to move the issue or subtask to a
221
- * workflow step other than the default start step, and issue properties set.
222
- *
223
- * The content of the issue or subtask is defined using `update` and `fields`. The
224
- * fields that can be set in the issue or subtask are determined using the [ Get
225
- * create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
226
- * same fields that appear on the issue's create screen. Note that the
227
- * `description`, `environment`, and any `textarea` type custom fields (multi-line
228
- * text fields) take Atlassian Document Format content. Single line custom fields
229
- * (`textfield`) accept a string and don't handle Atlassian Document Format
230
- * content.
231
- *
232
- * Creating a subtask differs from creating an issue as follows:
233
- *
234
- * * `issueType` must be set to a subtask issue type (use [ Get create issue
235
- * metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
236
- * * `parent` must contain the ID or key of the parent issue.
237
- *
238
- * In a next-gen project any issue may be made a child providing that the parent
239
- * and child are members of the same project.
240
- *
241
- * **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
242
- * [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
243
- * project in which the issue or subtask is created.
244
- *
245
- * @returns Returned if the request is successful.
246
- *
247
- * example: {
248
- * "id": "10000",
249
- * "key": "ED-24",
250
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
251
- * "transition": {
252
- * "status": 200,
253
- * "errorCollection": {
254
- * "errorMessages": [],
255
- * "errors": {}
256
- * }
257
- * }
258
- * }
259
- * @path {POST} /rest/api/3/issue
260
- * @scopes-current write:jira-work
261
- * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
262
- * write:attachment:jira, read:issue:jira
263
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-post
264
- */
265
- createIssue({ updateHistory, issueUpdateDetails, }) {
266
- return this.getClientInstance()
267
- .request({
268
- path: "/rest/api/3/issue",
269
- method: "POST",
270
- query: {
271
- updateHistory,
272
- },
273
- headers: {
274
- "Content-Type": "application/json",
275
- },
276
- body: issueUpdateDetails,
277
- })
278
- .then(this.getClientInstance().responseHandler({
279
- 201: {
280
- "application/json": "json",
281
- },
282
- }))
283
- .then(commonHttpClient.castResponse())
284
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.createIssue.response"))
285
- .then(commonHttpClient.getBody);
286
- }
287
- /**
288
- * Creates upto **50** issues and, where the option to create subtasks is enabled
289
- * in Jira, subtasks. Transitions may be applied, to move the issues or subtasks
290
- * to a workflow step other than the default start step, and issue properties set.
291
- *
292
- * The content of each issue or subtask is defined using `update` and `fields`.
293
- * The fields that can be set in the issue or subtask are determined using the [
294
- * Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
295
- * same fields that appear on the issues' create screens. Note that the
296
- * `description`, `environment`, and any `textarea` type custom fields (multi-line
297
- * text fields) take Atlassian Document Format content. Single line custom fields
298
- * (`textfield`) accept a string and don't handle Atlassian Document Format
299
- * content.
300
- *
301
- * Creating a subtask differs from creating an issue as follows:
302
- *
303
- * * `issueType` must be set to a subtask issue type (use [ Get create issue
304
- * metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
305
- * * `parent` the must contain the ID or key of the parent issue.
306
- *
307
- * **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
308
- * [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
309
- * project in which each issue or subtask is created.
310
- *
311
- * @returns Returned if any of the issue or subtask creation requests were successful. A
312
- * request may be unsuccessful when it:
313
- *
314
- * * is missing required fields.
315
- * * contains invalid field values.
316
- * * contains fields that cannot be set for the issue type.
317
- * * is by a user who does not have the necessary permission.
318
- * * is to create a subtype in a project different that of the parent issue.
319
- * * is for a subtask when the option to create subtasks is disabled.
320
- * * is invalid for any other reason.
321
- *
322
- * example: {
323
- * "issues": [
324
- * {
325
- * "id": "10000",
326
- * "key": "ED-24",
327
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
328
- * "transition": {
329
- * "status": 200,
330
- * "errorCollection": {
331
- * "errorMessages": [],
332
- * "errors": {}
333
- * }
334
- * }
335
- * },
336
- * {
337
- * "id": "10001",
338
- * "key": "ED-25",
339
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
340
- * }
341
- * ],
342
- * "errors": []
343
- * }
344
- * @path {POST} /rest/api/3/issue/bulk
345
- * @scopes-current write:jira-work
346
- * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
347
- * write:attachment:jira, read:issue:jira
348
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-bulk-post
349
- */
350
- createIssues({ issuesUpdateBean, }) {
351
- return this.getClientInstance()
352
- .request({
353
- path: "/rest/api/3/issue/bulk",
354
- method: "POST",
355
- headers: {
356
- "Content-Type": "application/json",
357
- },
358
- body: issuesUpdateBean,
359
- })
360
- .then(this.getClientInstance().responseHandler({
361
- 201: {
362
- "application/json": "json",
363
- },
364
- }))
365
- .then(commonHttpClient.castResponse())
366
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.createIssues.response"))
367
- .then(commonHttpClient.getBody);
368
- }
369
- /**
370
- * Deletes an issue.
371
- *
372
- * An issue cannot be deleted if it has one or more subtasks. To delete an issue
373
- * with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be
374
- * deleted with the issue.
375
- *
376
- * This operation can be accessed anonymously.
377
- *
378
- * **[Permissions](#permissions) required:**
379
- *
380
- * * *Browse projects* and *Delete issues* [project
381
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project
382
- * containing the issue.
383
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
384
- * configured, issue-level security permission to view the issue.
385
- *
386
- * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}
387
- * @scopes-current write:jira-work
388
- * @scopes-beta delete:issue:jira
389
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-delete
390
- */
391
- deleteIssue({ issueIdOrKey, deleteSubtasks, }) {
392
- return this.getClientInstance()
393
- .request({
394
- path: "/rest/api/3/issue/{issueIdOrKey}",
395
- method: "DELETE",
396
- pathParams: {
397
- issueIdOrKey,
398
- },
399
- query: {
400
- deleteSubtasks,
401
- },
402
- })
403
- .then(commonHttpClient.discardResult);
404
- }
405
- /**
406
- * Performs an issue transition and, if the transition has a screen, updates the
407
- * fields from the transition screen.
408
- *
409
- * sortByCategory To update the fields on the transition screen, specify the
410
- * fields in the `fields` or `update` parameters in the request body. Get details
411
- * about the fields using [ Get
412
- * transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the
413
- * `transitions.fields` expand.
414
- *
415
- * This operation can be accessed anonymously.
416
- *
417
- * **[Permissions](#permissions) required:**
418
- *
419
- * * *Browse projects* and *Transition issues* [project
420
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
421
- * issue is in.
422
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
423
- * configured, issue-level security permission to view the issue.
424
- *
425
- * @returns Returned if the request is successful.
426
- * @path {POST} /rest/api/3/issue/{issueIdOrKey}/transitions
427
- * @scopes-current write:jira-work
428
- * @scopes-beta write:issue:jira, write:issue.property:jira
429
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-post
430
- */
431
- doTransition({ issueIdOrKey, issueUpdateDetails, }) {
432
- return this.getClientInstance()
433
- .request({
434
- path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
435
- method: "POST",
436
- pathParams: {
437
- issueIdOrKey,
438
- },
439
- headers: {
440
- "Content-Type": "application/json",
441
- },
442
- body: issueUpdateDetails,
443
- })
444
- .then(this.getClientInstance().responseHandler({
445
- 204: {
446
- "application/json": "json",
447
- },
448
- }))
449
- .then(commonHttpClient.castResponse())
450
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.doTransition.response"))
451
- .then(commonHttpClient.getBody);
452
- }
453
- /**
454
- * Edits an issue. Issue properties may be updated as part of the edit. Please
455
- * note that issue transition will be ignored as it is not supported yet.
456
- *
457
- * The edits to the issue's fields are defined using `update` and `fields`. The
458
- * fields that can be edited are determined using [ Get edit issue
459
- * metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
460
- *
461
- * The parent field may be set by key or ID. For standard issue types, the parent
462
- * may be removed by setting `update.parent.set.none` to *true*. Note that the
463
- * `description`, `environment`, and any `textarea` type custom fields (multi-line
464
- * text fields) take Atlassian Document Format content. Single line custom fields
465
- * (`textfield`) accept a string and don't handle Atlassian Document Format
466
- * content.
467
- *
468
- * Connect apps having an app user with *Administer Jira* [global
469
- * permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
470
- * on behalf of users with *Administer Jira* [global
471
- * permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen
472
- * security configuration using `overrideScreenSecurity` and
473
- * `overrideEditableFlag`.
474
- *
475
- * This operation can be accessed anonymously.
476
- *
477
- * **[Permissions](#permissions) required:**
478
- *
479
- * * *Browse projects* and *Edit issues* [project
480
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
481
- * issue is in.
482
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
483
- * configured, issue-level security permission to view the issue.
484
- *
485
- * @returns * status: 200, mediaType: application/json
486
- *
487
- * Returned if the request is successful and the `returnIssue` parameter is
488
- * `true`
489
- *
490
- * * status: 204, mediaType: application/json
491
- *
492
- * Returned if the request is successful.
493
- * @path {PUT} /rest/api/3/issue/{issueIdOrKey}
494
- * @scopes-current write:jira-work
495
- * @scopes-beta write:issue:jira
496
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-put
497
- */
498
- editIssue({ issueIdOrKey, notifyUsers, overrideScreenSecurity, overrideEditableFlag, returnIssue, expand, issueUpdateDetails, }) {
499
- return this.getClientInstance()
500
- .request({
501
- path: "/rest/api/3/issue/{issueIdOrKey}",
502
- method: "PUT",
503
- pathParams: {
504
- issueIdOrKey,
505
- },
506
- query: {
507
- notifyUsers,
508
- overrideScreenSecurity,
509
- overrideEditableFlag,
510
- returnIssue,
511
- expand,
512
- },
513
- headers: {
514
- "Content-Type": "application/json",
515
- },
516
- body: issueUpdateDetails,
517
- })
518
- .then(this.getClientInstance().responseHandler({
519
- 200: {
520
- "application/json": "json",
521
- },
522
- 204: {
523
- "application/json": "json",
524
- },
525
- }))
526
- .then(commonHttpClient.castResponse())
527
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.editIssue.response"));
528
- }
529
- /**
530
- * Enables admins to retrieve details of all archived issues. Upon a successful
531
- * request, the admin who submitted it will receive an email with a link to
532
- * download a CSV file with the issue details.
533
- *
534
- * Note that this API only exports the values of system fields and
535
- * archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields
536
- * aren't supported.
537
- *
538
- * **[Permissions](#permissions) required:** Jira admin or site admin: [global
539
- * permission](https://confluence.atlassian.com/x/x4dKLg)
540
- *
541
- * **License required:** Premium or Enterprise
542
- *
543
- * **Signed-in users only:** This API can't be accessed anonymously.
544
- *
545
- * **Rate limiting:** Only a single request can be active at any given time.
546
- *
547
- * @returns Returns the details of your export task. You can use the [get
548
- * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
549
- * API to view the progress of your request.
550
- *
551
- * example: {
552
- * "payload": "{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002],
553
- * issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01,
554
- * dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}",
555
- * "progress": 0,
556
- * "status": "ENQUEUED",
557
- * "submittedTime": 1623230887000,
558
- * "taskId": "10990"
559
- * }
560
- * @path {PUT} /rest/api/3/issues/archive/export
561
- * @scopes-current read:jira-work
562
- * @scopes-beta read:issue:jira
563
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issues-archive-export-put
564
- */
565
- exportArchivedIssues({ archivedIssuesFilterRequest, }) {
566
- return this.getClientInstance()
567
- .request({
568
- path: "/rest/api/3/issues/archive/export",
569
- method: "PUT",
570
- headers: {
571
- "Content-Type": "application/json",
572
- },
573
- body: archivedIssuesFilterRequest,
574
- })
575
- .then(this.getClientInstance().responseHandler({
576
- 202: {
577
- "application/json": "json",
578
- },
579
- }))
580
- .then(commonHttpClient.castResponse())
581
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.exportArchivedIssues.response"))
582
- .then(commonHttpClient.getBody);
583
- }
584
- /**
585
- * Returns a [paginated](#pagination) list of all changelogs for an issue sorted
586
- * by date, starting from the oldest.
587
- *
588
- * This operation can be accessed anonymously.
589
- *
590
- * **[Permissions](#permissions) required:**
591
- *
592
- * * *Browse projects* [project
593
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
594
- * issue is in.
595
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
596
- * configured, issue-level security permission to view the issue.
597
- *
598
- * @returns Returned if the request is successful.
599
- *
600
- * example: {
601
- * "isLast": false,
602
- * "maxResults": 2,
603
- * "nextPage":
604
- * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2",
605
- * "self":
606
- * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2",
607
- * "startAt": 2,
608
- * "total": 5,
609
- * "values": [
610
- * {
611
- * "author": {
612
- * "accountId": "5b10a2844c20165700ede21g",
613
- * "active": true,
614
- * "avatarUrls": {
615
- * "16x16":
616
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
617
- * "24x24":
618
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
619
- * "32x32":
620
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
621
- * "48x48":
622
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
623
- * },
624
- * "displayName": "Mia Krystof",
625
- * "emailAddress": "mia@example.com",
626
- * "self":
627
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
628
- * "timeZone": "Australia/Sydney"
629
- * },
630
- * "created": "1970-01-18T06:27:50.429+0000",
631
- * "id": "10001",
632
- * "items": [
633
- * {
634
- * "field": "fields",
635
- * "fieldtype": "jira",
636
- * "fieldId": "fieldId",
637
- * "from": null,
638
- * "fromString": "",
639
- * "to": null,
640
- * "toString": "label-1"
641
- * }
642
- * ]
643
- * },
644
- * {
645
- * "author": {
646
- * "accountId": "5b10a2844c20165700ede21g",
647
- * "active": true,
648
- * "avatarUrls": {
649
- * "16x16":
650
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
651
- * "24x24":
652
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
653
- * "32x32":
654
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
655
- * "48x48":
656
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
657
- * },
658
- * "displayName": "Mia Krystof",
659
- * "emailAddress": "mia@example.com",
660
- * "self":
661
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
662
- * "timeZone": "Australia/Sydney"
663
- * },
664
- * "created": "1970-01-18T06:27:51.429+0000",
665
- * "id": "10002",
666
- * "items": [
667
- * {
668
- * "field": "fields",
669
- * "fieldtype": "jira",
670
- * "fieldId": "fieldId",
671
- * "from": null,
672
- * "fromString": "label-1",
673
- * "to": null,
674
- * "toString": "label-1 label-2"
675
- * }
676
- * ]
677
- * }
678
- * ]
679
- * }
680
- * @path {GET} /rest/api/3/issue/{issueIdOrKey}/changelog
681
- * @scopes-current read:jira-work
682
- * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
683
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-get
684
- */
685
- getChangeLogs({ issueIdOrKey, startAt, maxResults, }) {
686
- return this.getClientInstance()
687
- .request({
688
- path: "/rest/api/3/issue/{issueIdOrKey}/changelog",
689
- method: "GET",
690
- pathParams: {
691
- issueIdOrKey,
692
- },
693
- query: {
694
- startAt,
695
- maxResults,
696
- },
697
- })
698
- .then(this.getClientInstance().responseHandler({
699
- 200: {
700
- "application/json": "json",
701
- },
702
- }))
703
- .then(commonHttpClient.castResponse())
704
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getChangeLogs.response"))
705
- .then(commonHttpClient.getBody);
706
- }
707
- /**
708
- * Returns changelogs for an issue specified by a list of changelog IDs.
709
- *
710
- * This operation can be accessed anonymously.
711
- *
712
- * **[Permissions](#permissions) required:**
713
- *
714
- * * *Browse projects* [project
715
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
716
- * issue is in.
717
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
718
- * configured, issue-level security permission to view the issue.
719
- *
720
- * @returns Returned if the request is successful.
721
- *
722
- * example: {
723
- * "histories": [
724
- * {
725
- * "author": {
726
- * "accountId": "5b10a2844c20165700ede21g",
727
- * "active": true,
728
- * "avatarUrls": {
729
- * "16x16":
730
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
731
- * "24x24":
732
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
733
- * "32x32":
734
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
735
- * "48x48":
736
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
737
- * },
738
- * "displayName": "Mia Krystof",
739
- * "emailAddress": "mia@example.com",
740
- * "self":
741
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
742
- * "timeZone": "Australia/Sydney"
743
- * },
744
- * "created": "1970-01-18T06:27:50.429+0000",
745
- * "id": "10001",
746
- * "items": [
747
- * {
748
- * "field": "fields",
749
- * "fieldtype": "jira",
750
- * "fieldId": "fieldId",
751
- * "from": null,
752
- * "fromString": "",
753
- * "to": null,
754
- * "toString": "label-1"
755
- * }
756
- * ]
757
- * },
758
- * {
759
- * "author": {
760
- * "accountId": "5b10a2844c20165700ede21g",
761
- * "active": true,
762
- * "avatarUrls": {
763
- * "16x16":
764
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
765
- * "24x24":
766
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
767
- * "32x32":
768
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
769
- * "48x48":
770
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
771
- * },
772
- * "displayName": "Mia Krystof",
773
- * "emailAddress": "mia@example.com",
774
- * "self":
775
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
776
- * "timeZone": "Australia/Sydney"
777
- * },
778
- * "created": "1970-01-18T06:27:51.429+0000",
779
- * "id": "10002",
780
- * "items": [
781
- * {
782
- * "field": "fields",
783
- * "fieldtype": "jira",
784
- * "fieldId": "fieldId",
785
- * "from": null,
786
- * "fromString": "label-1",
787
- * "to": null,
788
- * "toString": "label-1 label-2"
789
- * }
790
- * ]
791
- * }
792
- * ],
793
- * "maxResults": 2,
794
- * "startAt": 0,
795
- * "total": 2
796
- * }
797
- * @path {POST} /rest/api/3/issue/{issueIdOrKey}/changelog/list
798
- * @scopes-current read:jira-work
799
- * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
800
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-list-post
801
- */
802
- getChangeLogsByIds({ issueIdOrKey, issueChangelogIds, }) {
803
- return this.getClientInstance()
804
- .request({
805
- path: "/rest/api/3/issue/{issueIdOrKey}/changelog/list",
806
- method: "POST",
807
- pathParams: {
808
- issueIdOrKey,
809
- },
810
- headers: {
811
- "Content-Type": "application/json",
812
- },
813
- body: issueChangelogIds,
814
- })
815
- .then(this.getClientInstance().responseHandler({
816
- 200: {
817
- "application/json": "json",
818
- },
819
- }))
820
- .then(commonHttpClient.castResponse())
821
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getChangeLogsByIds.response"))
822
- .then(commonHttpClient.getBody);
823
- }
824
- /**
825
- * Returns details of projects, issue types within projects, and, when requested,
826
- * the create screen fields for each issue type for the user. Use the information
827
- * to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and
828
- * [Create issues](#api-rest-api-3-issue-bulk-post).
829
- *
830
- * Deprecated, see [Create Issue Meta Endpoint Deprecation
831
- * Notice](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1304).
832
- *
833
- * The request can be restricted to specific projects or issue types using the
834
- * query parameters. The response will contain information for the valid projects,
835
- * issue types, or project and issue type combinations requested. Note that
836
- * invalid project, issue type, or project and issue type combinations do not
837
- * generate errors.
838
- *
839
- * This operation can be accessed anonymously.
840
- *
841
- * **[Permissions](#permissions) required:** *Create issues* [project
842
- * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
843
- * projects.
844
- *
845
- * @deprecated
846
- * @returns Returned if the request is successful.
847
- *
848
- * example: {
849
- * "projects": [
850
- * {
851
- * "avatarUrls": {
852
- * "16x16":
853
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
854
- * "24x24":
855
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
856
- * "32x32":
857
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
858
- * "48x48":
859
- * "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
860
- * },
861
- * "id": "10000",
862
- * "issuetypes": [
863
- * {
864
- * "description": "An error in the code",
865
- * "fields": {
866
- * "issuetype": {
867
- * "allowedValues": [
868
- * "set"
869
- * ],
870
- * "autoCompleteUrl": "issuetype",
871
- * "hasDefaultValue": false,
872
- * "key": "issuetype",
873
- * "name": "Issue Type",
874
- * "required": true
875
- * }
876
- * },
877
- * "iconUrl":
878
- * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
879
- * "id": "1",
880
- * "name": "Bug",
881
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
882
- * "subtask": false
883
- * }
884
- * ],
885
- * "key": "ED",
886
- * "name": "Edison Project",
887
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/ED"
888
- * }
889
- * ]
890
- * }
891
- * @path {GET} /rest/api/3/issue/createmeta
892
- * @scopes-current read:jira-work
893
- * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
894
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-get
895
- */
896
- getCreateIssueMeta({ projectIds, projectKeys, issuetypeIds, issuetypeNames, expand, } = {}) {
897
- return this.getClientInstance()
898
- .request({
899
- path: "/rest/api/3/issue/createmeta",
900
- method: "GET",
901
- query: {
902
- projectIds,
903
- projectKeys,
904
- issuetypeIds,
905
- issuetypeNames,
906
- expand,
907
- },
908
- })
909
- .then(this.getClientInstance().responseHandler({
910
- 200: {
911
- "application/json": "json",
912
- },
913
- }))
914
- .then(commonHttpClient.castResponse())
915
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMeta.response"))
916
- .then(commonHttpClient.getBody);
917
- }
918
- /**
919
- * Returns a page of field metadata for a specified project and issuetype id. Use
920
- * the information to populate the requests in [ Create
921
- * issue](#api-rest-api-3-issue-post) and [Create
922
- * issues](#api-rest-api-3-issue-bulk-post).
923
- *
924
- * This operation can be accessed anonymously.
925
- *
926
- * **[Permissions](#permissions) required:** *Create issues* [project
927
- * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
928
- * projects.
929
- *
930
- * @returns Returned if the request is successful.
931
- *
932
- * example: {
933
- * "fields": [
934
- * {
935
- * "fieldId": "assignee",
936
- * "hasDefaultValue": false,
937
- * "key": "assignee",
938
- * "name": "Assignee",
939
- * "operations": [
940
- * "set"
941
- * ],
942
- * "required": true
943
- * }
944
- * ],
945
- * "maxResults": 1,
946
- * "startAt": 0,
947
- * "total": 1
948
- * }
949
- * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
950
- * @scopes-current read:jira-work
951
- * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
952
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get
953
- */
954
- getCreateIssueMetaIssueTypeId({ projectIdOrKey, issueTypeId, startAt, maxResults, }) {
955
- return this.getClientInstance()
956
- .request({
957
- path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}",
958
- method: "GET",
959
- pathParams: {
960
- projectIdOrKey,
961
- issueTypeId,
962
- },
963
- query: {
964
- startAt,
965
- maxResults,
966
- },
967
- })
968
- .then(this.getClientInstance().responseHandler({
969
- 200: {
970
- "application/json": "json",
971
- },
972
- }))
973
- .then(commonHttpClient.castResponse())
974
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMetaIssueTypeId.response"))
975
- .then(commonHttpClient.getBody);
976
- }
977
- /**
978
- * Returns a page of issue type metadata for a specified project. Use the
979
- * information to populate the requests in [ Create
980
- * issue](#api-rest-api-3-issue-post) and [Create
981
- * issues](#api-rest-api-3-issue-bulk-post).
982
- *
983
- * This operation can be accessed anonymously.
984
- *
985
- * **[Permissions](#permissions) required:** *Create issues* [project
986
- * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
987
- * projects.
988
- *
989
- * @returns Returned if the request is successful.
990
- *
991
- * example: {
992
- * "issueTypes": [
993
- * {
994
- * "description": "An error in the code",
995
- * "iconUrl":
996
- * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
997
- * "id": "1",
998
- * "name": "Bug",
999
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1000
- * "subtask": false
1001
- * }
1002
- * ],
1003
- * "maxResults": 1,
1004
- * "startAt": 0,
1005
- * "total": 1
1006
- * }
1007
- * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
1008
- * @scopes-current read:jira-work
1009
- * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
1010
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-get
1011
- */
1012
- getCreateIssueMetaIssueTypes({ projectIdOrKey, startAt, maxResults, }) {
1013
- return this.getClientInstance()
1014
- .request({
1015
- path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes",
1016
- method: "GET",
1017
- pathParams: {
1018
- projectIdOrKey,
1019
- },
1020
- query: {
1021
- startAt,
1022
- maxResults,
1023
- },
1024
- })
1025
- .then(this.getClientInstance().responseHandler({
1026
- 200: {
1027
- "application/json": "json",
1028
- },
1029
- }))
1030
- .then(commonHttpClient.castResponse())
1031
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMetaIssueTypes.response"))
1032
- .then(commonHttpClient.getBody);
1033
- }
1034
- /**
1035
- * Returns the edit screen fields for an issue that are visible to and editable by
1036
- * the user. Use the information to populate the requests in [Edit
1037
- * issue](#api-rest-api-3-issue-issueIdOrKey-put).
1038
- *
1039
- * This endpoint will check for these conditions:
1040
- *
1041
- * 1. Field is available on a field screen - through screen, screen scheme, issue
1042
- * type screen scheme, and issue type scheme configuration.
1043
- * `overrideScreenSecurity=true` skips this condition.
1044
- * 2. Field is visible in the [field
1045
- * configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/).
1046
- * `overrideScreenSecurity=true` skips this condition.
1047
- * 3. Field is shown on the issue: each field has different conditions here. For
1048
- * example: Attachment field only shows if attachments are enabled. Assignee only
1049
- * shows if user has permissions to assign the issue.
1050
- * 4. If a field is custom then it must have valid custom field context,
1051
- * applicable for its project and issue type. All system fields are assumed to
1052
- * have context in all projects and all issue types.
1053
- * 5. Issue has a project, issue type, and status defined.
1054
- * 6. Issue is assigned to a valid workflow, and the current status has assigned
1055
- * a workflow step. `overrideEditableFlag=true` skips this condition.
1056
- * 7. The current workflow step is editable. This is true by default, but [can be
1057
- * disabled by
1058
- * setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
1059
- * the `jira.issue.editable` property to `false`. `overrideEditableFlag=true`
1060
- * skips this condition.
1061
- * 8. User has [Edit issues
1062
- * permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).
1063
- * 9. Workflow permissions allow editing a field. This is true by default but
1064
- * [can be
1065
- * modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
1066
- * using `jira.permission.*` workflow properties.
1067
- *
1068
- * Fields hidden using [Issue layout settings
1069
- * page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/)
1070
- * remain editable.
1071
- *
1072
- * Connect apps having an app user with *Administer Jira* [global
1073
- * permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
1074
- * on behalf of users with *Administer Jira* [global
1075
- * permission](https://confluence.atlassian.com/x/x4dKLg), can return additional
1076
- * details using:
1077
- *
1078
- * * `overrideScreenSecurity` When this flag is `true`, then this endpoint skips
1079
- * checking if fields are available through screens, and field configuration
1080
- * (conditions 1. and 2. from the list above).
1081
- * * `overrideEditableFlag` When this flag is `true`, then this endpoint skips
1082
- * checking if workflow is present and if the current step is editable (conditions
1083
- * 6. and 7. from the list above).
1084
- *
1085
- * This operation can be accessed anonymously.
1086
- *
1087
- * **[Permissions](#permissions) required:**
1088
- *
1089
- * * *Browse projects* [project
1090
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1091
- * issue is in.
1092
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1093
- * configured, issue-level security permission to view the issue.
1094
- *
1095
- * Note: For any fields to be editable the user must have the *Edit issues*
1096
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
1097
- *
1098
- * @returns Returned if the request is successful.
1099
- *
1100
- * example: {
1101
- * "fields": {
1102
- * "summary": {
1103
- * "allowedValues": [
1104
- * "red",
1105
- * "blue"
1106
- * ],
1107
- * "defaultValue": "red",
1108
- * "hasDefaultValue": false,
1109
- * "key": "field_key",
1110
- * "name": "My Multi Select",
1111
- * "operations": [
1112
- * "set",
1113
- * "add"
1114
- * ],
1115
- * "required": false,
1116
- * "schema": {
1117
- * "custom":
1118
- * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1119
- * "customId": 10001,
1120
- * "items": "option",
1121
- * "type": "array"
1122
- * }
1123
- * }
1124
- * }
1125
- * }
1126
- * @path {GET} /rest/api/3/issue/{issueIdOrKey}/editmeta
1127
- * @scopes-current read:jira-work
1128
- * @scopes-beta read:issue-meta:jira, read:field-configuration:jira
1129
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-editmeta-get
1130
- */
1131
- getEditIssueMeta({ issueIdOrKey, overrideScreenSecurity, overrideEditableFlag, }) {
1132
- return this.getClientInstance()
1133
- .request({
1134
- path: "/rest/api/3/issue/{issueIdOrKey}/editmeta",
1135
- method: "GET",
1136
- pathParams: {
1137
- issueIdOrKey,
1138
- },
1139
- query: {
1140
- overrideScreenSecurity,
1141
- overrideEditableFlag,
1142
- },
1143
- })
1144
- .then(this.getClientInstance().responseHandler({
1145
- 200: {
1146
- "application/json": "json",
1147
- },
1148
- }))
1149
- .then(commonHttpClient.castResponse())
1150
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getEditIssueMeta.response"))
1151
- .then(commonHttpClient.getBody);
1152
- }
1153
- /**
1154
- * Returns all issue events.
1155
- *
1156
- * **[Permissions](#permissions) required:** *Administer Jira* [global
1157
- * permission](https://confluence.atlassian.com/x/x4dKLg).
1158
- *
1159
- * @returns Returned if the request is successful.
1160
- *
1161
- * example: [
1162
- * {
1163
- * "id": 1,
1164
- * "name": "Issue Created"
1165
- * },
1166
- * {
1167
- * "id": 2,
1168
- * "name": "Issue Updated"
1169
- * }
1170
- * ]
1171
- * @path {GET} /rest/api/3/events
1172
- * @scopes-current manage:jira-configuration
1173
- * @scopes-beta read:issue-event:jira
1174
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-events-get
1175
- */
1176
- getEvents() {
1177
- return this.getClientInstance()
1178
- .request({
1179
- path: "/rest/api/3/events",
1180
- method: "GET",
1181
- })
1182
- .then(this.getClientInstance().responseHandler({
1183
- 200: {
1184
- "application/json": "json",
1185
- },
1186
- }))
1187
- .then(commonHttpClient.castResponse())
1188
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getEvents.response"))
1189
- .then(commonHttpClient.getBody);
1190
- }
1191
- /**
1192
- * Returns the details for an issue.
1193
- *
1194
- * The issue is identified by its ID or key, however, if the identifier doesn't
1195
- * match an issue, a case-insensitive search and check for moved issues is
1196
- * performed. If a matching issue is found its details are returned, a 302 or
1197
- * other redirect is **not** returned. The issue key returned in the response is
1198
- * the key of the issue found.
1199
- *
1200
- * This operation can be accessed anonymously.
1201
- *
1202
- * **[Permissions](#permissions) required:**
1203
- *
1204
- * * *Browse projects* [project
1205
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1206
- * issue is in.
1207
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1208
- * configured, issue-level security permission to view the issue.
1209
- *
1210
- * @returns Returned if the request is successful.
1211
- *
1212
- * example: {
1213
- * "fields": {
1214
- * "watcher": {
1215
- * "isWatching": false,
1216
- * "self":
1217
- * "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
1218
- * "watchCount": 1,
1219
- * "watchers": [
1220
- * {
1221
- * "accountId": "5b10a2844c20165700ede21g",
1222
- * "active": false,
1223
- * "displayName": "Mia Krystof",
1224
- * "self":
1225
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1226
- * }
1227
- * ]
1228
- * },
1229
- * "attachment": [
1230
- * {
1231
- * "author": {
1232
- * "accountId": "5b10a2844c20165700ede21g",
1233
- * "accountType": "atlassian",
1234
- * "active": false,
1235
- * "avatarUrls": {
1236
- * "16x16":
1237
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1238
- * "24x24":
1239
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1240
- * "32x32":
1241
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1242
- * "48x48":
1243
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1244
- * },
1245
- * "displayName": "Mia Krystof",
1246
- * "key": "",
1247
- * "name": "",
1248
- * "self":
1249
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1250
- * },
1251
- * "content":
1252
- * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
1253
- * "created": "2022-10-06T07:32:47.000+0000",
1254
- * "filename": "picture.jpg",
1255
- * "id": 10000,
1256
- * "mimeType": "image/jpeg",
1257
- * "self":
1258
- * "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
1259
- * "size": 23123,
1260
- * "thumbnail":
1261
- * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
1262
- * }
1263
- * ],
1264
- * "sub-tasks": [
1265
- * {
1266
- * "id": "10000",
1267
- * "outwardIssue": {
1268
- * "fields": {
1269
- * "status": {
1270
- * "iconUrl":
1271
- * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1272
- * "name": "Open"
1273
- * }
1274
- * },
1275
- * "id": "10003",
1276
- * "key": "ED-2",
1277
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
1278
- * },
1279
- * "type": {
1280
- * "id": "10000",
1281
- * "inward": "Parent",
1282
- * "name": "",
1283
- * "outward": "Sub-task"
1284
- * }
1285
- * }
1286
- * ],
1287
- * "description": {
1288
- * "type": "doc",
1289
- * "version": 1,
1290
- * "content": [
1291
- * {
1292
- * "type": "paragraph",
1293
- * "content": [
1294
- * {
1295
- * "type": "text",
1296
- * "text": "Main order flow broken"
1297
- * }
1298
- * ]
1299
- * }
1300
- * ]
1301
- * },
1302
- * "project": {
1303
- * "avatarUrls": {
1304
- * "16x16":
1305
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1306
- * "24x24":
1307
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1308
- * "32x32":
1309
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1310
- * "48x48":
1311
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1312
- * },
1313
- * "id": "10000",
1314
- * "insight": {
1315
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1316
- * "totalIssueCount": 100
1317
- * },
1318
- * "key": "EX",
1319
- * "name": "Example",
1320
- * "projectCategory": {
1321
- * "description": "First Project Category",
1322
- * "id": "10000",
1323
- * "name": "FIRST",
1324
- * "self":
1325
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1326
- * },
1327
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1328
- * "simplified": false,
1329
- * "style": "classic"
1330
- * },
1331
- * "comment": [
1332
- * {
1333
- * "author": {
1334
- * "accountId": "5b10a2844c20165700ede21g",
1335
- * "active": false,
1336
- * "displayName": "Mia Krystof",
1337
- * "self":
1338
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1339
- * },
1340
- * "body": {
1341
- * "type": "doc",
1342
- * "version": 1,
1343
- * "content": [
1344
- * {
1345
- * "type": "paragraph",
1346
- * "content": [
1347
- * {
1348
- * "type": "text",
1349
- * "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
1350
- * elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
1351
- * fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
1352
- * }
1353
- * ]
1354
- * }
1355
- * ]
1356
- * },
1357
- * "created": "2021-01-17T12:34:00.000+0000",
1358
- * "id": "10000",
1359
- * "self":
1360
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1361
- * "updateAuthor": {
1362
- * "accountId": "5b10a2844c20165700ede21g",
1363
- * "active": false,
1364
- * "displayName": "Mia Krystof",
1365
- * "self":
1366
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1367
- * },
1368
- * "updated": "2021-01-18T23:45:00.000+0000",
1369
- * "visibility": {
1370
- * "identifier": "Administrators",
1371
- * "type": "role",
1372
- * "value": "Administrators"
1373
- * }
1374
- * }
1375
- * ],
1376
- * "issuelinks": [
1377
- * {
1378
- * "id": "10001",
1379
- * "outwardIssue": {
1380
- * "fields": {
1381
- * "status": {
1382
- * "iconUrl":
1383
- * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1384
- * "name": "Open"
1385
- * }
1386
- * },
1387
- * "id": "10004L",
1388
- * "key": "PR-2",
1389
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
1390
- * },
1391
- * "type": {
1392
- * "id": "10000",
1393
- * "inward": "depends on",
1394
- * "name": "Dependent",
1395
- * "outward": "is depended by"
1396
- * }
1397
- * },
1398
- * {
1399
- * "id": "10002",
1400
- * "inwardIssue": {
1401
- * "fields": {
1402
- * "status": {
1403
- * "iconUrl":
1404
- * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1405
- * "name": "Open"
1406
- * }
1407
- * },
1408
- * "id": "10004",
1409
- * "key": "PR-3",
1410
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
1411
- * },
1412
- * "type": {
1413
- * "id": "10000",
1414
- * "inward": "depends on",
1415
- * "name": "Dependent",
1416
- * "outward": "is depended by"
1417
- * }
1418
- * }
1419
- * ],
1420
- * "worklog": [
1421
- * {
1422
- * "author": {
1423
- * "accountId": "5b10a2844c20165700ede21g",
1424
- * "active": false,
1425
- * "displayName": "Mia Krystof",
1426
- * "self":
1427
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1428
- * },
1429
- * "comment": {
1430
- * "type": "doc",
1431
- * "version": 1,
1432
- * "content": [
1433
- * {
1434
- * "type": "paragraph",
1435
- * "content": [
1436
- * {
1437
- * "type": "text",
1438
- * "text": "I did some work here."
1439
- * }
1440
- * ]
1441
- * }
1442
- * ]
1443
- * },
1444
- * "id": "100028",
1445
- * "issueId": "10002",
1446
- * "self":
1447
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1448
- * "started": "2021-01-17T12:34:00.000+0000",
1449
- * "timeSpent": "3h 20m",
1450
- * "timeSpentSeconds": 12000,
1451
- * "updateAuthor": {
1452
- * "accountId": "5b10a2844c20165700ede21g",
1453
- * "active": false,
1454
- * "displayName": "Mia Krystof",
1455
- * "self":
1456
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1457
- * },
1458
- * "updated": "2021-01-18T23:45:00.000+0000",
1459
- * "visibility": {
1460
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1461
- * "type": "group",
1462
- * "value": "jira-developers"
1463
- * }
1464
- * }
1465
- * ],
1466
- * "updated": 1,
1467
- * "timetracking": {
1468
- * "originalEstimate": "10m",
1469
- * "originalEstimateSeconds": 600,
1470
- * "remainingEstimate": "3m",
1471
- * "remainingEstimateSeconds": 200,
1472
- * "timeSpent": "6m",
1473
- * "timeSpentSeconds": 400
1474
- * }
1475
- * },
1476
- * "id": "10002",
1477
- * "key": "ED-1",
1478
- * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
1479
- * }
1480
- * @path {GET} /rest/api/3/issue/{issueIdOrKey}
1481
- * @scopes-current read:jira-work
1482
- * @scopes-beta read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira,
1483
- * read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira,
1484
- * read:user:jira, read:field-configuration:jira
1485
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-get
1486
- */
1487
- getIssue({ issueIdOrKey, fields, fieldsByKeys, expand, properties, updateHistory, }) {
1488
- return this.getClientInstance()
1489
- .request({
1490
- path: "/rest/api/3/issue/{issueIdOrKey}",
1491
- method: "GET",
1492
- pathParams: {
1493
- issueIdOrKey,
1494
- },
1495
- query: {
1496
- fields,
1497
- fieldsByKeys,
1498
- expand,
1499
- properties,
1500
- updateHistory,
1501
- },
1502
- })
1503
- .then(this.getClientInstance().responseHandler({
1504
- 200: {
1505
- "application/json": "json",
1506
- },
1507
- }))
1508
- .then(commonHttpClient.castResponse())
1509
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getIssue.response"))
1510
- .then(commonHttpClient.getBody);
1511
- }
1512
- /**
1513
- * Returns all issues breaching and approaching per-issue limits.
1514
- *
1515
- * **[Permissions](#permissions) required:**
1516
- *
1517
- * * *Browse projects* [project
1518
- * permission](https://confluence.atlassian.com/x/yodKLg) is required for the
1519
- * project the issues are in. Results may be incomplete otherwise
1520
- * * *Administer Jira* [global
1521
- * permission](https://confluence.atlassian.com/x/x4dKLg).
1522
- *
1523
- * @returns Returned if the request is successful.
1524
- *
1525
- * example: {
1526
- * "issuesApproachingLimit": {
1527
- * "attachment": {
1528
- * "15070": 1822,
1529
- * "15111": 1999
1530
- * },
1531
- * "comment": {
1532
- * "10000": 4997,
1533
- * "15073": 4999,
1534
- * "15110": 5000
1535
- * },
1536
- * "remoteIssueLinks": {
1537
- * "15107": 2000
1538
- * },
1539
- * "worklog": {
1540
- * "15101": 4342
1541
- * }
1542
- * },
1543
- * "issuesBreachingLimit": {
1544
- * "attachment": {
1545
- * "15057": 2005,
1546
- * "15116": 2065,
1547
- * "15117": 3005
1548
- * },
1549
- * "comment": {
1550
- * "15055": 5202
1551
- * },
1552
- * "issuelinks": {
1553
- * "15058": 2120
1554
- * },
1555
- * "remoteIssueLinks": {
1556
- * "15059": 2094
1557
- * },
1558
- * "worklog": {
1559
- * "15056": 5085,
1560
- * "15169": 120864
1561
- * }
1562
- * },
1563
- * "limits": {
1564
- * "attachment": 2000,
1565
- * "comment": 5000,
1566
- * "issuelinks": 2000,
1567
- * "remoteIssueLinks": 2000,
1568
- * "worklog": 5000
1569
- * }
1570
- * }
1571
- * @path {GET} /rest/api/3/issue/limit/report
1572
- * @scopes-current read:jira-work
1573
- * @scopes-beta read:project:jira, read:issue:jira
1574
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-limit-report-get
1575
- */
1576
- getIssueLimitReport({ issueLimitReportRequest, }) {
1577
- return this.getClientInstance()
1578
- .request({
1579
- path: "/rest/api/3/issue/limit/report",
1580
- method: "GET",
1581
- headers: {
1582
- "Content-Type": "application/json",
1583
- },
1584
- body: issueLimitReportRequest,
1585
- })
1586
- .then(this.getClientInstance().responseHandler({
1587
- 200: {
1588
- "application/json": "json",
1589
- },
1590
- }))
1591
- .then(commonHttpClient.castResponse())
1592
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getIssueLimitReport.response"))
1593
- .then(commonHttpClient.getBody);
1594
- }
1595
- /**
1596
- * Returns either all transitions or a transition that can be performed by the
1597
- * user on an issue, based on the issue's status.
1598
- *
1599
- * Note, if a request is made for a transition that does not exist or cannot be
1600
- * performed on the issue, given its status, the response will return any empty
1601
- * transitions list.
1602
- *
1603
- * This operation can be accessed anonymously.
1604
- *
1605
- * **[Permissions](#permissions) required: A list or transition is returned only
1606
- * when the user has:**
1607
- *
1608
- * * *Browse projects* [project
1609
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1610
- * issue is in.
1611
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1612
- * configured, issue-level security permission to view the issue.
1613
- *
1614
- * However, if the user does not have the *Transition issues* [ project
1615
- * permission](https://confluence.atlassian.com/x/yodKLg) the response will not
1616
- * list any transitions.
1617
- *
1618
- * @returns Returned if the request is successful.
1619
- *
1620
- * example: {
1621
- * "transitions": [
1622
- * {
1623
- * "fields": {
1624
- * "summary": {
1625
- * "allowedValues": [
1626
- * "red",
1627
- * "blue"
1628
- * ],
1629
- * "defaultValue": "red",
1630
- * "hasDefaultValue": false,
1631
- * "key": "field_key",
1632
- * "name": "My Multi Select",
1633
- * "operations": [
1634
- * "set",
1635
- * "add"
1636
- * ],
1637
- * "required": false,
1638
- * "schema": {
1639
- * "custom":
1640
- * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1641
- * "customId": 10001,
1642
- * "items": "option",
1643
- * "type": "array"
1644
- * }
1645
- * }
1646
- * },
1647
- * "hasScreen": false,
1648
- * "id": "2",
1649
- * "isAvailable": true,
1650
- * "isConditional": false,
1651
- * "isGlobal": false,
1652
- * "isInitial": false,
1653
- * "name": "Close Issue",
1654
- * "to": {
1655
- * "description": "The issue is currently being worked on.",
1656
- * "iconUrl":
1657
- * "https://your-domain.atlassian.net/images/icons/progress.gif",
1658
- * "id": "10000",
1659
- * "name": "In Progress",
1660
- * "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
1661
- * "statusCategory": {
1662
- * "colorName": "yellow",
1663
- * "id": 1,
1664
- * "key": "in-flight",
1665
- * "name": "In Progress",
1666
- * "self":
1667
- * "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
1668
- * }
1669
- * }
1670
- * },
1671
- * {
1672
- * "fields": {
1673
- * "summary": {
1674
- * "allowedValues": [
1675
- * "red",
1676
- * "blue"
1677
- * ],
1678
- * "defaultValue": "red",
1679
- * "hasDefaultValue": false,
1680
- * "key": "field_key",
1681
- * "name": "My Multi Select",
1682
- * "operations": [
1683
- * "set",
1684
- * "add"
1685
- * ],
1686
- * "required": false,
1687
- * "schema": {
1688
- * "custom":
1689
- * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1690
- * "customId": 10001,
1691
- * "items": "option",
1692
- * "type": "array"
1693
- * }
1694
- * },
1695
- * "colour": {
1696
- * "allowedValues": [
1697
- * "red",
1698
- * "blue"
1699
- * ],
1700
- * "defaultValue": "red",
1701
- * "hasDefaultValue": false,
1702
- * "key": "field_key",
1703
- * "name": "My Multi Select",
1704
- * "operations": [
1705
- * "set",
1706
- * "add"
1707
- * ],
1708
- * "required": false,
1709
- * "schema": {
1710
- * "custom":
1711
- * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1712
- * "customId": 10001,
1713
- * "items": "option",
1714
- * "type": "array"
1715
- * }
1716
- * }
1717
- * },
1718
- * "hasScreen": true,
1719
- * "id": "711",
1720
- * "name": "QA Review",
1721
- * "to": {
1722
- * "description": "The issue is closed.",
1723
- * "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
1724
- * "id": "5",
1725
- * "name": "Closed",
1726
- * "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
1727
- * "statusCategory": {
1728
- * "colorName": "green",
1729
- * "id": 9,
1730
- * "key": "completed",
1731
- * "self":
1732
- * "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
1733
- * }
1734
- * }
1735
- * }
1736
- * ]
1737
- * }
1738
- * @path {GET} /rest/api/3/issue/{issueIdOrKey}/transitions
1739
- * @scopes-current read:jira-work
1740
- * @scopes-beta read:issue.transition:jira, read:status:jira, read:field-configuration:jira
1741
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-get
1742
- */
1743
- getTransitions({ issueIdOrKey, expand, transitionId, skipRemoteOnlyCondition, includeUnavailableTransitions, sortByOpsBarAndStatus, }) {
1744
- return this.getClientInstance()
1745
- .request({
1746
- path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
1747
- method: "GET",
1748
- pathParams: {
1749
- issueIdOrKey,
1750
- },
1751
- query: {
1752
- expand,
1753
- transitionId,
1754
- skipRemoteOnlyCondition,
1755
- includeUnavailableTransitions,
1756
- sortByOpsBarAndStatus,
1757
- },
1758
- })
1759
- .then(this.getClientInstance().responseHandler({
1760
- 200: {
1761
- "application/json": "json",
1762
- },
1763
- }))
1764
- .then(commonHttpClient.castResponse())
1765
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getTransitions.response"))
1766
- .then(commonHttpClient.getBody);
1767
- }
1768
- /**
1769
- * Creates an email notification for an issue and adds it to the mail queue.
1770
- *
1771
- * **[Permissions](#permissions) required:**
1772
- *
1773
- * * *Browse Projects* [project
1774
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1775
- * issue is in.
1776
- * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1777
- * configured, issue-level security permission to view the issue.
1778
- *
1779
- * @returns Returned if the email is queued for sending.
1780
- * @path {POST} /rest/api/3/issue/{issueIdOrKey}/notify
1781
- * @scopes-current write:jira-work
1782
- * @scopes-beta send:notification:jira
1783
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-notify-post
1784
- */
1785
- notify({ issueIdOrKey, notification, }) {
1786
- return this.getClientInstance()
1787
- .request({
1788
- path: "/rest/api/3/issue/{issueIdOrKey}/notify",
1789
- method: "POST",
1790
- pathParams: {
1791
- issueIdOrKey,
1792
- },
1793
- headers: {
1794
- "Content-Type": "application/json",
1795
- },
1796
- body: notification,
1797
- })
1798
- .then(this.getClientInstance().responseHandler({
1799
- 204: {
1800
- "application/json": "json",
1801
- },
1802
- }))
1803
- .then(commonHttpClient.castResponse())
1804
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.notify.response"))
1805
- .then(commonHttpClient.getBody);
1806
- }
1807
- /**
1808
- * Enables admins to unarchive up to 1000 issues in a single request using issue
1809
- * ID/key, returning details of the issue(s) unarchived in the process and the
1810
- * errors encountered, if any.
1811
- *
1812
- * **Note that:**
1813
- *
1814
- * * you can't unarchive subtasks directly, only through their parent issues
1815
- * * you can only unarchive issues from software, service management, and
1816
- * business projects
1817
- *
1818
- * **[Permissions](#permissions) required:** Jira admin or site admin: [global
1819
- * permission](https://confluence.atlassian.com/x/x4dKLg)
1820
- *
1821
- * **License required:** Premium or Enterprise
1822
- *
1823
- * **Signed-in users only:** This API can't be accessed anonymously.
1824
- *
1825
- * @returns Returned if there is at least one valid issue to unarchive in the request. It
1826
- * will return the count of unarchived issues, which also includes the count of
1827
- * the subtasks unarchived, and it will show the detailed errors for those issues
1828
- * which are not unarchived.
1829
- *
1830
- * example: {
1831
- * "errors": {
1832
- * "issueIsSubtask": {
1833
- * "count": 3,
1834
- * "issueIdsOrKeys": [
1835
- * "ST-1",
1836
- * "ST-2",
1837
- * "ST-3"
1838
- * ],
1839
- * "message": "Issue is subtask."
1840
- * },
1841
- * "issuesInArchivedProjects": {
1842
- * "count": 2,
1843
- * "issueIdsOrKeys": [
1844
- * "AR-1",
1845
- * "AR-2"
1846
- * ],
1847
- * "message": "Issue exists in archived project."
1848
- * },
1849
- * "issuesNotFound": {
1850
- * "count": 3,
1851
- * "issueIdsOrKeys": [
1852
- * "PR-1",
1853
- * "PR-2",
1854
- * "PR-3"
1855
- * ],
1856
- * "message": "Issue not found."
1857
- * }
1858
- * },
1859
- * "numberOfIssuesUpdated": 10
1860
- * }
1861
- * @path {PUT} /rest/api/3/issue/unarchive
1862
- * @scopes-current write:jira-work
1863
- * @scopes-beta write:issue:jira
1864
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-unarchive-put
1865
- */
1866
- unarchiveIssues({ issueArchivalSyncRequest, }) {
1867
- return this.getClientInstance()
1868
- .request({
1869
- path: "/rest/api/3/issue/unarchive",
1870
- method: "PUT",
1871
- headers: {
1872
- "Content-Type": "application/json",
1873
- },
1874
- body: issueArchivalSyncRequest,
1875
- })
1876
- .then(this.getClientInstance().responseHandler({
1877
- 200: {
1878
- "application/json": "json",
1879
- },
1880
- }))
1881
- .then(commonHttpClient.castResponse())
1882
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.unarchiveIssues.response"))
1883
- .then(commonHttpClient.getBody);
31
+ constructor() {
32
+ super(...arguments);
33
+ /**
34
+ * Enables admins to archive up to 1000 issues in a single request using issue
35
+ * ID/key, returning details of the issue(s) archived in the process and the
36
+ * errors encountered, if any.
37
+ *
38
+ * **Note that:**
39
+ *
40
+ * * you can't archive subtasks directly, only through their parent issues
41
+ * * you can only archive issues from software, service management, and business
42
+ * projects
43
+ *
44
+ * **[Permissions](#permissions) required:** Jira admin or site admin: [global
45
+ * permission](https://confluence.atlassian.com/x/x4dKLg)
46
+ *
47
+ * **License required:** Premium or Enterprise
48
+ *
49
+ * **Signed-in users only:** This API can't be accessed anonymously.
50
+ *
51
+ * @returns Returned if there is at least one valid issue to archive in the request. The
52
+ * return message will include the count of archived issues and subtasks, as well
53
+ * as error details for issues which failed to get archived.
54
+ *
55
+ * example: {
56
+ * "errors": {
57
+ * "issueIsSubtask": {
58
+ * "count": 3,
59
+ * "issueIdsOrKeys": [
60
+ * "ST-1",
61
+ * "ST-2",
62
+ * "ST-3"
63
+ * ],
64
+ * "message": "Issue is subtask."
65
+ * },
66
+ * "issuesInArchivedProjects": {
67
+ * "count": 2,
68
+ * "issueIdsOrKeys": [
69
+ * "AR-1",
70
+ * "AR-2"
71
+ * ],
72
+ * "message": "Issue exists in archived project."
73
+ * },
74
+ * "issuesInUnlicensedProjects": {
75
+ * "count": 3,
76
+ * "issueIdsOrKeys": [
77
+ * "UL-1",
78
+ * "UL-2",
79
+ * "UL-3"
80
+ * ],
81
+ * "message": "Issues with these IDs are in unlicensed projects."
82
+ * },
83
+ * "issuesNotFound": {
84
+ * "count": 3,
85
+ * "issueIdsOrKeys": [
86
+ * "PR-1",
87
+ * "PR-2",
88
+ * "PR-3"
89
+ * ],
90
+ * "message": "Issue not found."
91
+ * }
92
+ * },
93
+ * "numberOfIssuesUpdated": 10
94
+ * }
95
+ * @path {PUT} /rest/api/3/issue/archive
96
+ * @scopes-current write:jira-work
97
+ * @scopes-beta write:issue:jira
98
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-put
99
+ */
100
+ this.archiveIssues = ({ issueArchivalSyncRequest, }) => {
101
+ return this.getClientInstance()
102
+ .request({
103
+ path: "/rest/api/3/issue/archive",
104
+ method: "PUT",
105
+ headers: {
106
+ "Content-Type": "application/json",
107
+ },
108
+ body: issueArchivalSyncRequest,
109
+ })
110
+ .then(this.getClientInstance().responseHandler({
111
+ 200: {
112
+ "application/json": "json",
113
+ },
114
+ }))
115
+ .then(commonHttpClient.castResponse())
116
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.archiveIssues.response"))
117
+ .then(commonHttpClient.getBody);
118
+ };
119
+ /**
120
+ * Enables admins to archive up to 100,000 issues in a single request using JQL,
121
+ * returning the URL to check the status of the submitted request.
122
+ *
123
+ * You can use the [get
124
+ * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
125
+ * and [cancel
126
+ * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post)
127
+ * APIs to manage the request.
128
+ *
129
+ * **Note that:**
130
+ *
131
+ * * you can't archive subtasks directly, only through their parent issues
132
+ * * you can only archive issues from software, service management, and business
133
+ * projects
134
+ *
135
+ * **[Permissions](#permissions) required:** Jira admin or site admin: [global
136
+ * permission](https://confluence.atlassian.com/x/x4dKLg)
137
+ *
138
+ * **License required:** Premium or Enterprise
139
+ *
140
+ * **Signed-in users only:** This API can't be accessed anonymously.
141
+ *
142
+ * **Rate limiting:** Only a single request per jira instance can be active at any
143
+ * given time.
144
+ *
145
+ * @returns Returns the URL to check the status of the submitted request.
146
+ *
147
+ * example: "https://your-domain.atlassian.net/rest/api/3/task/1010"
148
+ * @path {POST} /rest/api/3/issue/archive
149
+ * @scopes-current write:jira-work
150
+ * @scopes-beta write:issue:jira
151
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-archive-post
152
+ */
153
+ this.archiveIssuesAsync = ({ archiveIssueAsyncRequest, }) => {
154
+ return this.getClientInstance()
155
+ .request({
156
+ path: "/rest/api/3/issue/archive",
157
+ method: "POST",
158
+ headers: {
159
+ "Content-Type": "application/json",
160
+ },
161
+ body: archiveIssueAsyncRequest,
162
+ })
163
+ .then(this.getClientInstance().responseHandler({
164
+ 202: {
165
+ "application/json": "json",
166
+ },
167
+ }))
168
+ .then(commonHttpClient.castResponse())
169
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.archiveIssuesAsync.response"))
170
+ .then(commonHttpClient.getBody);
171
+ };
172
+ /**
173
+ * Assigns an issue to a user. Use this operation when the calling user does not
174
+ * have the *Edit Issues* permission but has the *Assign issue* permission for the
175
+ * project that the issue is in.
176
+ *
177
+ * If `name` or `accountId` is set to:
178
+ *
179
+ * * `"-1"`, the issue is assigned to the default assignee for the project.
180
+ * * `null`, the issue is set to unassigned.
181
+ *
182
+ * This operation can be accessed anonymously.
183
+ *
184
+ * **[Permissions](#permissions) required:**
185
+ *
186
+ * * *Browse Projects* and *Assign Issues* [ project
187
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
188
+ * issue is in.
189
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
190
+ * configured, issue-level security permission to view the issue.
191
+ *
192
+ * @returns Returned if the request is successful.
193
+ * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/assignee
194
+ * @scopes-current write:jira-work
195
+ * @scopes-beta write:issue:jira
196
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-assignee-put
197
+ */
198
+ this.assignIssue = ({ issueIdOrKey, user, }) => {
199
+ return this.getClientInstance()
200
+ .request({
201
+ path: "/rest/api/3/issue/{issueIdOrKey}/assignee",
202
+ method: "PUT",
203
+ pathParams: {
204
+ issueIdOrKey,
205
+ },
206
+ headers: {
207
+ "Content-Type": "application/json",
208
+ },
209
+ body: user,
210
+ })
211
+ .then(this.getClientInstance().responseHandler({
212
+ 204: {
213
+ "application/json": "json",
214
+ },
215
+ }))
216
+ .then(commonHttpClient.castResponse())
217
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.assignIssue.response"))
218
+ .then(commonHttpClient.getBody);
219
+ };
220
+ /**
221
+ * Creates an issue or, where the option to create subtasks is enabled in Jira, a
222
+ * subtask. A transition may be applied, to move the issue or subtask to a
223
+ * workflow step other than the default start step, and issue properties set.
224
+ *
225
+ * The content of the issue or subtask is defined using `update` and `fields`. The
226
+ * fields that can be set in the issue or subtask are determined using the [ Get
227
+ * create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
228
+ * same fields that appear on the issue's create screen. Note that the
229
+ * `description`, `environment`, and any `textarea` type custom fields (multi-line
230
+ * text fields) take Atlassian Document Format content. Single line custom fields
231
+ * (`textfield`) accept a string and don't handle Atlassian Document Format
232
+ * content.
233
+ *
234
+ * Creating a subtask differs from creating an issue as follows:
235
+ *
236
+ * * `issueType` must be set to a subtask issue type (use [ Get create issue
237
+ * metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
238
+ * * `parent` must contain the ID or key of the parent issue.
239
+ *
240
+ * In a next-gen project any issue may be made a child providing that the parent
241
+ * and child are members of the same project.
242
+ *
243
+ * **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
244
+ * [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
245
+ * project in which the issue or subtask is created.
246
+ *
247
+ * @returns Returned if the request is successful.
248
+ *
249
+ * example: {
250
+ * "id": "10000",
251
+ * "key": "ED-24",
252
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
253
+ * "transition": {
254
+ * "status": 200,
255
+ * "errorCollection": {
256
+ * "errorMessages": [],
257
+ * "errors": {}
258
+ * }
259
+ * }
260
+ * }
261
+ * @path {POST} /rest/api/3/issue
262
+ * @scopes-current write:jira-work
263
+ * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
264
+ * write:attachment:jira, read:issue:jira
265
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-post
266
+ */
267
+ this.createIssue = ({ updateHistory, issueUpdateDetails, }) => {
268
+ return this.getClientInstance()
269
+ .request({
270
+ path: "/rest/api/3/issue",
271
+ method: "POST",
272
+ query: {
273
+ updateHistory,
274
+ },
275
+ headers: {
276
+ "Content-Type": "application/json",
277
+ },
278
+ body: issueUpdateDetails,
279
+ })
280
+ .then(this.getClientInstance().responseHandler({
281
+ 201: {
282
+ "application/json": "json",
283
+ },
284
+ }))
285
+ .then(commonHttpClient.castResponse())
286
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.createIssue.response"))
287
+ .then(commonHttpClient.getBody);
288
+ };
289
+ /**
290
+ * Creates upto **50** issues and, where the option to create subtasks is enabled
291
+ * in Jira, subtasks. Transitions may be applied, to move the issues or subtasks
292
+ * to a workflow step other than the default start step, and issue properties set.
293
+ *
294
+ * The content of each issue or subtask is defined using `update` and `fields`.
295
+ * The fields that can be set in the issue or subtask are determined using the [
296
+ * Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
297
+ * same fields that appear on the issues' create screens. Note that the
298
+ * `description`, `environment`, and any `textarea` type custom fields (multi-line
299
+ * text fields) take Atlassian Document Format content. Single line custom fields
300
+ * (`textfield`) accept a string and don't handle Atlassian Document Format
301
+ * content.
302
+ *
303
+ * Creating a subtask differs from creating an issue as follows:
304
+ *
305
+ * * `issueType` must be set to a subtask issue type (use [ Get create issue
306
+ * metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
307
+ * * `parent` the must contain the ID or key of the parent issue.
308
+ *
309
+ * **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
310
+ * [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
311
+ * project in which each issue or subtask is created.
312
+ *
313
+ * @returns Returned if any of the issue or subtask creation requests were successful. A
314
+ * request may be unsuccessful when it:
315
+ *
316
+ * * is missing required fields.
317
+ * * contains invalid field values.
318
+ * * contains fields that cannot be set for the issue type.
319
+ * * is by a user who does not have the necessary permission.
320
+ * * is to create a subtype in a project different that of the parent issue.
321
+ * * is for a subtask when the option to create subtasks is disabled.
322
+ * * is invalid for any other reason.
323
+ *
324
+ * example: {
325
+ * "issues": [
326
+ * {
327
+ * "id": "10000",
328
+ * "key": "ED-24",
329
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
330
+ * "transition": {
331
+ * "status": 200,
332
+ * "errorCollection": {
333
+ * "errorMessages": [],
334
+ * "errors": {}
335
+ * }
336
+ * }
337
+ * },
338
+ * {
339
+ * "id": "10001",
340
+ * "key": "ED-25",
341
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
342
+ * }
343
+ * ],
344
+ * "errors": []
345
+ * }
346
+ * @path {POST} /rest/api/3/issue/bulk
347
+ * @scopes-current write:jira-work
348
+ * @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
349
+ * write:attachment:jira, read:issue:jira
350
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-bulk-post
351
+ */
352
+ this.createIssues = ({ issuesUpdateBean, }) => {
353
+ return this.getClientInstance()
354
+ .request({
355
+ path: "/rest/api/3/issue/bulk",
356
+ method: "POST",
357
+ headers: {
358
+ "Content-Type": "application/json",
359
+ },
360
+ body: issuesUpdateBean,
361
+ })
362
+ .then(this.getClientInstance().responseHandler({
363
+ 201: {
364
+ "application/json": "json",
365
+ },
366
+ }))
367
+ .then(commonHttpClient.castResponse())
368
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.createIssues.response"))
369
+ .then(commonHttpClient.getBody);
370
+ };
371
+ /**
372
+ * Deletes an issue.
373
+ *
374
+ * An issue cannot be deleted if it has one or more subtasks. To delete an issue
375
+ * with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be
376
+ * deleted with the issue.
377
+ *
378
+ * This operation can be accessed anonymously.
379
+ *
380
+ * **[Permissions](#permissions) required:**
381
+ *
382
+ * * *Browse projects* and *Delete issues* [project
383
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project
384
+ * containing the issue.
385
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
386
+ * configured, issue-level security permission to view the issue.
387
+ *
388
+ * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}
389
+ * @scopes-current write:jira-work
390
+ * @scopes-beta delete:issue:jira
391
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-delete
392
+ */
393
+ this.deleteIssue = ({ issueIdOrKey, deleteSubtasks, }) => {
394
+ return this.getClientInstance()
395
+ .request({
396
+ path: "/rest/api/3/issue/{issueIdOrKey}",
397
+ method: "DELETE",
398
+ pathParams: {
399
+ issueIdOrKey,
400
+ },
401
+ query: {
402
+ deleteSubtasks,
403
+ },
404
+ })
405
+ .then(commonHttpClient.discardResult);
406
+ };
407
+ /**
408
+ * Performs an issue transition and, if the transition has a screen, updates the
409
+ * fields from the transition screen.
410
+ *
411
+ * sortByCategory To update the fields on the transition screen, specify the
412
+ * fields in the `fields` or `update` parameters in the request body. Get details
413
+ * about the fields using [ Get
414
+ * transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the
415
+ * `transitions.fields` expand.
416
+ *
417
+ * This operation can be accessed anonymously.
418
+ *
419
+ * **[Permissions](#permissions) required:**
420
+ *
421
+ * * *Browse projects* and *Transition issues* [project
422
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
423
+ * issue is in.
424
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
425
+ * configured, issue-level security permission to view the issue.
426
+ *
427
+ * @returns Returned if the request is successful.
428
+ * @path {POST} /rest/api/3/issue/{issueIdOrKey}/transitions
429
+ * @scopes-current write:jira-work
430
+ * @scopes-beta write:issue:jira, write:issue.property:jira
431
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-post
432
+ */
433
+ this.doTransition = ({ issueIdOrKey, issueUpdateDetails, }) => {
434
+ return this.getClientInstance()
435
+ .request({
436
+ path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
437
+ method: "POST",
438
+ pathParams: {
439
+ issueIdOrKey,
440
+ },
441
+ headers: {
442
+ "Content-Type": "application/json",
443
+ },
444
+ body: issueUpdateDetails,
445
+ })
446
+ .then(this.getClientInstance().responseHandler({
447
+ 204: {
448
+ "application/json": "json",
449
+ },
450
+ }))
451
+ .then(commonHttpClient.castResponse())
452
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.doTransition.response"))
453
+ .then(commonHttpClient.getBody);
454
+ };
455
+ /**
456
+ * Edits an issue. Issue properties may be updated as part of the edit. Please
457
+ * note that issue transition will be ignored as it is not supported yet.
458
+ *
459
+ * The edits to the issue's fields are defined using `update` and `fields`. The
460
+ * fields that can be edited are determined using [ Get edit issue
461
+ * metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
462
+ *
463
+ * The parent field may be set by key or ID. For standard issue types, the parent
464
+ * may be removed by setting `update.parent.set.none` to *true*. Note that the
465
+ * `description`, `environment`, and any `textarea` type custom fields (multi-line
466
+ * text fields) take Atlassian Document Format content. Single line custom fields
467
+ * (`textfield`) accept a string and don't handle Atlassian Document Format
468
+ * content.
469
+ *
470
+ * Connect apps having an app user with *Administer Jira* [global
471
+ * permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
472
+ * on behalf of users with *Administer Jira* [global
473
+ * permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen
474
+ * security configuration using `overrideScreenSecurity` and
475
+ * `overrideEditableFlag`.
476
+ *
477
+ * This operation can be accessed anonymously.
478
+ *
479
+ * **[Permissions](#permissions) required:**
480
+ *
481
+ * * *Browse projects* and *Edit issues* [project
482
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
483
+ * issue is in.
484
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
485
+ * configured, issue-level security permission to view the issue.
486
+ *
487
+ * @returns * status: 200, mediaType: application/json
488
+ *
489
+ * Returned if the request is successful and the `returnIssue` parameter is
490
+ * `true`
491
+ *
492
+ * * status: 204, mediaType: application/json
493
+ *
494
+ * Returned if the request is successful.
495
+ * @path {PUT} /rest/api/3/issue/{issueIdOrKey}
496
+ * @scopes-current write:jira-work
497
+ * @scopes-beta write:issue:jira
498
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-put
499
+ */
500
+ this.editIssue = ({ issueIdOrKey, notifyUsers, overrideScreenSecurity, overrideEditableFlag, returnIssue, expand, issueUpdateDetails, }) => {
501
+ return this.getClientInstance()
502
+ .request({
503
+ path: "/rest/api/3/issue/{issueIdOrKey}",
504
+ method: "PUT",
505
+ pathParams: {
506
+ issueIdOrKey,
507
+ },
508
+ query: {
509
+ notifyUsers,
510
+ overrideScreenSecurity,
511
+ overrideEditableFlag,
512
+ returnIssue,
513
+ expand,
514
+ },
515
+ headers: {
516
+ "Content-Type": "application/json",
517
+ },
518
+ body: issueUpdateDetails,
519
+ })
520
+ .then(this.getClientInstance().responseHandler({
521
+ 200: {
522
+ "application/json": "json",
523
+ },
524
+ 204: {
525
+ "application/json": "json",
526
+ },
527
+ }))
528
+ .then(commonHttpClient.castResponse())
529
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.editIssue.response"));
530
+ };
531
+ /**
532
+ * Enables admins to retrieve details of all archived issues. Upon a successful
533
+ * request, the admin who submitted it will receive an email with a link to
534
+ * download a CSV file with the issue details.
535
+ *
536
+ * Note that this API only exports the values of system fields and
537
+ * archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields
538
+ * aren't supported.
539
+ *
540
+ * **[Permissions](#permissions) required:** Jira admin or site admin: [global
541
+ * permission](https://confluence.atlassian.com/x/x4dKLg)
542
+ *
543
+ * **License required:** Premium or Enterprise
544
+ *
545
+ * **Signed-in users only:** This API can't be accessed anonymously.
546
+ *
547
+ * **Rate limiting:** Only a single request can be active at any given time.
548
+ *
549
+ * @returns Returns the details of your export task. You can use the [get
550
+ * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
551
+ * API to view the progress of your request.
552
+ *
553
+ * example: {
554
+ * "payload": "{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002],
555
+ * issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01,
556
+ * dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}",
557
+ * "progress": 0,
558
+ * "status": "ENQUEUED",
559
+ * "submittedTime": 1623230887000,
560
+ * "taskId": "10990"
561
+ * }
562
+ * @path {PUT} /rest/api/3/issues/archive/export
563
+ * @scopes-current read:jira-work
564
+ * @scopes-beta read:issue:jira
565
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issues-archive-export-put
566
+ */
567
+ this.exportArchivedIssues = ({ archivedIssuesFilterRequest, }) => {
568
+ return this.getClientInstance()
569
+ .request({
570
+ path: "/rest/api/3/issues/archive/export",
571
+ method: "PUT",
572
+ headers: {
573
+ "Content-Type": "application/json",
574
+ },
575
+ body: archivedIssuesFilterRequest,
576
+ })
577
+ .then(this.getClientInstance().responseHandler({
578
+ 202: {
579
+ "application/json": "json",
580
+ },
581
+ }))
582
+ .then(commonHttpClient.castResponse())
583
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.exportArchivedIssues.response"))
584
+ .then(commonHttpClient.getBody);
585
+ };
586
+ /**
587
+ * Returns a [paginated](#pagination) list of all changelogs for an issue sorted
588
+ * by date, starting from the oldest.
589
+ *
590
+ * This operation can be accessed anonymously.
591
+ *
592
+ * **[Permissions](#permissions) required:**
593
+ *
594
+ * * *Browse projects* [project
595
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
596
+ * issue is in.
597
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
598
+ * configured, issue-level security permission to view the issue.
599
+ *
600
+ * @returns Returned if the request is successful.
601
+ *
602
+ * example: {
603
+ * "isLast": false,
604
+ * "maxResults": 2,
605
+ * "nextPage":
606
+ * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2",
607
+ * "self":
608
+ * "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2",
609
+ * "startAt": 2,
610
+ * "total": 5,
611
+ * "values": [
612
+ * {
613
+ * "author": {
614
+ * "accountId": "5b10a2844c20165700ede21g",
615
+ * "active": true,
616
+ * "avatarUrls": {
617
+ * "16x16":
618
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
619
+ * "24x24":
620
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
621
+ * "32x32":
622
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
623
+ * "48x48":
624
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
625
+ * },
626
+ * "displayName": "Mia Krystof",
627
+ * "emailAddress": "mia@example.com",
628
+ * "self":
629
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
630
+ * "timeZone": "Australia/Sydney"
631
+ * },
632
+ * "created": "1970-01-18T06:27:50.429+0000",
633
+ * "id": "10001",
634
+ * "items": [
635
+ * {
636
+ * "field": "fields",
637
+ * "fieldtype": "jira",
638
+ * "fieldId": "fieldId",
639
+ * "from": null,
640
+ * "fromString": "",
641
+ * "to": null,
642
+ * "toString": "label-1"
643
+ * }
644
+ * ]
645
+ * },
646
+ * {
647
+ * "author": {
648
+ * "accountId": "5b10a2844c20165700ede21g",
649
+ * "active": true,
650
+ * "avatarUrls": {
651
+ * "16x16":
652
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
653
+ * "24x24":
654
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
655
+ * "32x32":
656
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
657
+ * "48x48":
658
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
659
+ * },
660
+ * "displayName": "Mia Krystof",
661
+ * "emailAddress": "mia@example.com",
662
+ * "self":
663
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
664
+ * "timeZone": "Australia/Sydney"
665
+ * },
666
+ * "created": "1970-01-18T06:27:51.429+0000",
667
+ * "id": "10002",
668
+ * "items": [
669
+ * {
670
+ * "field": "fields",
671
+ * "fieldtype": "jira",
672
+ * "fieldId": "fieldId",
673
+ * "from": null,
674
+ * "fromString": "label-1",
675
+ * "to": null,
676
+ * "toString": "label-1 label-2"
677
+ * }
678
+ * ]
679
+ * }
680
+ * ]
681
+ * }
682
+ * @path {GET} /rest/api/3/issue/{issueIdOrKey}/changelog
683
+ * @scopes-current read:jira-work
684
+ * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
685
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-get
686
+ */
687
+ this.getChangeLogs = ({ issueIdOrKey, startAt, maxResults, }) => {
688
+ return this.getClientInstance()
689
+ .request({
690
+ path: "/rest/api/3/issue/{issueIdOrKey}/changelog",
691
+ method: "GET",
692
+ pathParams: {
693
+ issueIdOrKey,
694
+ },
695
+ query: {
696
+ startAt,
697
+ maxResults,
698
+ },
699
+ })
700
+ .then(this.getClientInstance().responseHandler({
701
+ 200: {
702
+ "application/json": "json",
703
+ },
704
+ }))
705
+ .then(commonHttpClient.castResponse())
706
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getChangeLogs.response"))
707
+ .then(commonHttpClient.getBody);
708
+ };
709
+ /**
710
+ * Returns changelogs for an issue specified by a list of changelog IDs.
711
+ *
712
+ * This operation can be accessed anonymously.
713
+ *
714
+ * **[Permissions](#permissions) required:**
715
+ *
716
+ * * *Browse projects* [project
717
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
718
+ * issue is in.
719
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
720
+ * configured, issue-level security permission to view the issue.
721
+ *
722
+ * @returns Returned if the request is successful.
723
+ *
724
+ * example: {
725
+ * "histories": [
726
+ * {
727
+ * "author": {
728
+ * "accountId": "5b10a2844c20165700ede21g",
729
+ * "active": true,
730
+ * "avatarUrls": {
731
+ * "16x16":
732
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
733
+ * "24x24":
734
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
735
+ * "32x32":
736
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
737
+ * "48x48":
738
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
739
+ * },
740
+ * "displayName": "Mia Krystof",
741
+ * "emailAddress": "mia@example.com",
742
+ * "self":
743
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
744
+ * "timeZone": "Australia/Sydney"
745
+ * },
746
+ * "created": "1970-01-18T06:27:50.429+0000",
747
+ * "id": "10001",
748
+ * "items": [
749
+ * {
750
+ * "field": "fields",
751
+ * "fieldtype": "jira",
752
+ * "fieldId": "fieldId",
753
+ * "from": null,
754
+ * "fromString": "",
755
+ * "to": null,
756
+ * "toString": "label-1"
757
+ * }
758
+ * ]
759
+ * },
760
+ * {
761
+ * "author": {
762
+ * "accountId": "5b10a2844c20165700ede21g",
763
+ * "active": true,
764
+ * "avatarUrls": {
765
+ * "16x16":
766
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
767
+ * "24x24":
768
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
769
+ * "32x32":
770
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
771
+ * "48x48":
772
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
773
+ * },
774
+ * "displayName": "Mia Krystof",
775
+ * "emailAddress": "mia@example.com",
776
+ * "self":
777
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
778
+ * "timeZone": "Australia/Sydney"
779
+ * },
780
+ * "created": "1970-01-18T06:27:51.429+0000",
781
+ * "id": "10002",
782
+ * "items": [
783
+ * {
784
+ * "field": "fields",
785
+ * "fieldtype": "jira",
786
+ * "fieldId": "fieldId",
787
+ * "from": null,
788
+ * "fromString": "label-1",
789
+ * "to": null,
790
+ * "toString": "label-1 label-2"
791
+ * }
792
+ * ]
793
+ * }
794
+ * ],
795
+ * "maxResults": 2,
796
+ * "startAt": 0,
797
+ * "total": 2
798
+ * }
799
+ * @path {POST} /rest/api/3/issue/{issueIdOrKey}/changelog/list
800
+ * @scopes-current read:jira-work
801
+ * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
802
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-changelog-list-post
803
+ */
804
+ this.getChangeLogsByIds = ({ issueIdOrKey, issueChangelogIds, }) => {
805
+ return this.getClientInstance()
806
+ .request({
807
+ path: "/rest/api/3/issue/{issueIdOrKey}/changelog/list",
808
+ method: "POST",
809
+ pathParams: {
810
+ issueIdOrKey,
811
+ },
812
+ headers: {
813
+ "Content-Type": "application/json",
814
+ },
815
+ body: issueChangelogIds,
816
+ })
817
+ .then(this.getClientInstance().responseHandler({
818
+ 200: {
819
+ "application/json": "json",
820
+ },
821
+ }))
822
+ .then(commonHttpClient.castResponse())
823
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getChangeLogsByIds.response"))
824
+ .then(commonHttpClient.getBody);
825
+ };
826
+ /**
827
+ * Returns details of projects, issue types within projects, and, when requested,
828
+ * the create screen fields for each issue type for the user. Use the information
829
+ * to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and
830
+ * [Create issues](#api-rest-api-3-issue-bulk-post).
831
+ *
832
+ * Deprecated, see [Create Issue Meta Endpoint Deprecation
833
+ * Notice](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1304).
834
+ *
835
+ * The request can be restricted to specific projects or issue types using the
836
+ * query parameters. The response will contain information for the valid projects,
837
+ * issue types, or project and issue type combinations requested. Note that
838
+ * invalid project, issue type, or project and issue type combinations do not
839
+ * generate errors.
840
+ *
841
+ * This operation can be accessed anonymously.
842
+ *
843
+ * **[Permissions](#permissions) required:** *Create issues* [project
844
+ * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
845
+ * projects.
846
+ *
847
+ * @deprecated
848
+ * @returns Returned if the request is successful.
849
+ *
850
+ * example: {
851
+ * "projects": [
852
+ * {
853
+ * "avatarUrls": {
854
+ * "16x16":
855
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
856
+ * "24x24":
857
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
858
+ * "32x32":
859
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
860
+ * "48x48":
861
+ * "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
862
+ * },
863
+ * "id": "10000",
864
+ * "issuetypes": [
865
+ * {
866
+ * "description": "An error in the code",
867
+ * "fields": {
868
+ * "issuetype": {
869
+ * "allowedValues": [
870
+ * "set"
871
+ * ],
872
+ * "autoCompleteUrl": "issuetype",
873
+ * "hasDefaultValue": false,
874
+ * "key": "issuetype",
875
+ * "name": "Issue Type",
876
+ * "required": true
877
+ * }
878
+ * },
879
+ * "iconUrl":
880
+ * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
881
+ * "id": "1",
882
+ * "name": "Bug",
883
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
884
+ * "subtask": false
885
+ * }
886
+ * ],
887
+ * "key": "ED",
888
+ * "name": "Edison Project",
889
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/ED"
890
+ * }
891
+ * ]
892
+ * }
893
+ * @path {GET} /rest/api/3/issue/createmeta
894
+ * @scopes-current read:jira-work
895
+ * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
896
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-get
897
+ */
898
+ this.getCreateIssueMeta = ({ projectIds, projectKeys, issuetypeIds, issuetypeNames, expand, } = {}) => {
899
+ return this.getClientInstance()
900
+ .request({
901
+ path: "/rest/api/3/issue/createmeta",
902
+ method: "GET",
903
+ query: {
904
+ projectIds,
905
+ projectKeys,
906
+ issuetypeIds,
907
+ issuetypeNames,
908
+ expand,
909
+ },
910
+ })
911
+ .then(this.getClientInstance().responseHandler({
912
+ 200: {
913
+ "application/json": "json",
914
+ },
915
+ }))
916
+ .then(commonHttpClient.castResponse())
917
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMeta.response"))
918
+ .then(commonHttpClient.getBody);
919
+ };
920
+ /**
921
+ * Returns a page of field metadata for a specified project and issuetype id. Use
922
+ * the information to populate the requests in [ Create
923
+ * issue](#api-rest-api-3-issue-post) and [Create
924
+ * issues](#api-rest-api-3-issue-bulk-post).
925
+ *
926
+ * This operation can be accessed anonymously.
927
+ *
928
+ * **[Permissions](#permissions) required:** *Create issues* [project
929
+ * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
930
+ * projects.
931
+ *
932
+ * @returns Returned if the request is successful.
933
+ *
934
+ * example: {
935
+ * "fields": [
936
+ * {
937
+ * "fieldId": "assignee",
938
+ * "hasDefaultValue": false,
939
+ * "key": "assignee",
940
+ * "name": "Assignee",
941
+ * "operations": [
942
+ * "set"
943
+ * ],
944
+ * "required": true
945
+ * }
946
+ * ],
947
+ * "maxResults": 1,
948
+ * "startAt": 0,
949
+ * "total": 1
950
+ * }
951
+ * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
952
+ * @scopes-current read:jira-work
953
+ * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
954
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-issuetypeid-get
955
+ */
956
+ this.getCreateIssueMetaIssueTypeId = ({ projectIdOrKey, issueTypeId, startAt, maxResults, }) => {
957
+ return this.getClientInstance()
958
+ .request({
959
+ path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}",
960
+ method: "GET",
961
+ pathParams: {
962
+ projectIdOrKey,
963
+ issueTypeId,
964
+ },
965
+ query: {
966
+ startAt,
967
+ maxResults,
968
+ },
969
+ })
970
+ .then(this.getClientInstance().responseHandler({
971
+ 200: {
972
+ "application/json": "json",
973
+ },
974
+ }))
975
+ .then(commonHttpClient.castResponse())
976
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMetaIssueTypeId.response"))
977
+ .then(commonHttpClient.getBody);
978
+ };
979
+ /**
980
+ * Returns a page of issue type metadata for a specified project. Use the
981
+ * information to populate the requests in [ Create
982
+ * issue](#api-rest-api-3-issue-post) and [Create
983
+ * issues](#api-rest-api-3-issue-bulk-post).
984
+ *
985
+ * This operation can be accessed anonymously.
986
+ *
987
+ * **[Permissions](#permissions) required:** *Create issues* [project
988
+ * permission](https://confluence.atlassian.com/x/yodKLg) in the requested
989
+ * projects.
990
+ *
991
+ * @returns Returned if the request is successful.
992
+ *
993
+ * example: {
994
+ * "issueTypes": [
995
+ * {
996
+ * "description": "An error in the code",
997
+ * "iconUrl":
998
+ * "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
999
+ * "id": "1",
1000
+ * "name": "Bug",
1001
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1002
+ * "subtask": false
1003
+ * }
1004
+ * ],
1005
+ * "maxResults": 1,
1006
+ * "startAt": 0,
1007
+ * "total": 1
1008
+ * }
1009
+ * @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
1010
+ * @scopes-current read:jira-work
1011
+ * @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
1012
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-createmeta-projectidorkey-issuetypes-get
1013
+ */
1014
+ this.getCreateIssueMetaIssueTypes = ({ projectIdOrKey, startAt, maxResults, }) => {
1015
+ return this.getClientInstance()
1016
+ .request({
1017
+ path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes",
1018
+ method: "GET",
1019
+ pathParams: {
1020
+ projectIdOrKey,
1021
+ },
1022
+ query: {
1023
+ startAt,
1024
+ maxResults,
1025
+ },
1026
+ })
1027
+ .then(this.getClientInstance().responseHandler({
1028
+ 200: {
1029
+ "application/json": "json",
1030
+ },
1031
+ }))
1032
+ .then(commonHttpClient.castResponse())
1033
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getCreateIssueMetaIssueTypes.response"))
1034
+ .then(commonHttpClient.getBody);
1035
+ };
1036
+ /**
1037
+ * Returns the edit screen fields for an issue that are visible to and editable by
1038
+ * the user. Use the information to populate the requests in [Edit
1039
+ * issue](#api-rest-api-3-issue-issueIdOrKey-put).
1040
+ *
1041
+ * This endpoint will check for these conditions:
1042
+ *
1043
+ * 1. Field is available on a field screen - through screen, screen scheme, issue
1044
+ * type screen scheme, and issue type scheme configuration.
1045
+ * `overrideScreenSecurity=true` skips this condition.
1046
+ * 2. Field is visible in the [field
1047
+ * configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/).
1048
+ * `overrideScreenSecurity=true` skips this condition.
1049
+ * 3. Field is shown on the issue: each field has different conditions here. For
1050
+ * example: Attachment field only shows if attachments are enabled. Assignee only
1051
+ * shows if user has permissions to assign the issue.
1052
+ * 4. If a field is custom then it must have valid custom field context,
1053
+ * applicable for its project and issue type. All system fields are assumed to
1054
+ * have context in all projects and all issue types.
1055
+ * 5. Issue has a project, issue type, and status defined.
1056
+ * 6. Issue is assigned to a valid workflow, and the current status has assigned
1057
+ * a workflow step. `overrideEditableFlag=true` skips this condition.
1058
+ * 7. The current workflow step is editable. This is true by default, but [can be
1059
+ * disabled by
1060
+ * setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
1061
+ * the `jira.issue.editable` property to `false`. `overrideEditableFlag=true`
1062
+ * skips this condition.
1063
+ * 8. User has [Edit issues
1064
+ * permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).
1065
+ * 9. Workflow permissions allow editing a field. This is true by default but
1066
+ * [can be
1067
+ * modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
1068
+ * using `jira.permission.*` workflow properties.
1069
+ *
1070
+ * Fields hidden using [Issue layout settings
1071
+ * page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/)
1072
+ * remain editable.
1073
+ *
1074
+ * Connect apps having an app user with *Administer Jira* [global
1075
+ * permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
1076
+ * on behalf of users with *Administer Jira* [global
1077
+ * permission](https://confluence.atlassian.com/x/x4dKLg), can return additional
1078
+ * details using:
1079
+ *
1080
+ * * `overrideScreenSecurity` When this flag is `true`, then this endpoint skips
1081
+ * checking if fields are available through screens, and field configuration
1082
+ * (conditions 1. and 2. from the list above).
1083
+ * * `overrideEditableFlag` When this flag is `true`, then this endpoint skips
1084
+ * checking if workflow is present and if the current step is editable (conditions
1085
+ * 6. and 7. from the list above).
1086
+ *
1087
+ * This operation can be accessed anonymously.
1088
+ *
1089
+ * **[Permissions](#permissions) required:**
1090
+ *
1091
+ * * *Browse projects* [project
1092
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1093
+ * issue is in.
1094
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1095
+ * configured, issue-level security permission to view the issue.
1096
+ *
1097
+ * Note: For any fields to be editable the user must have the *Edit issues*
1098
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
1099
+ *
1100
+ * @returns Returned if the request is successful.
1101
+ *
1102
+ * example: {
1103
+ * "fields": {
1104
+ * "summary": {
1105
+ * "allowedValues": [
1106
+ * "red",
1107
+ * "blue"
1108
+ * ],
1109
+ * "defaultValue": "red",
1110
+ * "hasDefaultValue": false,
1111
+ * "key": "field_key",
1112
+ * "name": "My Multi Select",
1113
+ * "operations": [
1114
+ * "set",
1115
+ * "add"
1116
+ * ],
1117
+ * "required": false,
1118
+ * "schema": {
1119
+ * "custom":
1120
+ * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1121
+ * "customId": 10001,
1122
+ * "items": "option",
1123
+ * "type": "array"
1124
+ * }
1125
+ * }
1126
+ * }
1127
+ * }
1128
+ * @path {GET} /rest/api/3/issue/{issueIdOrKey}/editmeta
1129
+ * @scopes-current read:jira-work
1130
+ * @scopes-beta read:issue-meta:jira, read:field-configuration:jira
1131
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-editmeta-get
1132
+ */
1133
+ this.getEditIssueMeta = ({ issueIdOrKey, overrideScreenSecurity, overrideEditableFlag, }) => {
1134
+ return this.getClientInstance()
1135
+ .request({
1136
+ path: "/rest/api/3/issue/{issueIdOrKey}/editmeta",
1137
+ method: "GET",
1138
+ pathParams: {
1139
+ issueIdOrKey,
1140
+ },
1141
+ query: {
1142
+ overrideScreenSecurity,
1143
+ overrideEditableFlag,
1144
+ },
1145
+ })
1146
+ .then(this.getClientInstance().responseHandler({
1147
+ 200: {
1148
+ "application/json": "json",
1149
+ },
1150
+ }))
1151
+ .then(commonHttpClient.castResponse())
1152
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getEditIssueMeta.response"))
1153
+ .then(commonHttpClient.getBody);
1154
+ };
1155
+ /**
1156
+ * Returns all issue events.
1157
+ *
1158
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
1159
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
1160
+ *
1161
+ * @returns Returned if the request is successful.
1162
+ *
1163
+ * example: [
1164
+ * {
1165
+ * "id": 1,
1166
+ * "name": "Issue Created"
1167
+ * },
1168
+ * {
1169
+ * "id": 2,
1170
+ * "name": "Issue Updated"
1171
+ * }
1172
+ * ]
1173
+ * @path {GET} /rest/api/3/events
1174
+ * @scopes-current manage:jira-configuration
1175
+ * @scopes-beta read:issue-event:jira
1176
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-events-get
1177
+ */
1178
+ this.getEvents = () => {
1179
+ return this.getClientInstance()
1180
+ .request({
1181
+ path: "/rest/api/3/events",
1182
+ method: "GET",
1183
+ })
1184
+ .then(this.getClientInstance().responseHandler({
1185
+ 200: {
1186
+ "application/json": "json",
1187
+ },
1188
+ }))
1189
+ .then(commonHttpClient.castResponse())
1190
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getEvents.response"))
1191
+ .then(commonHttpClient.getBody);
1192
+ };
1193
+ /**
1194
+ * Returns the details for an issue.
1195
+ *
1196
+ * The issue is identified by its ID or key, however, if the identifier doesn't
1197
+ * match an issue, a case-insensitive search and check for moved issues is
1198
+ * performed. If a matching issue is found its details are returned, a 302 or
1199
+ * other redirect is **not** returned. The issue key returned in the response is
1200
+ * the key of the issue found.
1201
+ *
1202
+ * This operation can be accessed anonymously.
1203
+ *
1204
+ * **[Permissions](#permissions) required:**
1205
+ *
1206
+ * * *Browse projects* [project
1207
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1208
+ * issue is in.
1209
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1210
+ * configured, issue-level security permission to view the issue.
1211
+ *
1212
+ * @returns Returned if the request is successful.
1213
+ *
1214
+ * example: {
1215
+ * "fields": {
1216
+ * "watcher": {
1217
+ * "isWatching": false,
1218
+ * "self":
1219
+ * "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
1220
+ * "watchCount": 1,
1221
+ * "watchers": [
1222
+ * {
1223
+ * "accountId": "5b10a2844c20165700ede21g",
1224
+ * "active": false,
1225
+ * "displayName": "Mia Krystof",
1226
+ * "self":
1227
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1228
+ * }
1229
+ * ]
1230
+ * },
1231
+ * "attachment": [
1232
+ * {
1233
+ * "author": {
1234
+ * "accountId": "5b10a2844c20165700ede21g",
1235
+ * "accountType": "atlassian",
1236
+ * "active": false,
1237
+ * "avatarUrls": {
1238
+ * "16x16":
1239
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1240
+ * "24x24":
1241
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1242
+ * "32x32":
1243
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1244
+ * "48x48":
1245
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1246
+ * },
1247
+ * "displayName": "Mia Krystof",
1248
+ * "key": "",
1249
+ * "name": "",
1250
+ * "self":
1251
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1252
+ * },
1253
+ * "content":
1254
+ * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
1255
+ * "created": "2022-10-06T07:32:47.000+0000",
1256
+ * "filename": "picture.jpg",
1257
+ * "id": 10000,
1258
+ * "mimeType": "image/jpeg",
1259
+ * "self":
1260
+ * "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
1261
+ * "size": 23123,
1262
+ * "thumbnail":
1263
+ * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
1264
+ * }
1265
+ * ],
1266
+ * "sub-tasks": [
1267
+ * {
1268
+ * "id": "10000",
1269
+ * "outwardIssue": {
1270
+ * "fields": {
1271
+ * "status": {
1272
+ * "iconUrl":
1273
+ * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1274
+ * "name": "Open"
1275
+ * }
1276
+ * },
1277
+ * "id": "10003",
1278
+ * "key": "ED-2",
1279
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
1280
+ * },
1281
+ * "type": {
1282
+ * "id": "10000",
1283
+ * "inward": "Parent",
1284
+ * "name": "",
1285
+ * "outward": "Sub-task"
1286
+ * }
1287
+ * }
1288
+ * ],
1289
+ * "description": {
1290
+ * "type": "doc",
1291
+ * "version": 1,
1292
+ * "content": [
1293
+ * {
1294
+ * "type": "paragraph",
1295
+ * "content": [
1296
+ * {
1297
+ * "type": "text",
1298
+ * "text": "Main order flow broken"
1299
+ * }
1300
+ * ]
1301
+ * }
1302
+ * ]
1303
+ * },
1304
+ * "project": {
1305
+ * "avatarUrls": {
1306
+ * "16x16":
1307
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1308
+ * "24x24":
1309
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1310
+ * "32x32":
1311
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1312
+ * "48x48":
1313
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1314
+ * },
1315
+ * "id": "10000",
1316
+ * "insight": {
1317
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1318
+ * "totalIssueCount": 100
1319
+ * },
1320
+ * "key": "EX",
1321
+ * "name": "Example",
1322
+ * "projectCategory": {
1323
+ * "description": "First Project Category",
1324
+ * "id": "10000",
1325
+ * "name": "FIRST",
1326
+ * "self":
1327
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1328
+ * },
1329
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1330
+ * "simplified": false,
1331
+ * "style": "classic"
1332
+ * },
1333
+ * "comment": [
1334
+ * {
1335
+ * "author": {
1336
+ * "accountId": "5b10a2844c20165700ede21g",
1337
+ * "active": false,
1338
+ * "displayName": "Mia Krystof",
1339
+ * "self":
1340
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1341
+ * },
1342
+ * "body": {
1343
+ * "type": "doc",
1344
+ * "version": 1,
1345
+ * "content": [
1346
+ * {
1347
+ * "type": "paragraph",
1348
+ * "content": [
1349
+ * {
1350
+ * "type": "text",
1351
+ * "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
1352
+ * elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
1353
+ * fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
1354
+ * }
1355
+ * ]
1356
+ * }
1357
+ * ]
1358
+ * },
1359
+ * "created": "2021-01-17T12:34:00.000+0000",
1360
+ * "id": "10000",
1361
+ * "self":
1362
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1363
+ * "updateAuthor": {
1364
+ * "accountId": "5b10a2844c20165700ede21g",
1365
+ * "active": false,
1366
+ * "displayName": "Mia Krystof",
1367
+ * "self":
1368
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1369
+ * },
1370
+ * "updated": "2021-01-18T23:45:00.000+0000",
1371
+ * "visibility": {
1372
+ * "identifier": "Administrators",
1373
+ * "type": "role",
1374
+ * "value": "Administrators"
1375
+ * }
1376
+ * }
1377
+ * ],
1378
+ * "issuelinks": [
1379
+ * {
1380
+ * "id": "10001",
1381
+ * "outwardIssue": {
1382
+ * "fields": {
1383
+ * "status": {
1384
+ * "iconUrl":
1385
+ * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1386
+ * "name": "Open"
1387
+ * }
1388
+ * },
1389
+ * "id": "10004L",
1390
+ * "key": "PR-2",
1391
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
1392
+ * },
1393
+ * "type": {
1394
+ * "id": "10000",
1395
+ * "inward": "depends on",
1396
+ * "name": "Dependent",
1397
+ * "outward": "is depended by"
1398
+ * }
1399
+ * },
1400
+ * {
1401
+ * "id": "10002",
1402
+ * "inwardIssue": {
1403
+ * "fields": {
1404
+ * "status": {
1405
+ * "iconUrl":
1406
+ * "https://your-domain.atlassian.net/images/icons/statuses/open.png",
1407
+ * "name": "Open"
1408
+ * }
1409
+ * },
1410
+ * "id": "10004",
1411
+ * "key": "PR-3",
1412
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
1413
+ * },
1414
+ * "type": {
1415
+ * "id": "10000",
1416
+ * "inward": "depends on",
1417
+ * "name": "Dependent",
1418
+ * "outward": "is depended by"
1419
+ * }
1420
+ * }
1421
+ * ],
1422
+ * "worklog": [
1423
+ * {
1424
+ * "author": {
1425
+ * "accountId": "5b10a2844c20165700ede21g",
1426
+ * "active": false,
1427
+ * "displayName": "Mia Krystof",
1428
+ * "self":
1429
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1430
+ * },
1431
+ * "comment": {
1432
+ * "type": "doc",
1433
+ * "version": 1,
1434
+ * "content": [
1435
+ * {
1436
+ * "type": "paragraph",
1437
+ * "content": [
1438
+ * {
1439
+ * "type": "text",
1440
+ * "text": "I did some work here."
1441
+ * }
1442
+ * ]
1443
+ * }
1444
+ * ]
1445
+ * },
1446
+ * "id": "100028",
1447
+ * "issueId": "10002",
1448
+ * "self":
1449
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1450
+ * "started": "2021-01-17T12:34:00.000+0000",
1451
+ * "timeSpent": "3h 20m",
1452
+ * "timeSpentSeconds": 12000,
1453
+ * "updateAuthor": {
1454
+ * "accountId": "5b10a2844c20165700ede21g",
1455
+ * "active": false,
1456
+ * "displayName": "Mia Krystof",
1457
+ * "self":
1458
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1459
+ * },
1460
+ * "updated": "2021-01-18T23:45:00.000+0000",
1461
+ * "visibility": {
1462
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1463
+ * "type": "group",
1464
+ * "value": "jira-developers"
1465
+ * }
1466
+ * }
1467
+ * ],
1468
+ * "updated": 1,
1469
+ * "timetracking": {
1470
+ * "originalEstimate": "10m",
1471
+ * "originalEstimateSeconds": 600,
1472
+ * "remainingEstimate": "3m",
1473
+ * "remainingEstimateSeconds": 200,
1474
+ * "timeSpent": "6m",
1475
+ * "timeSpentSeconds": 400
1476
+ * }
1477
+ * },
1478
+ * "id": "10002",
1479
+ * "key": "ED-1",
1480
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
1481
+ * }
1482
+ * @path {GET} /rest/api/3/issue/{issueIdOrKey}
1483
+ * @scopes-current read:jira-work
1484
+ * @scopes-beta read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira,
1485
+ * read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira,
1486
+ * read:user:jira, read:field-configuration:jira
1487
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-get
1488
+ */
1489
+ this.getIssue = ({ issueIdOrKey, fields, fieldsByKeys, expand, properties, updateHistory, }) => {
1490
+ return this.getClientInstance()
1491
+ .request({
1492
+ path: "/rest/api/3/issue/{issueIdOrKey}",
1493
+ method: "GET",
1494
+ pathParams: {
1495
+ issueIdOrKey,
1496
+ },
1497
+ query: {
1498
+ fields,
1499
+ fieldsByKeys,
1500
+ expand,
1501
+ properties,
1502
+ updateHistory,
1503
+ },
1504
+ })
1505
+ .then(this.getClientInstance().responseHandler({
1506
+ 200: {
1507
+ "application/json": "json",
1508
+ },
1509
+ }))
1510
+ .then(commonHttpClient.castResponse())
1511
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getIssue.response"))
1512
+ .then(commonHttpClient.getBody);
1513
+ };
1514
+ /**
1515
+ * Returns all issues breaching and approaching per-issue limits.
1516
+ *
1517
+ * **[Permissions](#permissions) required:**
1518
+ *
1519
+ * * *Browse projects* [project
1520
+ * permission](https://confluence.atlassian.com/x/yodKLg) is required for the
1521
+ * project the issues are in. Results may be incomplete otherwise
1522
+ * * *Administer Jira* [global
1523
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
1524
+ *
1525
+ * @returns Returned if the request is successful.
1526
+ *
1527
+ * example: {
1528
+ * "issuesApproachingLimit": {
1529
+ * "attachment": {
1530
+ * "15070": 1822,
1531
+ * "15111": 1999
1532
+ * },
1533
+ * "comment": {
1534
+ * "10000": 4997,
1535
+ * "15073": 4999,
1536
+ * "15110": 5000
1537
+ * },
1538
+ * "remoteIssueLinks": {
1539
+ * "15107": 2000
1540
+ * },
1541
+ * "worklog": {
1542
+ * "15101": 4342
1543
+ * }
1544
+ * },
1545
+ * "issuesBreachingLimit": {
1546
+ * "attachment": {
1547
+ * "15057": 2005,
1548
+ * "15116": 2065,
1549
+ * "15117": 3005
1550
+ * },
1551
+ * "comment": {
1552
+ * "15055": 5202
1553
+ * },
1554
+ * "issuelinks": {
1555
+ * "15058": 2120
1556
+ * },
1557
+ * "remoteIssueLinks": {
1558
+ * "15059": 2094
1559
+ * },
1560
+ * "worklog": {
1561
+ * "15056": 5085,
1562
+ * "15169": 120864
1563
+ * }
1564
+ * },
1565
+ * "limits": {
1566
+ * "attachment": 2000,
1567
+ * "comment": 5000,
1568
+ * "issuelinks": 2000,
1569
+ * "remoteIssueLinks": 2000,
1570
+ * "worklog": 5000
1571
+ * }
1572
+ * }
1573
+ * @path {GET} /rest/api/3/issue/limit/report
1574
+ * @scopes-current read:jira-work
1575
+ * @scopes-beta read:project:jira, read:issue:jira
1576
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-limit-report-get
1577
+ */
1578
+ this.getIssueLimitReport = ({ issueLimitReportRequest, }) => {
1579
+ return this.getClientInstance()
1580
+ .request({
1581
+ path: "/rest/api/3/issue/limit/report",
1582
+ method: "GET",
1583
+ headers: {
1584
+ "Content-Type": "application/json",
1585
+ },
1586
+ body: issueLimitReportRequest,
1587
+ })
1588
+ .then(this.getClientInstance().responseHandler({
1589
+ 200: {
1590
+ "application/json": "json",
1591
+ },
1592
+ }))
1593
+ .then(commonHttpClient.castResponse())
1594
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getIssueLimitReport.response"))
1595
+ .then(commonHttpClient.getBody);
1596
+ };
1597
+ /**
1598
+ * Returns either all transitions or a transition that can be performed by the
1599
+ * user on an issue, based on the issue's status.
1600
+ *
1601
+ * Note, if a request is made for a transition that does not exist or cannot be
1602
+ * performed on the issue, given its status, the response will return any empty
1603
+ * transitions list.
1604
+ *
1605
+ * This operation can be accessed anonymously.
1606
+ *
1607
+ * **[Permissions](#permissions) required: A list or transition is returned only
1608
+ * when the user has:**
1609
+ *
1610
+ * * *Browse projects* [project
1611
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1612
+ * issue is in.
1613
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1614
+ * configured, issue-level security permission to view the issue.
1615
+ *
1616
+ * However, if the user does not have the *Transition issues* [ project
1617
+ * permission](https://confluence.atlassian.com/x/yodKLg) the response will not
1618
+ * list any transitions.
1619
+ *
1620
+ * @returns Returned if the request is successful.
1621
+ *
1622
+ * example: {
1623
+ * "transitions": [
1624
+ * {
1625
+ * "fields": {
1626
+ * "summary": {
1627
+ * "allowedValues": [
1628
+ * "red",
1629
+ * "blue"
1630
+ * ],
1631
+ * "defaultValue": "red",
1632
+ * "hasDefaultValue": false,
1633
+ * "key": "field_key",
1634
+ * "name": "My Multi Select",
1635
+ * "operations": [
1636
+ * "set",
1637
+ * "add"
1638
+ * ],
1639
+ * "required": false,
1640
+ * "schema": {
1641
+ * "custom":
1642
+ * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1643
+ * "customId": 10001,
1644
+ * "items": "option",
1645
+ * "type": "array"
1646
+ * }
1647
+ * }
1648
+ * },
1649
+ * "hasScreen": false,
1650
+ * "id": "2",
1651
+ * "isAvailable": true,
1652
+ * "isConditional": false,
1653
+ * "isGlobal": false,
1654
+ * "isInitial": false,
1655
+ * "name": "Close Issue",
1656
+ * "to": {
1657
+ * "description": "The issue is currently being worked on.",
1658
+ * "iconUrl":
1659
+ * "https://your-domain.atlassian.net/images/icons/progress.gif",
1660
+ * "id": "10000",
1661
+ * "name": "In Progress",
1662
+ * "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
1663
+ * "statusCategory": {
1664
+ * "colorName": "yellow",
1665
+ * "id": 1,
1666
+ * "key": "in-flight",
1667
+ * "name": "In Progress",
1668
+ * "self":
1669
+ * "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
1670
+ * }
1671
+ * }
1672
+ * },
1673
+ * {
1674
+ * "fields": {
1675
+ * "summary": {
1676
+ * "allowedValues": [
1677
+ * "red",
1678
+ * "blue"
1679
+ * ],
1680
+ * "defaultValue": "red",
1681
+ * "hasDefaultValue": false,
1682
+ * "key": "field_key",
1683
+ * "name": "My Multi Select",
1684
+ * "operations": [
1685
+ * "set",
1686
+ * "add"
1687
+ * ],
1688
+ * "required": false,
1689
+ * "schema": {
1690
+ * "custom":
1691
+ * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1692
+ * "customId": 10001,
1693
+ * "items": "option",
1694
+ * "type": "array"
1695
+ * }
1696
+ * },
1697
+ * "colour": {
1698
+ * "allowedValues": [
1699
+ * "red",
1700
+ * "blue"
1701
+ * ],
1702
+ * "defaultValue": "red",
1703
+ * "hasDefaultValue": false,
1704
+ * "key": "field_key",
1705
+ * "name": "My Multi Select",
1706
+ * "operations": [
1707
+ * "set",
1708
+ * "add"
1709
+ * ],
1710
+ * "required": false,
1711
+ * "schema": {
1712
+ * "custom":
1713
+ * "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
1714
+ * "customId": 10001,
1715
+ * "items": "option",
1716
+ * "type": "array"
1717
+ * }
1718
+ * }
1719
+ * },
1720
+ * "hasScreen": true,
1721
+ * "id": "711",
1722
+ * "name": "QA Review",
1723
+ * "to": {
1724
+ * "description": "The issue is closed.",
1725
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
1726
+ * "id": "5",
1727
+ * "name": "Closed",
1728
+ * "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
1729
+ * "statusCategory": {
1730
+ * "colorName": "green",
1731
+ * "id": 9,
1732
+ * "key": "completed",
1733
+ * "self":
1734
+ * "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
1735
+ * }
1736
+ * }
1737
+ * }
1738
+ * ]
1739
+ * }
1740
+ * @path {GET} /rest/api/3/issue/{issueIdOrKey}/transitions
1741
+ * @scopes-current read:jira-work
1742
+ * @scopes-beta read:issue.transition:jira, read:status:jira, read:field-configuration:jira
1743
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-transitions-get
1744
+ */
1745
+ this.getTransitions = ({ issueIdOrKey, expand, transitionId, skipRemoteOnlyCondition, includeUnavailableTransitions, sortByOpsBarAndStatus, }) => {
1746
+ return this.getClientInstance()
1747
+ .request({
1748
+ path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
1749
+ method: "GET",
1750
+ pathParams: {
1751
+ issueIdOrKey,
1752
+ },
1753
+ query: {
1754
+ expand,
1755
+ transitionId,
1756
+ skipRemoteOnlyCondition,
1757
+ includeUnavailableTransitions,
1758
+ sortByOpsBarAndStatus,
1759
+ },
1760
+ })
1761
+ .then(this.getClientInstance().responseHandler({
1762
+ 200: {
1763
+ "application/json": "json",
1764
+ },
1765
+ }))
1766
+ .then(commonHttpClient.castResponse())
1767
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.getTransitions.response"))
1768
+ .then(commonHttpClient.getBody);
1769
+ };
1770
+ /**
1771
+ * Creates an email notification for an issue and adds it to the mail queue.
1772
+ *
1773
+ * **[Permissions](#permissions) required:**
1774
+ *
1775
+ * * *Browse Projects* [project
1776
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
1777
+ * issue is in.
1778
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
1779
+ * configured, issue-level security permission to view the issue.
1780
+ *
1781
+ * @returns Returned if the email is queued for sending.
1782
+ * @path {POST} /rest/api/3/issue/{issueIdOrKey}/notify
1783
+ * @scopes-current write:jira-work
1784
+ * @scopes-beta send:notification:jira
1785
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-issueidorkey-notify-post
1786
+ */
1787
+ this.notify = ({ issueIdOrKey, notification, }) => {
1788
+ return this.getClientInstance()
1789
+ .request({
1790
+ path: "/rest/api/3/issue/{issueIdOrKey}/notify",
1791
+ method: "POST",
1792
+ pathParams: {
1793
+ issueIdOrKey,
1794
+ },
1795
+ headers: {
1796
+ "Content-Type": "application/json",
1797
+ },
1798
+ body: notification,
1799
+ })
1800
+ .then(this.getClientInstance().responseHandler({
1801
+ 204: {
1802
+ "application/json": "json",
1803
+ },
1804
+ }))
1805
+ .then(commonHttpClient.castResponse())
1806
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.notify.response"))
1807
+ .then(commonHttpClient.getBody);
1808
+ };
1809
+ /**
1810
+ * Enables admins to unarchive up to 1000 issues in a single request using issue
1811
+ * ID/key, returning details of the issue(s) unarchived in the process and the
1812
+ * errors encountered, if any.
1813
+ *
1814
+ * **Note that:**
1815
+ *
1816
+ * * you can't unarchive subtasks directly, only through their parent issues
1817
+ * * you can only unarchive issues from software, service management, and
1818
+ * business projects
1819
+ *
1820
+ * **[Permissions](#permissions) required:** Jira admin or site admin: [global
1821
+ * permission](https://confluence.atlassian.com/x/x4dKLg)
1822
+ *
1823
+ * **License required:** Premium or Enterprise
1824
+ *
1825
+ * **Signed-in users only:** This API can't be accessed anonymously.
1826
+ *
1827
+ * @returns Returned if there is at least one valid issue to unarchive in the request. It
1828
+ * will return the count of unarchived issues, which also includes the count of
1829
+ * the subtasks unarchived, and it will show the detailed errors for those issues
1830
+ * which are not unarchived.
1831
+ *
1832
+ * example: {
1833
+ * "errors": {
1834
+ * "issueIsSubtask": {
1835
+ * "count": 3,
1836
+ * "issueIdsOrKeys": [
1837
+ * "ST-1",
1838
+ * "ST-2",
1839
+ * "ST-3"
1840
+ * ],
1841
+ * "message": "Issue is subtask."
1842
+ * },
1843
+ * "issuesInArchivedProjects": {
1844
+ * "count": 2,
1845
+ * "issueIdsOrKeys": [
1846
+ * "AR-1",
1847
+ * "AR-2"
1848
+ * ],
1849
+ * "message": "Issue exists in archived project."
1850
+ * },
1851
+ * "issuesNotFound": {
1852
+ * "count": 3,
1853
+ * "issueIdsOrKeys": [
1854
+ * "PR-1",
1855
+ * "PR-2",
1856
+ * "PR-3"
1857
+ * ],
1858
+ * "message": "Issue not found."
1859
+ * }
1860
+ * },
1861
+ * "numberOfIssuesUpdated": 10
1862
+ * }
1863
+ * @path {PUT} /rest/api/3/issue/unarchive
1864
+ * @scopes-current write:jira-work
1865
+ * @scopes-beta write:issue:jira
1866
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues#api-rest-api-3-issue-unarchive-put
1867
+ */
1868
+ this.unarchiveIssues = ({ issueArchivalSyncRequest, }) => {
1869
+ return this.getClientInstance()
1870
+ .request({
1871
+ path: "/rest/api/3/issue/unarchive",
1872
+ method: "PUT",
1873
+ headers: {
1874
+ "Content-Type": "application/json",
1875
+ },
1876
+ body: issueArchivalSyncRequest,
1877
+ })
1878
+ .then(this.getClientInstance().responseHandler({
1879
+ 200: {
1880
+ "application/json": "json",
1881
+ },
1882
+ }))
1883
+ .then(commonHttpClient.castResponse())
1884
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssuesService.unarchiveIssues.response"))
1885
+ .then(commonHttpClient.getBody);
1886
+ };
1884
1887
  }
1885
1888
  static initialize() {
1886
1889
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssuesService.getEvents.response", zod_1.z