@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
@@ -18,1600 +18,1603 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
18
18
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects
19
19
  */
20
20
  class ProjectsService extends CommonHttpService_1.CommonHttpService {
21
- /**
22
- * Archives a project. You can't delete a project if it's archived. To delete an
23
- * archived project, restore the project and then delete it. To restore a project,
24
- * use the Jira UI.
25
- *
26
- * **[Permissions](#permissions) required:** *Administer Jira* [global
27
- * permission](https://confluence.atlassian.com/x/x4dKLg).
28
- *
29
- * @returns Returned if the request is successful.
30
- * @path {POST} /rest/api/3/project/{projectIdOrKey}/archive
31
- * @scopes-current manage:jira-project
32
- * @scopes-beta write:project:jira
33
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-archive-post
34
- */
35
- archiveProject({ projectIdOrKey, }) {
36
- return this.getClientInstance()
37
- .request({
38
- path: "/rest/api/3/project/{projectIdOrKey}/archive",
39
- method: "POST",
40
- pathParams: {
41
- projectIdOrKey,
42
- },
43
- })
44
- .then(this.getClientInstance().responseHandler({
45
- 204: {
46
- "application/json": "json",
47
- },
48
- }))
49
- .then(commonHttpClient.castResponse())
50
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.archiveProject.response"))
51
- .then(commonHttpClient.getBody);
52
- }
53
- /**
54
- * Creates a project based on a project type template, as shown in the following
55
- * table:
56
- *
57
- * | Project Type Key | Project Template Key |
58
- * |--|--|
59
- * | `business` |
60
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`,
61
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`,
62
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`,
63
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`,
64
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`,
65
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`,
66
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`,
67
- * `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking` |
68
- * | `service_desk` |
69
- * `com.atlassian.servicedesk:simplified-it-service-management`,
70
- * `com.atlassian.servicedesk:simplified-general-service-desk-it`,
71
- * `com.atlassian.servicedesk:simplified-general-service-desk-business`,
72
- * `com.atlassian.servicedesk:simplified-external-service-desk`,
73
- * `com.atlassian.servicedesk:simplified-hr-service-desk`,
74
- * `com.atlassian.servicedesk:simplified-facilities-service-desk`,
75
- * `com.atlassian.servicedesk:simplified-legal-service-desk`,
76
- * `com.atlassian.servicedesk:simplified-analytics-service-desk`,
77
- * `com.atlassian.servicedesk:simplified-marketing-service-desk`,
78
- * `com.atlassian.servicedesk:simplified-design-service-desk`,
79
- * `com.atlassian.servicedesk:simplified-sales-service-desk`,
80
- * `com.atlassian.servicedesk:simplified-blank-project-business`,
81
- * `com.atlassian.servicedesk:simplified-blank-project-it`,
82
- * `com.atlassian.servicedesk:simplified-finance-service-desk`,
83
- * `com.atlassian.servicedesk:next-gen-it-service-desk`,
84
- * `com.atlassian.servicedesk:next-gen-hr-service-desk`,
85
- * `com.atlassian.servicedesk:next-gen-legal-service-desk`,
86
- * `com.atlassian.servicedesk:next-gen-marketing-service-desk`,
87
- * `com.atlassian.servicedesk:next-gen-facilities-service-desk`,
88
- * `com.atlassian.servicedesk:next-gen-general-it-service-desk`,
89
- * `com.atlassian.servicedesk:next-gen-general-business-service-desk`,
90
- * `com.atlassian.servicedesk:next-gen-analytics-service-desk`,
91
- * `com.atlassian.servicedesk:next-gen-finance-service-desk`,
92
- * `com.atlassian.servicedesk:next-gen-design-service-desk`,
93
- * `com.atlassian.servicedesk:next-gen-sales-service-desk` |
94
- * | `software` | `com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`,
95
- * `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`,
96
- * `com.pyxis.greenhopper.jira:gh-simplified-basic`,
97
- * `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`,
98
- * `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic` |
99
- * The project types are available according to the installed Jira features as
100
- * follows:
101
- *
102
- * * Jira Core, the default, enables `business` projects.
103
- * * Jira Service Management enables `service_desk` projects.
104
- * * Jira Software enables `software` projects.
105
- *
106
- * To determine which features are installed, go to **Jira settings** > **Apps** >
107
- * **Manage apps** and review the System Apps list. To add Jira Software or Jira
108
- * Service Management into a JIRA instance, use **Jira settings** > **Apps** >
109
- * **Finding new apps**. For more information, see [ Managing
110
- * add-ons](https://confluence.atlassian.com/x/S31NLg).
111
- *
112
- * **[Permissions](#permissions) required:** *Administer Jira* [global
113
- * permission](https://confluence.atlassian.com/x/x4dKLg).
114
- *
115
- * @returns Returned if the project is created.
116
- *
117
- * example: {
118
- * "id": 10010,
119
- * "key": "EX",
120
- * "self": "https://your-domain.atlassian.net/jira/rest/api/3/project/10042"
121
- * }
122
- * @path {POST} /rest/api/3/project
123
- * @scopes-current manage:jira-configuration
124
- * @scopes-beta write:project:jira, read:project:jira
125
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-post
126
- */
127
- createProject({ createProjectDetails, }) {
128
- return this.getClientInstance()
129
- .request({
130
- path: "/rest/api/3/project",
131
- method: "POST",
132
- headers: {
133
- "Content-Type": "application/json",
134
- },
135
- body: createProjectDetails,
136
- })
137
- .then(this.getClientInstance().responseHandler({
138
- 201: {
139
- "application/json": "json",
140
- },
141
- }))
142
- .then(commonHttpClient.castResponse())
143
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.createProject.response"))
144
- .then(commonHttpClient.getBody);
145
- }
146
- /**
147
- * Deletes a project.
148
- *
149
- * You can't delete a project if it's archived. To delete an archived project,
150
- * restore the project and then delete it. To restore a project, use the Jira UI.
151
- *
152
- * **[Permissions](#permissions) required:** *Administer Jira* [global
153
- * permission](https://confluence.atlassian.com/x/x4dKLg).
154
- *
155
- * @path {DELETE} /rest/api/3/project/{projectIdOrKey}
156
- * @scopes-current manage:jira-configuration
157
- * @scopes-beta delete:project:jira
158
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete
159
- */
160
- deleteProject({ projectIdOrKey, enableUndo, }) {
161
- return this.getClientInstance()
162
- .request({
163
- path: "/rest/api/3/project/{projectIdOrKey}",
164
- method: "DELETE",
165
- pathParams: {
166
- projectIdOrKey,
167
- },
168
- query: {
169
- enableUndo,
170
- },
171
- })
172
- .then(commonHttpClient.discardResult);
173
- }
174
- /**
175
- * Deletes a project asynchronously.
176
- *
177
- * This operation is:
178
- *
179
- * * transactional, that is, if part of the delete fails the project is not
180
- * deleted.
181
- * * [asynchronous](#async). Follow the `location` link in the response to
182
- * determine the status of the task and use [Get
183
- * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
184
- *
185
- * **[Permissions](#permissions) required:** *Administer Jira* [global
186
- * permission](https://confluence.atlassian.com/x/x4dKLg).
187
- *
188
- * @path {POST} /rest/api/3/project/{projectIdOrKey}/delete
189
- * @scopes-current manage:jira-configuration
190
- * @scopes-beta write:project:jira, write:project.property:jira
191
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete-post
192
- */
193
- deleteProjectAsynchronously({ projectIdOrKey, }) {
194
- return this.getClientInstance()
195
- .request({
196
- path: "/rest/api/3/project/{projectIdOrKey}/delete",
197
- method: "POST",
198
- pathParams: {
199
- projectIdOrKey,
200
- },
201
- })
202
- .then(commonHttpClient.discardResult);
203
- }
204
- /**
205
- * Returns all projects visible to the user. Deprecated, use [ Get projects
206
- * paginated](#api-rest-api-3-project-search-get) that supports search and
207
- * pagination.
208
- *
209
- * This operation can be accessed anonymously.
210
- *
211
- * **[Permissions](#permissions) required:** Projects are returned only where the
212
- * user has *Browse Projects* or *Administer projects* [project
213
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
214
- *
215
- * @deprecated
216
- * @returns Returned if the request is successful.
217
- *
218
- * example: [
219
- * {
220
- * "avatarUrls": {
221
- * "16x16":
222
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
223
- * "24x24":
224
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
225
- * "32x32":
226
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
227
- * "48x48":
228
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
229
- * },
230
- * "id": "10000",
231
- * "insight": {
232
- * "lastIssueUpdateTime": 1619069825000,
233
- * "totalIssueCount": 100
234
- * },
235
- * "key": "EX",
236
- * "name": "Example",
237
- * "projectCategory": {
238
- * "description": "First Project Category",
239
- * "id": "10000",
240
- * "name": "FIRST",
241
- * "self":
242
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
243
- * },
244
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
245
- * "simplified": false,
246
- * "style": "CLASSIC"
247
- * },
248
- * {
249
- * "avatarUrls": {
250
- * "16x16":
251
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
252
- * "24x24":
253
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
254
- * "32x32":
255
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
256
- * "48x48":
257
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
258
- * },
259
- * "id": "10001",
260
- * "insight": {
261
- * "lastIssueUpdateTime": 1619069825000,
262
- * "totalIssueCount": 100
263
- * },
264
- * "key": "ABC",
265
- * "name": "Alphabetical",
266
- * "projectCategory": {
267
- * "description": "First Project Category",
268
- * "id": "10000",
269
- * "name": "FIRST",
270
- * "self":
271
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
272
- * },
273
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
274
- * "simplified": false,
275
- * "style": "CLASSIC"
276
- * }
277
- * ]
278
- * @path {GET} /rest/api/3/project
279
- * @scopes-current read:jira-work
280
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
281
- * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
282
- * read:issue-type-hierarchy:jira, read:project-category:jira,
283
- * read:project-version:jira, read:project.component:jira
284
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-get
285
- */
286
- getAllProjects({ expand, recent, properties, } = {}) {
287
- return this.getClientInstance()
288
- .request({
289
- path: "/rest/api/3/project",
290
- method: "GET",
291
- query: {
292
- expand,
293
- recent,
294
- properties,
295
- },
296
- })
297
- .then(this.getClientInstance().responseHandler({
298
- 200: {
299
- "application/json": "json",
300
- },
301
- }))
302
- .then(commonHttpClient.castResponse())
303
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getAllProjects.response"))
304
- .then(commonHttpClient.getBody);
305
- }
306
- /**
307
- * Returns the valid statuses for a project. The statuses are grouped by issue
308
- * type, as each project has a set of valid issue types and each issue type has a
309
- * set of valid statuses.
310
- *
311
- * This operation can be accessed anonymously.
312
- *
313
- * **[Permissions](#permissions) required:** *Browse Projects* [project
314
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
315
- *
316
- * @returns Returned if the request is successful.
317
- *
318
- * example: [
319
- * {
320
- * "id": "3",
321
- * "name": "Task",
322
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
323
- * "statuses": [
324
- * {
325
- * "description": "The issue is currently being worked on.",
326
- * "iconUrl":
327
- * "https://your-domain.atlassian.net/images/icons/progress.gif",
328
- * "id": "10000",
329
- * "name": "In Progress",
330
- * "self": "https://your-domain.atlassian.net/rest/api/3/status/10000"
331
- * },
332
- * {
333
- * "description": "The issue is closed.",
334
- * "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
335
- * "id": "5",
336
- * "name": "Closed",
337
- * "self": "https://your-domain.atlassian.net/rest/api/3/status/5"
338
- * }
339
- * ],
340
- * "subtask": false
341
- * }
342
- * ]
343
- * @path {GET} /rest/api/3/project/{projectIdOrKey}/statuses
344
- * @scopes-current read:jira-work
345
- * @scopes-beta read:issue-status:jira, read:issue-type:jira, read:status:jira
346
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-statuses-get
347
- */
348
- getAllStatuses({ projectIdOrKey, }) {
349
- return this.getClientInstance()
350
- .request({
351
- path: "/rest/api/3/project/{projectIdOrKey}/statuses",
352
- method: "GET",
353
- pathParams: {
354
- projectIdOrKey,
355
- },
356
- })
357
- .then(this.getClientInstance().responseHandler({
358
- 200: {
359
- "application/json": "json",
360
- },
361
- }))
362
- .then(commonHttpClient.castResponse())
363
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getAllStatuses.response"))
364
- .then(commonHttpClient.getBody);
365
- }
366
- /**
367
- * Get the issue type hierarchy for a next-gen project.
368
- *
369
- * The issue type hierarchy for a project consists of:
370
- *
371
- * * *Epic* at level 1 (optional).
372
- * * One or more issue types at level 0 such as *Story*, *Task*, or *Bug*. Where
373
- * the issue type *Epic* is defined, these issue types are used to break down the
374
- * content of an epic.
375
- * * *Subtask* at level -1 (optional). This issue type enables level 0 issue
376
- * types to be broken down into components. Issues based on a level -1 issue type
377
- * must have a parent issue.
378
- *
379
- * **[Permissions](#permissions) required:** *Browse projects* [project
380
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
381
- *
382
- * @returns Returned if the request is successful.
383
- *
384
- * example: {
385
- * "hierarchy": [
386
- * {
387
- * "issueTypes": [
388
- * {
389
- * "avatarId": 10324,
390
- * "entityId": "ce32639b-8911-4689-81da-65681f451516",
391
- * "id": 10008,
392
- * "name": "Story"
393
- * },
394
- * {
395
- * "avatarId": 10324,
396
- * "entityId": "ffdbced5-fbfc-4370-a848-94e2ce3751af",
397
- * "id": 10001,
398
- * "name": "Bug"
399
- * }
400
- * ],
401
- * "level": 0,
402
- * "name": "Base"
403
- * },
404
- * {
405
- * "issueTypes": [
406
- * {
407
- * "avatarId": 10179,
408
- * "entityId": "80f20d47-34dc-4680-8937-936b7e762a35",
409
- * "id": 10007,
410
- * "name": "Epic"
411
- * }
412
- * ],
413
- * "level": 1,
414
- * "name": "Epic"
415
- * },
416
- * {
417
- * "issueTypes": [
418
- * {
419
- * "avatarId": 10573,
420
- * "entityId": "210b4879-15cc-414c-9746-f8f6b6be0a72",
421
- * "id": 10009,
422
- * "name": "Subtask"
423
- * }
424
- * ],
425
- * "level": -1,
426
- * "name": "Subtask"
427
- * }
428
- * ],
429
- * "projectId": 10030
430
- * }
431
- * @path {GET} /rest/api/3/project/{projectId}/hierarchy
432
- * @scopes-current read:jira-work
433
- * @scopes-beta read:issue-type:jira, read:issue-type-hierarchy:jira
434
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectid-hierarchy-get
435
- */
436
- getHierarchy({ projectId, }) {
437
- return this.getClientInstance()
438
- .request({
439
- path: "/rest/api/3/project/{projectId}/hierarchy",
440
- method: "GET",
441
- pathParams: {
442
- projectId,
443
- },
444
- })
445
- .then(this.getClientInstance().responseHandler({
446
- 200: {
447
- "application/json": "json",
448
- },
449
- }))
450
- .then(commonHttpClient.castResponse())
451
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getHierarchy.response"))
452
- .then(commonHttpClient.getBody);
453
- }
454
- /**
455
- * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg)
456
- * associated with the project.
457
- *
458
- * **[Permissions](#permissions) required:** *Administer Jira* [global
459
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
460
- * [project permission](https://confluence.atlassian.com/x/yodKLg).
461
- *
462
- * @returns Returned if the request is successful.
463
- *
464
- * example: {
465
- * "description": "description",
466
- * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
467
- * "id": 10100,
468
- * "name": "notification scheme name",
469
- * "notificationSchemeEvents": [
470
- * {
471
- * "event": {
472
- * "description": "Event published when an issue is created",
473
- * "id": 1,
474
- * "name": "Issue created"
475
- * },
476
- * "notifications": [
477
- * {
478
- * "expand": "group",
479
- * "group": {
480
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
481
- * "name": "jira-administrators",
482
- * "self":
483
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
484
- * },
485
- * "id": 1,
486
- * "notificationType": "Group",
487
- * "parameter": "jira-administrators",
488
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
489
- * },
490
- * {
491
- * "id": 2,
492
- * "notificationType": "CurrentAssignee"
493
- * },
494
- * {
495
- * "expand": "projectRole",
496
- * "id": 3,
497
- * "notificationType": "ProjectRole",
498
- * "parameter": "10360",
499
- * "projectRole": {
500
- * "self":
501
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
502
- * "name": "Developers",
503
- * "id": 10360,
504
- * "description": "A project role that represents developers in a
505
- * project",
506
- * "actors": [
507
- * {
508
- * "actorGroup": {
509
- * "name": "jira-developers",
510
- * "displayName": "jira-developers",
511
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
512
- * },
513
- * "displayName": "jira-developers",
514
- * "id": 10240,
515
- * "name": "jira-developers",
516
- * "type": "atlassian-group-role-actor"
517
- * },
518
- * {
519
- * "actorUser": {
520
- * "accountId": "5b10a2844c20165700ede21g"
521
- * },
522
- * "displayName": "Mia Krystof",
523
- * "id": 10241,
524
- * "type": "atlassian-user-role-actor"
525
- * }
526
- * ],
527
- * "scope": {
528
- * "project": {
529
- * "id": "10000",
530
- * "key": "KEY",
531
- * "name": "Next Gen Project"
532
- * },
533
- * "type": "PROJECT"
534
- * }
535
- * },
536
- * "recipient": "10360"
537
- * },
538
- * {
539
- * "emailAddress": "rest-developer@atlassian.com",
540
- * "id": 4,
541
- * "notificationType": "EmailAddress",
542
- * "parameter": "rest-developer@atlassian.com",
543
- * "recipient": "rest-developer@atlassian.com"
544
- * },
545
- * {
546
- * "expand": "user",
547
- * "id": 5,
548
- * "notificationType": "User",
549
- * "parameter": "5b10a2844c20165700ede21g",
550
- * "recipient": "5b10a2844c20165700ede21g",
551
- * "user": {
552
- * "accountId": "5b10a2844c20165700ede21g",
553
- * "active": false,
554
- * "displayName": "Mia Krystof",
555
- * "self":
556
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
557
- * }
558
- * },
559
- * {
560
- * "expand": "field",
561
- * "field": {
562
- * "clauseNames": [
563
- * "cf[10101]",
564
- * "New custom field"
565
- * ],
566
- * "custom": true,
567
- * "id": "customfield_10101",
568
- * "key": "customfield_10101",
569
- * "name": "New custom field",
570
- * "navigable": true,
571
- * "orderable": true,
572
- * "schema": {
573
- * "custom":
574
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
575
- * "customId": 10101,
576
- * "type": "project"
577
- * },
578
- * "searchable": true,
579
- * "untranslatedName": "New custom field"
580
- * },
581
- * "id": 6,
582
- * "notificationType": "GroupCustomField",
583
- * "parameter": "customfield_10101",
584
- * "recipient": "customfield_10101"
585
- * }
586
- * ]
587
- * },
588
- * {
589
- * "event": {
590
- * "description": "Custom event that is published together with an issue
591
- * created event",
592
- * "id": 20,
593
- * "name": "Custom event",
594
- * "templateEvent": {
595
- * "description": "Event published when an issue is created",
596
- * "id": 1,
597
- * "name": "Issue created"
598
- * }
599
- * },
600
- * "notifications": [
601
- * {
602
- * "expand": "group",
603
- * "group": {
604
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
605
- * "name": "jira-administrators",
606
- * "self":
607
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
608
- * },
609
- * "id": 1,
610
- * "notificationType": "Group",
611
- * "parameter": "jira-administrators",
612
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
613
- * },
614
- * {
615
- * "id": 2,
616
- * "notificationType": "CurrentAssignee"
617
- * },
618
- * {
619
- * "expand": "projectRole",
620
- * "id": 3,
621
- * "notificationType": "ProjectRole",
622
- * "parameter": "10360",
623
- * "projectRole": {
624
- * "self":
625
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
626
- * "name": "Developers",
627
- * "id": 10360,
628
- * "description": "A project role that represents developers in a
629
- * project",
630
- * "actors": [
631
- * {
632
- * "actorGroup": {
633
- * "name": "jira-developers",
634
- * "displayName": "jira-developers",
635
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
636
- * },
637
- * "displayName": "jira-developers",
638
- * "id": 10240,
639
- * "name": "jira-developers",
640
- * "type": "atlassian-group-role-actor"
641
- * },
642
- * {
643
- * "actorUser": {
644
- * "accountId": "5b10a2844c20165700ede21g"
645
- * },
646
- * "displayName": "Mia Krystof",
647
- * "id": 10241,
648
- * "type": "atlassian-user-role-actor"
649
- * }
650
- * ],
651
- * "scope": {
652
- * "project": {
653
- * "id": "10000",
654
- * "key": "KEY",
655
- * "name": "Next Gen Project"
656
- * },
657
- * "type": "PROJECT"
658
- * }
659
- * },
660
- * "recipient": "10360"
661
- * },
662
- * {
663
- * "emailAddress": "rest-developer@atlassian.com",
664
- * "id": 4,
665
- * "notificationType": "EmailAddress",
666
- * "parameter": "rest-developer@atlassian.com",
667
- * "recipient": "rest-developer@atlassian.com"
668
- * },
669
- * {
670
- * "expand": "user",
671
- * "id": 5,
672
- * "notificationType": "User",
673
- * "parameter": "5b10a2844c20165700ede21g",
674
- * "recipient": "5b10a2844c20165700ede21g",
675
- * "user": {
676
- * "accountId": "5b10a2844c20165700ede21g",
677
- * "active": false,
678
- * "displayName": "Mia Krystof",
679
- * "self":
680
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
681
- * }
682
- * },
683
- * {
684
- * "expand": "field",
685
- * "field": {
686
- * "clauseNames": [
687
- * "cf[10101]",
688
- * "New custom field"
689
- * ],
690
- * "custom": true,
691
- * "id": "customfield_10101",
692
- * "key": "customfield_10101",
693
- * "name": "New custom field",
694
- * "navigable": true,
695
- * "orderable": true,
696
- * "schema": {
697
- * "custom":
698
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
699
- * "customId": 10101,
700
- * "type": "project"
701
- * },
702
- * "searchable": true,
703
- * "untranslatedName": "New custom field"
704
- * },
705
- * "id": 6,
706
- * "notificationType": "GroupCustomField",
707
- * "parameter": "customfield_10101",
708
- * "recipient": "customfield_10101"
709
- * }
710
- * ]
711
- * }
712
- * ],
713
- * "projects": [
714
- * 10001,
715
- * 10002
716
- * ],
717
- * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
718
- * }
719
- * @path {GET} /rest/api/3/project/{projectKeyOrId}/notificationscheme
720
- * @scopes-current read:jira-work
721
- * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
722
- * read:user:jira, read:group:jira, read:field:jira, read:avatar:jira,
723
- * read:field-configuration:jira, read:notification-scheme:jira
724
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectkeyorid-notificationscheme-get
725
- */
726
- getNotificationSchemeForProject({ projectKeyOrId, expand, }) {
727
- return this.getClientInstance()
728
- .request({
729
- path: "/rest/api/3/project/{projectKeyOrId}/notificationscheme",
730
- method: "GET",
731
- pathParams: {
732
- projectKeyOrId,
733
- },
734
- query: {
735
- expand,
736
- },
737
- })
738
- .then(this.getClientInstance().responseHandler({
739
- 200: {
740
- "application/json": "json",
741
- },
742
- }))
743
- .then(commonHttpClient.castResponse())
744
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getNotificationSchemeForProject.response"))
745
- .then(commonHttpClient.getBody);
746
- }
747
- /**
748
- * Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a
749
- * project.
750
- *
751
- * This operation can be accessed anonymously.
752
- *
753
- * **[Permissions](#permissions) required:** *Browse projects* [project
754
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
755
- *
756
- * @returns Returned if successful.
757
- *
758
- * example: {
759
- * "assigneeType": "PROJECT_LEAD",
760
- * "avatarUrls": {
761
- * "16x16":
762
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
763
- * "24x24":
764
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
765
- * "32x32":
766
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
767
- * "48x48":
768
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
769
- * },
770
- * "components": [
771
- * {
772
- * "ari":
773
- * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
774
- * "assignee": {
775
- * "accountId": "5b10a2844c20165700ede21g",
776
- * "accountType": "atlassian",
777
- * "active": false,
778
- * "avatarUrls": {
779
- * "16x16":
780
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
781
- * "24x24":
782
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
783
- * "32x32":
784
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
785
- * "48x48":
786
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
787
- * },
788
- * "displayName": "Mia Krystof",
789
- * "key": "",
790
- * "name": "",
791
- * "self":
792
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
793
- * },
794
- * "assigneeType": "PROJECT_LEAD",
795
- * "description": "This is a Jira component",
796
- * "id": "10000",
797
- * "isAssigneeTypeValid": false,
798
- * "lead": {
799
- * "accountId": "5b10a2844c20165700ede21g",
800
- * "accountType": "atlassian",
801
- * "active": false,
802
- * "avatarUrls": {
803
- * "16x16":
804
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
805
- * "24x24":
806
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
807
- * "32x32":
808
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
809
- * "48x48":
810
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
811
- * },
812
- * "displayName": "Mia Krystof",
813
- * "key": "",
814
- * "name": "",
815
- * "self":
816
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
817
- * },
818
- * "metadata": {
819
- * "icon": "https://www.example.com/icon.png"
820
- * },
821
- * "name": "Component 1",
822
- * "project": "HSP",
823
- * "projectId": 10000,
824
- * "realAssignee": {
825
- * "accountId": "5b10a2844c20165700ede21g",
826
- * "accountType": "atlassian",
827
- * "active": false,
828
- * "avatarUrls": {
829
- * "16x16":
830
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
831
- * "24x24":
832
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
833
- * "32x32":
834
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
835
- * "48x48":
836
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
837
- * },
838
- * "displayName": "Mia Krystof",
839
- * "key": "",
840
- * "name": "",
841
- * "self":
842
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
843
- * },
844
- * "realAssigneeType": "PROJECT_LEAD",
845
- * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
846
- * }
847
- * ],
848
- * "description": "This project was created as an example for REST.",
849
- * "email": "from-jira@example.com",
850
- * "id": "10000",
851
- * "insight": {
852
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
853
- * "totalIssueCount": 100
854
- * },
855
- * "issueTypes": [
856
- * {
857
- * "avatarId": 1,
858
- * "description": "A task that needs to be done.",
859
- * "hierarchyLevel": 0,
860
- * "iconUrl":
861
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
862
- * "id": "3",
863
- * "name": "Task",
864
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
865
- * "subtask": false
866
- * },
867
- * {
868
- * "avatarId": 10002,
869
- * "description": "A problem with the software.",
870
- * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
871
- * "hierarchyLevel": 0,
872
- * "iconUrl":
873
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
874
- * "id": "1",
875
- * "name": "Bug",
876
- * "scope": {
877
- * "project": {
878
- * "id": "10000"
879
- * },
880
- * "type": "PROJECT"
881
- * },
882
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
883
- * "subtask": false
884
- * }
885
- * ],
886
- * "key": "EX",
887
- * "lead": {
888
- * "accountId": "5b10a2844c20165700ede21g",
889
- * "accountType": "atlassian",
890
- * "active": false,
891
- * "avatarUrls": {
892
- * "16x16":
893
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
894
- * "24x24":
895
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
896
- * "32x32":
897
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
898
- * "48x48":
899
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
900
- * },
901
- * "displayName": "Mia Krystof",
902
- * "key": "",
903
- * "name": "",
904
- * "self":
905
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
906
- * },
907
- * "name": "Example",
908
- * "projectCategory": {
909
- * "description": "First Project Category",
910
- * "id": "10000",
911
- * "name": "FIRST",
912
- * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
913
- * },
914
- * "properties": {
915
- * "propertyKey": "propertyValue"
916
- * },
917
- * "roles": {
918
- * "Developers":
919
- * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
920
- * },
921
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
922
- * "simplified": false,
923
- * "style": "classic",
924
- * "url": "https://www.example.com",
925
- * "versions": []
926
- * }
927
- * @path {GET} /rest/api/3/project/{projectIdOrKey}
928
- * @scopes-current read:jira-work
929
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
930
- * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
931
- * read:issue-type-hierarchy:jira, read:project-category:jira,
932
- * read:project-version:jira, read:project.component:jira
933
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-get
934
- */
935
- getProject({ projectIdOrKey, expand, properties, }) {
936
- return this.getClientInstance()
937
- .request({
938
- path: "/rest/api/3/project/{projectIdOrKey}",
939
- method: "GET",
940
- pathParams: {
941
- projectIdOrKey,
942
- },
943
- query: {
944
- expand,
945
- properties,
946
- },
947
- })
948
- .then(this.getClientInstance().responseHandler({
949
- 200: {
950
- "application/json": "json",
951
- },
952
- }))
953
- .then(commonHttpClient.castResponse())
954
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getProject.response"))
955
- .then(commonHttpClient.getBody);
956
- }
957
- /**
958
- * Returns a list of up to 20 projects recently viewed by the user that are still
959
- * visible to the user.
960
- *
961
- * This operation can be accessed anonymously.
962
- *
963
- * **[Permissions](#permissions) required:** Projects are returned only where the
964
- * user has one of:
965
- *
966
- * * *Browse Projects* [project
967
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
968
- * * *Administer Projects* [project
969
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
970
- * * *Administer Jira* [global
971
- * permission](https://confluence.atlassian.com/x/x4dKLg).
972
- *
973
- * @returns Returned if the request is successful.
974
- *
975
- * example: [
976
- * {
977
- * "avatarUrls": {
978
- * "16x16":
979
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
980
- * "24x24":
981
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
982
- * "32x32":
983
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
984
- * "48x48":
985
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
986
- * },
987
- * "id": "10000",
988
- * "insight": {
989
- * "lastIssueUpdateTime": 1619069825000,
990
- * "totalIssueCount": 100
991
- * },
992
- * "key": "EX",
993
- * "name": "Example",
994
- * "projectCategory": {
995
- * "description": "First Project Category",
996
- * "id": "10000",
997
- * "name": "FIRST",
998
- * "self":
999
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1000
- * },
1001
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1002
- * "simplified": false,
1003
- * "style": "CLASSIC"
1004
- * },
1005
- * {
1006
- * "avatarUrls": {
1007
- * "16x16":
1008
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
1009
- * "24x24":
1010
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
1011
- * "32x32":
1012
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
1013
- * "48x48":
1014
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
1015
- * },
1016
- * "id": "10001",
1017
- * "insight": {
1018
- * "lastIssueUpdateTime": 1619069825000,
1019
- * "totalIssueCount": 100
1020
- * },
1021
- * "key": "ABC",
1022
- * "name": "Alphabetical",
1023
- * "projectCategory": {
1024
- * "description": "First Project Category",
1025
- * "id": "10000",
1026
- * "name": "FIRST",
1027
- * "self":
1028
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1029
- * },
1030
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
1031
- * "simplified": false,
1032
- * "style": "CLASSIC"
1033
- * }
1034
- * ]
1035
- * @path {GET} /rest/api/3/project/recent
1036
- * @scopes-current read:jira-work
1037
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1038
- * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
1039
- * read:issue-type-hierarchy:jira, read:project-category:jira,
1040
- * read:project-version:jira, read:project.component:jira
1041
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-recent-get
1042
- */
1043
- getRecent({ expand, properties, } = {}) {
1044
- return this.getClientInstance()
1045
- .request({
1046
- path: "/rest/api/3/project/recent",
1047
- method: "GET",
1048
- query: {
1049
- expand,
1050
- properties,
1051
- },
1052
- })
1053
- .then(this.getClientInstance().responseHandler({
1054
- 200: {
1055
- "application/json": "json",
1056
- },
1057
- }))
1058
- .then(commonHttpClient.castResponse())
1059
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getRecent.response"))
1060
- .then(commonHttpClient.getBody);
1061
- }
1062
- /**
1063
- * Restores a project that has been archived or placed in the Jira recycle bin.
1064
- *
1065
- * **[Permissions](#permissions) required:**
1066
- *
1067
- * * *Administer Jira* [global
1068
- * permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed
1069
- * projects.
1070
- * * *Administer Jira* [global
1071
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
1072
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
1073
- * for Team managed projects.
1074
- *
1075
- * @returns Returned if the request is successful.
1076
- *
1077
- * example: {
1078
- * "assigneeType": "PROJECT_LEAD",
1079
- * "avatarUrls": {
1080
- * "16x16":
1081
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1082
- * "24x24":
1083
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1084
- * "32x32":
1085
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1086
- * "48x48":
1087
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1088
- * },
1089
- * "components": [
1090
- * {
1091
- * "ari":
1092
- * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
1093
- * "assignee": {
1094
- * "accountId": "5b10a2844c20165700ede21g",
1095
- * "accountType": "atlassian",
1096
- * "active": false,
1097
- * "avatarUrls": {
1098
- * "16x16":
1099
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1100
- * "24x24":
1101
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1102
- * "32x32":
1103
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1104
- * "48x48":
1105
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1106
- * },
1107
- * "displayName": "Mia Krystof",
1108
- * "key": "",
1109
- * "name": "",
1110
- * "self":
1111
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1112
- * },
1113
- * "assigneeType": "PROJECT_LEAD",
1114
- * "description": "This is a Jira component",
1115
- * "id": "10000",
1116
- * "isAssigneeTypeValid": false,
1117
- * "lead": {
1118
- * "accountId": "5b10a2844c20165700ede21g",
1119
- * "accountType": "atlassian",
1120
- * "active": false,
1121
- * "avatarUrls": {
1122
- * "16x16":
1123
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1124
- * "24x24":
1125
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1126
- * "32x32":
1127
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1128
- * "48x48":
1129
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1130
- * },
1131
- * "displayName": "Mia Krystof",
1132
- * "key": "",
1133
- * "name": "",
1134
- * "self":
1135
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1136
- * },
1137
- * "metadata": {
1138
- * "icon": "https://www.example.com/icon.png"
1139
- * },
1140
- * "name": "Component 1",
1141
- * "project": "HSP",
1142
- * "projectId": 10000,
1143
- * "realAssignee": {
1144
- * "accountId": "5b10a2844c20165700ede21g",
1145
- * "accountType": "atlassian",
1146
- * "active": false,
1147
- * "avatarUrls": {
1148
- * "16x16":
1149
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1150
- * "24x24":
1151
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1152
- * "32x32":
1153
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1154
- * "48x48":
1155
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1156
- * },
1157
- * "displayName": "Mia Krystof",
1158
- * "key": "",
1159
- * "name": "",
1160
- * "self":
1161
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1162
- * },
1163
- * "realAssigneeType": "PROJECT_LEAD",
1164
- * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
1165
- * }
1166
- * ],
1167
- * "description": "This project was created as an example for REST.",
1168
- * "email": "from-jira@example.com",
1169
- * "id": "10000",
1170
- * "insight": {
1171
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1172
- * "totalIssueCount": 100
1173
- * },
1174
- * "issueTypes": [
1175
- * {
1176
- * "avatarId": 1,
1177
- * "description": "A task that needs to be done.",
1178
- * "hierarchyLevel": 0,
1179
- * "iconUrl":
1180
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
1181
- * "id": "3",
1182
- * "name": "Task",
1183
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
1184
- * "subtask": false
1185
- * },
1186
- * {
1187
- * "avatarId": 10002,
1188
- * "description": "A problem with the software.",
1189
- * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
1190
- * "hierarchyLevel": 0,
1191
- * "iconUrl":
1192
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
1193
- * "id": "1",
1194
- * "name": "Bug",
1195
- * "scope": {
1196
- * "project": {
1197
- * "id": "10000"
1198
- * },
1199
- * "type": "PROJECT"
1200
- * },
1201
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1202
- * "subtask": false
1203
- * }
1204
- * ],
1205
- * "key": "EX",
1206
- * "lead": {
1207
- * "accountId": "5b10a2844c20165700ede21g",
1208
- * "accountType": "atlassian",
1209
- * "active": false,
1210
- * "avatarUrls": {
1211
- * "16x16":
1212
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1213
- * "24x24":
1214
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1215
- * "32x32":
1216
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1217
- * "48x48":
1218
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1219
- * },
1220
- * "displayName": "Mia Krystof",
1221
- * "key": "",
1222
- * "name": "",
1223
- * "self":
1224
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1225
- * },
1226
- * "name": "Example",
1227
- * "projectCategory": {
1228
- * "description": "First Project Category",
1229
- * "id": "10000",
1230
- * "name": "FIRST",
1231
- * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1232
- * },
1233
- * "properties": {
1234
- * "propertyKey": "propertyValue"
1235
- * },
1236
- * "roles": {
1237
- * "Developers":
1238
- * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
1239
- * },
1240
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1241
- * "simplified": false,
1242
- * "style": "classic",
1243
- * "url": "https://www.example.com",
1244
- * "versions": []
1245
- * }
1246
- * @path {POST} /rest/api/3/project/{projectIdOrKey}/restore
1247
- * @scopes-current manage:jira-configuration
1248
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1249
- * read:user:jira, write:project:jira, read:application-role:jira,
1250
- * read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira,
1251
- * read:project-category:jira, read:project-version:jira,
1252
- * read:project.component:jira
1253
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-restore-post
1254
- */
1255
- restore({ projectIdOrKey, }) {
1256
- return this.getClientInstance()
1257
- .request({
1258
- path: "/rest/api/3/project/{projectIdOrKey}/restore",
1259
- method: "POST",
1260
- pathParams: {
1261
- projectIdOrKey,
1262
- },
1263
- })
1264
- .then(this.getClientInstance().responseHandler({
1265
- 200: {
1266
- "application/json": "json",
1267
- },
1268
- }))
1269
- .then(commonHttpClient.castResponse())
1270
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.restore.response"))
1271
- .then(commonHttpClient.getBody);
1272
- }
1273
- /**
1274
- * Returns a [paginated](#pagination) list of projects visible to the user.
1275
- *
1276
- * This operation can be accessed anonymously.
1277
- *
1278
- * **[Permissions](#permissions) required:** Projects are returned only where the
1279
- * user has one of:
1280
- *
1281
- * * *Browse Projects* [project
1282
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
1283
- * * *Administer Projects* [project
1284
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
1285
- * * *Administer Jira* [global
1286
- * permission](https://confluence.atlassian.com/x/x4dKLg).
1287
- *
1288
- * @returns Returned if the request is successful.
1289
- *
1290
- * example: {
1291
- * "isLast": false,
1292
- * "maxResults": 2,
1293
- * "nextPage":
1294
- * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
1295
- * "self":
1296
- * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
1297
- * "startAt": 0,
1298
- * "total": 7,
1299
- * "values": [
1300
- * {
1301
- * "avatarUrls": {
1302
- * "16x16":
1303
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1304
- * "24x24":
1305
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1306
- * "32x32":
1307
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1308
- * "48x48":
1309
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1310
- * },
1311
- * "id": "10000",
1312
- * "insight": {
1313
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1314
- * "totalIssueCount": 100
1315
- * },
1316
- * "key": "EX",
1317
- * "name": "Example",
1318
- * "projectCategory": {
1319
- * "description": "First Project Category",
1320
- * "id": "10000",
1321
- * "name": "FIRST",
1322
- * "self":
1323
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1324
- * },
1325
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1326
- * "simplified": false,
1327
- * "style": "classic"
1328
- * },
1329
- * {
1330
- * "avatarUrls": {
1331
- * "16x16":
1332
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
1333
- * "24x24":
1334
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
1335
- * "32x32":
1336
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
1337
- * "48x48":
1338
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
1339
- * },
1340
- * "id": "10001",
1341
- * "insight": {
1342
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1343
- * "totalIssueCount": 100
1344
- * },
1345
- * "key": "ABC",
1346
- * "name": "Alphabetical",
1347
- * "projectCategory": {
1348
- * "description": "First Project Category",
1349
- * "id": "10000",
1350
- * "name": "FIRST",
1351
- * "self":
1352
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1353
- * },
1354
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
1355
- * "simplified": false,
1356
- * "style": "classic"
1357
- * }
1358
- * ]
1359
- * }
1360
- * @path {GET} /rest/api/3/project/search
1361
- * @scopes-current read:jira-work
1362
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1363
- * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
1364
- * read:issue-type-hierarchy:jira, read:project-category:jira,
1365
- * read:project-version:jira, read:project.component:jira
1366
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-search-get
1367
- */
1368
- searchProjects({ startAt, maxResults, orderBy, id, keys, query, typeKey, categoryId, action, expand, status, properties, propertyQuery, } = {}) {
1369
- return this.getClientInstance()
1370
- .request({
1371
- path: "/rest/api/3/project/search",
1372
- method: "GET",
1373
- query: {
1374
- startAt,
1375
- maxResults,
1376
- orderBy,
1377
- id,
1378
- keys,
1379
- query,
1380
- typeKey,
1381
- categoryId,
1382
- action,
1383
- expand,
1384
- status,
1385
- properties,
1386
- propertyQuery,
1387
- },
1388
- })
1389
- .then(this.getClientInstance().responseHandler({
1390
- 200: {
1391
- "application/json": "json",
1392
- },
1393
- }))
1394
- .then(commonHttpClient.castResponse())
1395
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.searchProjects.response"))
1396
- .then(commonHttpClient.getBody);
1397
- }
1398
- /**
1399
- * Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a
1400
- * project.
1401
- *
1402
- * All parameters are optional in the body of the request. Schemes will only be
1403
- * updated if they are included in the request, any omitted schemes will be left
1404
- * unchanged.
1405
- *
1406
- * **[Permissions](#permissions) required:** *Administer Jira* [global
1407
- * permission](https://confluence.atlassian.com/x/x4dKLg). is only needed when
1408
- * changing the schemes or project key. Otherwise you will only need *Administer
1409
- * Projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
1410
- *
1411
- * @returns Returned if the project is updated.
1412
- *
1413
- * example: {
1414
- * "assigneeType": "PROJECT_LEAD",
1415
- * "avatarUrls": {
1416
- * "16x16":
1417
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1418
- * "24x24":
1419
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1420
- * "32x32":
1421
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1422
- * "48x48":
1423
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1424
- * },
1425
- * "components": [
1426
- * {
1427
- * "ari":
1428
- * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
1429
- * "assignee": {
1430
- * "accountId": "5b10a2844c20165700ede21g",
1431
- * "accountType": "atlassian",
1432
- * "active": false,
1433
- * "avatarUrls": {
1434
- * "16x16":
1435
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1436
- * "24x24":
1437
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1438
- * "32x32":
1439
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1440
- * "48x48":
1441
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1442
- * },
1443
- * "displayName": "Mia Krystof",
1444
- * "key": "",
1445
- * "name": "",
1446
- * "self":
1447
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1448
- * },
1449
- * "assigneeType": "PROJECT_LEAD",
1450
- * "description": "This is a Jira component",
1451
- * "id": "10000",
1452
- * "isAssigneeTypeValid": false,
1453
- * "lead": {
1454
- * "accountId": "5b10a2844c20165700ede21g",
1455
- * "accountType": "atlassian",
1456
- * "active": false,
1457
- * "avatarUrls": {
1458
- * "16x16":
1459
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1460
- * "24x24":
1461
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1462
- * "32x32":
1463
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1464
- * "48x48":
1465
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1466
- * },
1467
- * "displayName": "Mia Krystof",
1468
- * "key": "",
1469
- * "name": "",
1470
- * "self":
1471
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1472
- * },
1473
- * "metadata": {
1474
- * "icon": "https://www.example.com/icon.png"
1475
- * },
1476
- * "name": "Component 1",
1477
- * "project": "HSP",
1478
- * "projectId": 10000,
1479
- * "realAssignee": {
1480
- * "accountId": "5b10a2844c20165700ede21g",
1481
- * "accountType": "atlassian",
1482
- * "active": false,
1483
- * "avatarUrls": {
1484
- * "16x16":
1485
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1486
- * "24x24":
1487
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1488
- * "32x32":
1489
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1490
- * "48x48":
1491
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1492
- * },
1493
- * "displayName": "Mia Krystof",
1494
- * "key": "",
1495
- * "name": "",
1496
- * "self":
1497
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1498
- * },
1499
- * "realAssigneeType": "PROJECT_LEAD",
1500
- * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
1501
- * }
1502
- * ],
1503
- * "description": "This project was created as an example for REST.",
1504
- * "email": "from-jira@example.com",
1505
- * "id": "10000",
1506
- * "insight": {
1507
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1508
- * "totalIssueCount": 100
1509
- * },
1510
- * "issueTypes": [
1511
- * {
1512
- * "avatarId": 1,
1513
- * "description": "A task that needs to be done.",
1514
- * "hierarchyLevel": 0,
1515
- * "iconUrl":
1516
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
1517
- * "id": "3",
1518
- * "name": "Task",
1519
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
1520
- * "subtask": false
1521
- * },
1522
- * {
1523
- * "avatarId": 10002,
1524
- * "description": "A problem with the software.",
1525
- * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
1526
- * "hierarchyLevel": 0,
1527
- * "iconUrl":
1528
- * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
1529
- * "id": "1",
1530
- * "name": "Bug",
1531
- * "scope": {
1532
- * "project": {
1533
- * "id": "10000"
1534
- * },
1535
- * "type": "PROJECT"
1536
- * },
1537
- * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1538
- * "subtask": false
1539
- * }
1540
- * ],
1541
- * "key": "EX",
1542
- * "lead": {
1543
- * "accountId": "5b10a2844c20165700ede21g",
1544
- * "accountType": "atlassian",
1545
- * "active": false,
1546
- * "avatarUrls": {
1547
- * "16x16":
1548
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1549
- * "24x24":
1550
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1551
- * "32x32":
1552
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1553
- * "48x48":
1554
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1555
- * },
1556
- * "displayName": "Mia Krystof",
1557
- * "key": "",
1558
- * "name": "",
1559
- * "self":
1560
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1561
- * },
1562
- * "name": "Example",
1563
- * "projectCategory": {
1564
- * "description": "First Project Category",
1565
- * "id": "10000",
1566
- * "name": "FIRST",
1567
- * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1568
- * },
1569
- * "properties": {
1570
- * "propertyKey": "propertyValue"
1571
- * },
1572
- * "roles": {
1573
- * "Developers":
1574
- * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
1575
- * },
1576
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1577
- * "simplified": false,
1578
- * "style": "classic",
1579
- * "url": "https://www.example.com",
1580
- * "versions": []
1581
- * }
1582
- * @path {PUT} /rest/api/3/project/{projectIdOrKey}
1583
- * @scopes-current manage:jira-project
1584
- * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1585
- * read:user:jira, write:project:jira, write:project.avatar:jira,
1586
- * read:application-role:jira, read:avatar:jira, read:group:jira,
1587
- * read:issue-type-hierarchy:jira, read:project-category:jira,
1588
- * read:project-version:jira, read:project.component:jira
1589
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-put
1590
- */
1591
- updateProject({ projectIdOrKey, expand, updateProjectDetails, }) {
1592
- return this.getClientInstance()
1593
- .request({
1594
- path: "/rest/api/3/project/{projectIdOrKey}",
1595
- method: "PUT",
1596
- pathParams: {
1597
- projectIdOrKey,
1598
- },
1599
- query: {
1600
- expand,
1601
- },
1602
- headers: {
1603
- "Content-Type": "application/json",
1604
- },
1605
- body: updateProjectDetails,
1606
- })
1607
- .then(this.getClientInstance().responseHandler({
1608
- 200: {
1609
- "application/json": "json",
1610
- },
1611
- }))
1612
- .then(commonHttpClient.castResponse())
1613
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.updateProject.response"))
1614
- .then(commonHttpClient.getBody);
21
+ constructor() {
22
+ super(...arguments);
23
+ /**
24
+ * Archives a project. You can't delete a project if it's archived. To delete an
25
+ * archived project, restore the project and then delete it. To restore a project,
26
+ * use the Jira UI.
27
+ *
28
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
29
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
30
+ *
31
+ * @returns Returned if the request is successful.
32
+ * @path {POST} /rest/api/3/project/{projectIdOrKey}/archive
33
+ * @scopes-current manage:jira-project
34
+ * @scopes-beta write:project:jira
35
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-archive-post
36
+ */
37
+ this.archiveProject = ({ projectIdOrKey, }) => {
38
+ return this.getClientInstance()
39
+ .request({
40
+ path: "/rest/api/3/project/{projectIdOrKey}/archive",
41
+ method: "POST",
42
+ pathParams: {
43
+ projectIdOrKey,
44
+ },
45
+ })
46
+ .then(this.getClientInstance().responseHandler({
47
+ 204: {
48
+ "application/json": "json",
49
+ },
50
+ }))
51
+ .then(commonHttpClient.castResponse())
52
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.archiveProject.response"))
53
+ .then(commonHttpClient.getBody);
54
+ };
55
+ /**
56
+ * Creates a project based on a project type template, as shown in the following
57
+ * table:
58
+ *
59
+ * | Project Type Key | Project Template Key |
60
+ * |--|--|
61
+ * | `business` |
62
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`,
63
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`,
64
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`,
65
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`,
66
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`,
67
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`,
68
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`,
69
+ * `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking` |
70
+ * | `service_desk` |
71
+ * `com.atlassian.servicedesk:simplified-it-service-management`,
72
+ * `com.atlassian.servicedesk:simplified-general-service-desk-it`,
73
+ * `com.atlassian.servicedesk:simplified-general-service-desk-business`,
74
+ * `com.atlassian.servicedesk:simplified-external-service-desk`,
75
+ * `com.atlassian.servicedesk:simplified-hr-service-desk`,
76
+ * `com.atlassian.servicedesk:simplified-facilities-service-desk`,
77
+ * `com.atlassian.servicedesk:simplified-legal-service-desk`,
78
+ * `com.atlassian.servicedesk:simplified-analytics-service-desk`,
79
+ * `com.atlassian.servicedesk:simplified-marketing-service-desk`,
80
+ * `com.atlassian.servicedesk:simplified-design-service-desk`,
81
+ * `com.atlassian.servicedesk:simplified-sales-service-desk`,
82
+ * `com.atlassian.servicedesk:simplified-blank-project-business`,
83
+ * `com.atlassian.servicedesk:simplified-blank-project-it`,
84
+ * `com.atlassian.servicedesk:simplified-finance-service-desk`,
85
+ * `com.atlassian.servicedesk:next-gen-it-service-desk`,
86
+ * `com.atlassian.servicedesk:next-gen-hr-service-desk`,
87
+ * `com.atlassian.servicedesk:next-gen-legal-service-desk`,
88
+ * `com.atlassian.servicedesk:next-gen-marketing-service-desk`,
89
+ * `com.atlassian.servicedesk:next-gen-facilities-service-desk`,
90
+ * `com.atlassian.servicedesk:next-gen-general-it-service-desk`,
91
+ * `com.atlassian.servicedesk:next-gen-general-business-service-desk`,
92
+ * `com.atlassian.servicedesk:next-gen-analytics-service-desk`,
93
+ * `com.atlassian.servicedesk:next-gen-finance-service-desk`,
94
+ * `com.atlassian.servicedesk:next-gen-design-service-desk`,
95
+ * `com.atlassian.servicedesk:next-gen-sales-service-desk` |
96
+ * | `software` | `com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`,
97
+ * `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`,
98
+ * `com.pyxis.greenhopper.jira:gh-simplified-basic`,
99
+ * `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`,
100
+ * `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic` |
101
+ * The project types are available according to the installed Jira features as
102
+ * follows:
103
+ *
104
+ * * Jira Core, the default, enables `business` projects.
105
+ * * Jira Service Management enables `service_desk` projects.
106
+ * * Jira Software enables `software` projects.
107
+ *
108
+ * To determine which features are installed, go to **Jira settings** > **Apps** >
109
+ * **Manage apps** and review the System Apps list. To add Jira Software or Jira
110
+ * Service Management into a JIRA instance, use **Jira settings** > **Apps** >
111
+ * **Finding new apps**. For more information, see [ Managing
112
+ * add-ons](https://confluence.atlassian.com/x/S31NLg).
113
+ *
114
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
115
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
116
+ *
117
+ * @returns Returned if the project is created.
118
+ *
119
+ * example: {
120
+ * "id": 10010,
121
+ * "key": "EX",
122
+ * "self": "https://your-domain.atlassian.net/jira/rest/api/3/project/10042"
123
+ * }
124
+ * @path {POST} /rest/api/3/project
125
+ * @scopes-current manage:jira-configuration
126
+ * @scopes-beta write:project:jira, read:project:jira
127
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-post
128
+ */
129
+ this.createProject = ({ createProjectDetails, }) => {
130
+ return this.getClientInstance()
131
+ .request({
132
+ path: "/rest/api/3/project",
133
+ method: "POST",
134
+ headers: {
135
+ "Content-Type": "application/json",
136
+ },
137
+ body: createProjectDetails,
138
+ })
139
+ .then(this.getClientInstance().responseHandler({
140
+ 201: {
141
+ "application/json": "json",
142
+ },
143
+ }))
144
+ .then(commonHttpClient.castResponse())
145
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.createProject.response"))
146
+ .then(commonHttpClient.getBody);
147
+ };
148
+ /**
149
+ * Deletes a project.
150
+ *
151
+ * You can't delete a project if it's archived. To delete an archived project,
152
+ * restore the project and then delete it. To restore a project, use the Jira UI.
153
+ *
154
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
155
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
156
+ *
157
+ * @path {DELETE} /rest/api/3/project/{projectIdOrKey}
158
+ * @scopes-current manage:jira-configuration
159
+ * @scopes-beta delete:project:jira
160
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete
161
+ */
162
+ this.deleteProject = ({ projectIdOrKey, enableUndo, }) => {
163
+ return this.getClientInstance()
164
+ .request({
165
+ path: "/rest/api/3/project/{projectIdOrKey}",
166
+ method: "DELETE",
167
+ pathParams: {
168
+ projectIdOrKey,
169
+ },
170
+ query: {
171
+ enableUndo,
172
+ },
173
+ })
174
+ .then(commonHttpClient.discardResult);
175
+ };
176
+ /**
177
+ * Deletes a project asynchronously.
178
+ *
179
+ * This operation is:
180
+ *
181
+ * * transactional, that is, if part of the delete fails the project is not
182
+ * deleted.
183
+ * * [asynchronous](#async). Follow the `location` link in the response to
184
+ * determine the status of the task and use [Get
185
+ * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
186
+ *
187
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
188
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
189
+ *
190
+ * @path {POST} /rest/api/3/project/{projectIdOrKey}/delete
191
+ * @scopes-current manage:jira-configuration
192
+ * @scopes-beta write:project:jira, write:project.property:jira
193
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-delete-post
194
+ */
195
+ this.deleteProjectAsynchronously = ({ projectIdOrKey, }) => {
196
+ return this.getClientInstance()
197
+ .request({
198
+ path: "/rest/api/3/project/{projectIdOrKey}/delete",
199
+ method: "POST",
200
+ pathParams: {
201
+ projectIdOrKey,
202
+ },
203
+ })
204
+ .then(commonHttpClient.discardResult);
205
+ };
206
+ /**
207
+ * Returns all projects visible to the user. Deprecated, use [ Get projects
208
+ * paginated](#api-rest-api-3-project-search-get) that supports search and
209
+ * pagination.
210
+ *
211
+ * This operation can be accessed anonymously.
212
+ *
213
+ * **[Permissions](#permissions) required:** Projects are returned only where the
214
+ * user has *Browse Projects* or *Administer projects* [project
215
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
216
+ *
217
+ * @deprecated
218
+ * @returns Returned if the request is successful.
219
+ *
220
+ * example: [
221
+ * {
222
+ * "avatarUrls": {
223
+ * "16x16":
224
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
225
+ * "24x24":
226
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
227
+ * "32x32":
228
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
229
+ * "48x48":
230
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
231
+ * },
232
+ * "id": "10000",
233
+ * "insight": {
234
+ * "lastIssueUpdateTime": 1619069825000,
235
+ * "totalIssueCount": 100
236
+ * },
237
+ * "key": "EX",
238
+ * "name": "Example",
239
+ * "projectCategory": {
240
+ * "description": "First Project Category",
241
+ * "id": "10000",
242
+ * "name": "FIRST",
243
+ * "self":
244
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
245
+ * },
246
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
247
+ * "simplified": false,
248
+ * "style": "CLASSIC"
249
+ * },
250
+ * {
251
+ * "avatarUrls": {
252
+ * "16x16":
253
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
254
+ * "24x24":
255
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
256
+ * "32x32":
257
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
258
+ * "48x48":
259
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
260
+ * },
261
+ * "id": "10001",
262
+ * "insight": {
263
+ * "lastIssueUpdateTime": 1619069825000,
264
+ * "totalIssueCount": 100
265
+ * },
266
+ * "key": "ABC",
267
+ * "name": "Alphabetical",
268
+ * "projectCategory": {
269
+ * "description": "First Project Category",
270
+ * "id": "10000",
271
+ * "name": "FIRST",
272
+ * "self":
273
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
274
+ * },
275
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
276
+ * "simplified": false,
277
+ * "style": "CLASSIC"
278
+ * }
279
+ * ]
280
+ * @path {GET} /rest/api/3/project
281
+ * @scopes-current read:jira-work
282
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
283
+ * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
284
+ * read:issue-type-hierarchy:jira, read:project-category:jira,
285
+ * read:project-version:jira, read:project.component:jira
286
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-get
287
+ */
288
+ this.getAllProjects = ({ expand, recent, properties, } = {}) => {
289
+ return this.getClientInstance()
290
+ .request({
291
+ path: "/rest/api/3/project",
292
+ method: "GET",
293
+ query: {
294
+ expand,
295
+ recent,
296
+ properties,
297
+ },
298
+ })
299
+ .then(this.getClientInstance().responseHandler({
300
+ 200: {
301
+ "application/json": "json",
302
+ },
303
+ }))
304
+ .then(commonHttpClient.castResponse())
305
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getAllProjects.response"))
306
+ .then(commonHttpClient.getBody);
307
+ };
308
+ /**
309
+ * Returns the valid statuses for a project. The statuses are grouped by issue
310
+ * type, as each project has a set of valid issue types and each issue type has a
311
+ * set of valid statuses.
312
+ *
313
+ * This operation can be accessed anonymously.
314
+ *
315
+ * **[Permissions](#permissions) required:** *Browse Projects* [project
316
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
317
+ *
318
+ * @returns Returned if the request is successful.
319
+ *
320
+ * example: [
321
+ * {
322
+ * "id": "3",
323
+ * "name": "Task",
324
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
325
+ * "statuses": [
326
+ * {
327
+ * "description": "The issue is currently being worked on.",
328
+ * "iconUrl":
329
+ * "https://your-domain.atlassian.net/images/icons/progress.gif",
330
+ * "id": "10000",
331
+ * "name": "In Progress",
332
+ * "self": "https://your-domain.atlassian.net/rest/api/3/status/10000"
333
+ * },
334
+ * {
335
+ * "description": "The issue is closed.",
336
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
337
+ * "id": "5",
338
+ * "name": "Closed",
339
+ * "self": "https://your-domain.atlassian.net/rest/api/3/status/5"
340
+ * }
341
+ * ],
342
+ * "subtask": false
343
+ * }
344
+ * ]
345
+ * @path {GET} /rest/api/3/project/{projectIdOrKey}/statuses
346
+ * @scopes-current read:jira-work
347
+ * @scopes-beta read:issue-status:jira, read:issue-type:jira, read:status:jira
348
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-statuses-get
349
+ */
350
+ this.getAllStatuses = ({ projectIdOrKey, }) => {
351
+ return this.getClientInstance()
352
+ .request({
353
+ path: "/rest/api/3/project/{projectIdOrKey}/statuses",
354
+ method: "GET",
355
+ pathParams: {
356
+ projectIdOrKey,
357
+ },
358
+ })
359
+ .then(this.getClientInstance().responseHandler({
360
+ 200: {
361
+ "application/json": "json",
362
+ },
363
+ }))
364
+ .then(commonHttpClient.castResponse())
365
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getAllStatuses.response"))
366
+ .then(commonHttpClient.getBody);
367
+ };
368
+ /**
369
+ * Get the issue type hierarchy for a next-gen project.
370
+ *
371
+ * The issue type hierarchy for a project consists of:
372
+ *
373
+ * * *Epic* at level 1 (optional).
374
+ * * One or more issue types at level 0 such as *Story*, *Task*, or *Bug*. Where
375
+ * the issue type *Epic* is defined, these issue types are used to break down the
376
+ * content of an epic.
377
+ * * *Subtask* at level -1 (optional). This issue type enables level 0 issue
378
+ * types to be broken down into components. Issues based on a level -1 issue type
379
+ * must have a parent issue.
380
+ *
381
+ * **[Permissions](#permissions) required:** *Browse projects* [project
382
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
383
+ *
384
+ * @returns Returned if the request is successful.
385
+ *
386
+ * example: {
387
+ * "hierarchy": [
388
+ * {
389
+ * "issueTypes": [
390
+ * {
391
+ * "avatarId": 10324,
392
+ * "entityId": "ce32639b-8911-4689-81da-65681f451516",
393
+ * "id": 10008,
394
+ * "name": "Story"
395
+ * },
396
+ * {
397
+ * "avatarId": 10324,
398
+ * "entityId": "ffdbced5-fbfc-4370-a848-94e2ce3751af",
399
+ * "id": 10001,
400
+ * "name": "Bug"
401
+ * }
402
+ * ],
403
+ * "level": 0,
404
+ * "name": "Base"
405
+ * },
406
+ * {
407
+ * "issueTypes": [
408
+ * {
409
+ * "avatarId": 10179,
410
+ * "entityId": "80f20d47-34dc-4680-8937-936b7e762a35",
411
+ * "id": 10007,
412
+ * "name": "Epic"
413
+ * }
414
+ * ],
415
+ * "level": 1,
416
+ * "name": "Epic"
417
+ * },
418
+ * {
419
+ * "issueTypes": [
420
+ * {
421
+ * "avatarId": 10573,
422
+ * "entityId": "210b4879-15cc-414c-9746-f8f6b6be0a72",
423
+ * "id": 10009,
424
+ * "name": "Subtask"
425
+ * }
426
+ * ],
427
+ * "level": -1,
428
+ * "name": "Subtask"
429
+ * }
430
+ * ],
431
+ * "projectId": 10030
432
+ * }
433
+ * @path {GET} /rest/api/3/project/{projectId}/hierarchy
434
+ * @scopes-current read:jira-work
435
+ * @scopes-beta read:issue-type:jira, read:issue-type-hierarchy:jira
436
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectid-hierarchy-get
437
+ */
438
+ this.getHierarchy = ({ projectId, }) => {
439
+ return this.getClientInstance()
440
+ .request({
441
+ path: "/rest/api/3/project/{projectId}/hierarchy",
442
+ method: "GET",
443
+ pathParams: {
444
+ projectId,
445
+ },
446
+ })
447
+ .then(this.getClientInstance().responseHandler({
448
+ 200: {
449
+ "application/json": "json",
450
+ },
451
+ }))
452
+ .then(commonHttpClient.castResponse())
453
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getHierarchy.response"))
454
+ .then(commonHttpClient.getBody);
455
+ };
456
+ /**
457
+ * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg)
458
+ * associated with the project.
459
+ *
460
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
461
+ * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
462
+ * [project permission](https://confluence.atlassian.com/x/yodKLg).
463
+ *
464
+ * @returns Returned if the request is successful.
465
+ *
466
+ * example: {
467
+ * "description": "description",
468
+ * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
469
+ * "id": 10100,
470
+ * "name": "notification scheme name",
471
+ * "notificationSchemeEvents": [
472
+ * {
473
+ * "event": {
474
+ * "description": "Event published when an issue is created",
475
+ * "id": 1,
476
+ * "name": "Issue created"
477
+ * },
478
+ * "notifications": [
479
+ * {
480
+ * "expand": "group",
481
+ * "group": {
482
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
483
+ * "name": "jira-administrators",
484
+ * "self":
485
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
486
+ * },
487
+ * "id": 1,
488
+ * "notificationType": "Group",
489
+ * "parameter": "jira-administrators",
490
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
491
+ * },
492
+ * {
493
+ * "id": 2,
494
+ * "notificationType": "CurrentAssignee"
495
+ * },
496
+ * {
497
+ * "expand": "projectRole",
498
+ * "id": 3,
499
+ * "notificationType": "ProjectRole",
500
+ * "parameter": "10360",
501
+ * "projectRole": {
502
+ * "self":
503
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
504
+ * "name": "Developers",
505
+ * "id": 10360,
506
+ * "description": "A project role that represents developers in a
507
+ * project",
508
+ * "actors": [
509
+ * {
510
+ * "actorGroup": {
511
+ * "name": "jira-developers",
512
+ * "displayName": "jira-developers",
513
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
514
+ * },
515
+ * "displayName": "jira-developers",
516
+ * "id": 10240,
517
+ * "name": "jira-developers",
518
+ * "type": "atlassian-group-role-actor"
519
+ * },
520
+ * {
521
+ * "actorUser": {
522
+ * "accountId": "5b10a2844c20165700ede21g"
523
+ * },
524
+ * "displayName": "Mia Krystof",
525
+ * "id": 10241,
526
+ * "type": "atlassian-user-role-actor"
527
+ * }
528
+ * ],
529
+ * "scope": {
530
+ * "project": {
531
+ * "id": "10000",
532
+ * "key": "KEY",
533
+ * "name": "Next Gen Project"
534
+ * },
535
+ * "type": "PROJECT"
536
+ * }
537
+ * },
538
+ * "recipient": "10360"
539
+ * },
540
+ * {
541
+ * "emailAddress": "rest-developer@atlassian.com",
542
+ * "id": 4,
543
+ * "notificationType": "EmailAddress",
544
+ * "parameter": "rest-developer@atlassian.com",
545
+ * "recipient": "rest-developer@atlassian.com"
546
+ * },
547
+ * {
548
+ * "expand": "user",
549
+ * "id": 5,
550
+ * "notificationType": "User",
551
+ * "parameter": "5b10a2844c20165700ede21g",
552
+ * "recipient": "5b10a2844c20165700ede21g",
553
+ * "user": {
554
+ * "accountId": "5b10a2844c20165700ede21g",
555
+ * "active": false,
556
+ * "displayName": "Mia Krystof",
557
+ * "self":
558
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
559
+ * }
560
+ * },
561
+ * {
562
+ * "expand": "field",
563
+ * "field": {
564
+ * "clauseNames": [
565
+ * "cf[10101]",
566
+ * "New custom field"
567
+ * ],
568
+ * "custom": true,
569
+ * "id": "customfield_10101",
570
+ * "key": "customfield_10101",
571
+ * "name": "New custom field",
572
+ * "navigable": true,
573
+ * "orderable": true,
574
+ * "schema": {
575
+ * "custom":
576
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
577
+ * "customId": 10101,
578
+ * "type": "project"
579
+ * },
580
+ * "searchable": true,
581
+ * "untranslatedName": "New custom field"
582
+ * },
583
+ * "id": 6,
584
+ * "notificationType": "GroupCustomField",
585
+ * "parameter": "customfield_10101",
586
+ * "recipient": "customfield_10101"
587
+ * }
588
+ * ]
589
+ * },
590
+ * {
591
+ * "event": {
592
+ * "description": "Custom event that is published together with an issue
593
+ * created event",
594
+ * "id": 20,
595
+ * "name": "Custom event",
596
+ * "templateEvent": {
597
+ * "description": "Event published when an issue is created",
598
+ * "id": 1,
599
+ * "name": "Issue created"
600
+ * }
601
+ * },
602
+ * "notifications": [
603
+ * {
604
+ * "expand": "group",
605
+ * "group": {
606
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
607
+ * "name": "jira-administrators",
608
+ * "self":
609
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
610
+ * },
611
+ * "id": 1,
612
+ * "notificationType": "Group",
613
+ * "parameter": "jira-administrators",
614
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
615
+ * },
616
+ * {
617
+ * "id": 2,
618
+ * "notificationType": "CurrentAssignee"
619
+ * },
620
+ * {
621
+ * "expand": "projectRole",
622
+ * "id": 3,
623
+ * "notificationType": "ProjectRole",
624
+ * "parameter": "10360",
625
+ * "projectRole": {
626
+ * "self":
627
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
628
+ * "name": "Developers",
629
+ * "id": 10360,
630
+ * "description": "A project role that represents developers in a
631
+ * project",
632
+ * "actors": [
633
+ * {
634
+ * "actorGroup": {
635
+ * "name": "jira-developers",
636
+ * "displayName": "jira-developers",
637
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
638
+ * },
639
+ * "displayName": "jira-developers",
640
+ * "id": 10240,
641
+ * "name": "jira-developers",
642
+ * "type": "atlassian-group-role-actor"
643
+ * },
644
+ * {
645
+ * "actorUser": {
646
+ * "accountId": "5b10a2844c20165700ede21g"
647
+ * },
648
+ * "displayName": "Mia Krystof",
649
+ * "id": 10241,
650
+ * "type": "atlassian-user-role-actor"
651
+ * }
652
+ * ],
653
+ * "scope": {
654
+ * "project": {
655
+ * "id": "10000",
656
+ * "key": "KEY",
657
+ * "name": "Next Gen Project"
658
+ * },
659
+ * "type": "PROJECT"
660
+ * }
661
+ * },
662
+ * "recipient": "10360"
663
+ * },
664
+ * {
665
+ * "emailAddress": "rest-developer@atlassian.com",
666
+ * "id": 4,
667
+ * "notificationType": "EmailAddress",
668
+ * "parameter": "rest-developer@atlassian.com",
669
+ * "recipient": "rest-developer@atlassian.com"
670
+ * },
671
+ * {
672
+ * "expand": "user",
673
+ * "id": 5,
674
+ * "notificationType": "User",
675
+ * "parameter": "5b10a2844c20165700ede21g",
676
+ * "recipient": "5b10a2844c20165700ede21g",
677
+ * "user": {
678
+ * "accountId": "5b10a2844c20165700ede21g",
679
+ * "active": false,
680
+ * "displayName": "Mia Krystof",
681
+ * "self":
682
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
683
+ * }
684
+ * },
685
+ * {
686
+ * "expand": "field",
687
+ * "field": {
688
+ * "clauseNames": [
689
+ * "cf[10101]",
690
+ * "New custom field"
691
+ * ],
692
+ * "custom": true,
693
+ * "id": "customfield_10101",
694
+ * "key": "customfield_10101",
695
+ * "name": "New custom field",
696
+ * "navigable": true,
697
+ * "orderable": true,
698
+ * "schema": {
699
+ * "custom":
700
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
701
+ * "customId": 10101,
702
+ * "type": "project"
703
+ * },
704
+ * "searchable": true,
705
+ * "untranslatedName": "New custom field"
706
+ * },
707
+ * "id": 6,
708
+ * "notificationType": "GroupCustomField",
709
+ * "parameter": "customfield_10101",
710
+ * "recipient": "customfield_10101"
711
+ * }
712
+ * ]
713
+ * }
714
+ * ],
715
+ * "projects": [
716
+ * 10001,
717
+ * 10002
718
+ * ],
719
+ * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
720
+ * }
721
+ * @path {GET} /rest/api/3/project/{projectKeyOrId}/notificationscheme
722
+ * @scopes-current read:jira-work
723
+ * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
724
+ * read:user:jira, read:group:jira, read:field:jira, read:avatar:jira,
725
+ * read:field-configuration:jira, read:notification-scheme:jira
726
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectkeyorid-notificationscheme-get
727
+ */
728
+ this.getNotificationSchemeForProject = ({ projectKeyOrId, expand, }) => {
729
+ return this.getClientInstance()
730
+ .request({
731
+ path: "/rest/api/3/project/{projectKeyOrId}/notificationscheme",
732
+ method: "GET",
733
+ pathParams: {
734
+ projectKeyOrId,
735
+ },
736
+ query: {
737
+ expand,
738
+ },
739
+ })
740
+ .then(this.getClientInstance().responseHandler({
741
+ 200: {
742
+ "application/json": "json",
743
+ },
744
+ }))
745
+ .then(commonHttpClient.castResponse())
746
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getNotificationSchemeForProject.response"))
747
+ .then(commonHttpClient.getBody);
748
+ };
749
+ /**
750
+ * Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a
751
+ * project.
752
+ *
753
+ * This operation can be accessed anonymously.
754
+ *
755
+ * **[Permissions](#permissions) required:** *Browse projects* [project
756
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
757
+ *
758
+ * @returns Returned if successful.
759
+ *
760
+ * example: {
761
+ * "assigneeType": "PROJECT_LEAD",
762
+ * "avatarUrls": {
763
+ * "16x16":
764
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
765
+ * "24x24":
766
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
767
+ * "32x32":
768
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
769
+ * "48x48":
770
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
771
+ * },
772
+ * "components": [
773
+ * {
774
+ * "ari":
775
+ * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
776
+ * "assignee": {
777
+ * "accountId": "5b10a2844c20165700ede21g",
778
+ * "accountType": "atlassian",
779
+ * "active": false,
780
+ * "avatarUrls": {
781
+ * "16x16":
782
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
783
+ * "24x24":
784
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
785
+ * "32x32":
786
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
787
+ * "48x48":
788
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
789
+ * },
790
+ * "displayName": "Mia Krystof",
791
+ * "key": "",
792
+ * "name": "",
793
+ * "self":
794
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
795
+ * },
796
+ * "assigneeType": "PROJECT_LEAD",
797
+ * "description": "This is a Jira component",
798
+ * "id": "10000",
799
+ * "isAssigneeTypeValid": false,
800
+ * "lead": {
801
+ * "accountId": "5b10a2844c20165700ede21g",
802
+ * "accountType": "atlassian",
803
+ * "active": false,
804
+ * "avatarUrls": {
805
+ * "16x16":
806
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
807
+ * "24x24":
808
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
809
+ * "32x32":
810
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
811
+ * "48x48":
812
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
813
+ * },
814
+ * "displayName": "Mia Krystof",
815
+ * "key": "",
816
+ * "name": "",
817
+ * "self":
818
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
819
+ * },
820
+ * "metadata": {
821
+ * "icon": "https://www.example.com/icon.png"
822
+ * },
823
+ * "name": "Component 1",
824
+ * "project": "HSP",
825
+ * "projectId": 10000,
826
+ * "realAssignee": {
827
+ * "accountId": "5b10a2844c20165700ede21g",
828
+ * "accountType": "atlassian",
829
+ * "active": false,
830
+ * "avatarUrls": {
831
+ * "16x16":
832
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
833
+ * "24x24":
834
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
835
+ * "32x32":
836
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
837
+ * "48x48":
838
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
839
+ * },
840
+ * "displayName": "Mia Krystof",
841
+ * "key": "",
842
+ * "name": "",
843
+ * "self":
844
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
845
+ * },
846
+ * "realAssigneeType": "PROJECT_LEAD",
847
+ * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
848
+ * }
849
+ * ],
850
+ * "description": "This project was created as an example for REST.",
851
+ * "email": "from-jira@example.com",
852
+ * "id": "10000",
853
+ * "insight": {
854
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
855
+ * "totalIssueCount": 100
856
+ * },
857
+ * "issueTypes": [
858
+ * {
859
+ * "avatarId": 1,
860
+ * "description": "A task that needs to be done.",
861
+ * "hierarchyLevel": 0,
862
+ * "iconUrl":
863
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
864
+ * "id": "3",
865
+ * "name": "Task",
866
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
867
+ * "subtask": false
868
+ * },
869
+ * {
870
+ * "avatarId": 10002,
871
+ * "description": "A problem with the software.",
872
+ * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
873
+ * "hierarchyLevel": 0,
874
+ * "iconUrl":
875
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
876
+ * "id": "1",
877
+ * "name": "Bug",
878
+ * "scope": {
879
+ * "project": {
880
+ * "id": "10000"
881
+ * },
882
+ * "type": "PROJECT"
883
+ * },
884
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
885
+ * "subtask": false
886
+ * }
887
+ * ],
888
+ * "key": "EX",
889
+ * "lead": {
890
+ * "accountId": "5b10a2844c20165700ede21g",
891
+ * "accountType": "atlassian",
892
+ * "active": false,
893
+ * "avatarUrls": {
894
+ * "16x16":
895
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
896
+ * "24x24":
897
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
898
+ * "32x32":
899
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
900
+ * "48x48":
901
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
902
+ * },
903
+ * "displayName": "Mia Krystof",
904
+ * "key": "",
905
+ * "name": "",
906
+ * "self":
907
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
908
+ * },
909
+ * "name": "Example",
910
+ * "projectCategory": {
911
+ * "description": "First Project Category",
912
+ * "id": "10000",
913
+ * "name": "FIRST",
914
+ * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
915
+ * },
916
+ * "properties": {
917
+ * "propertyKey": "propertyValue"
918
+ * },
919
+ * "roles": {
920
+ * "Developers":
921
+ * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
922
+ * },
923
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
924
+ * "simplified": false,
925
+ * "style": "classic",
926
+ * "url": "https://www.example.com",
927
+ * "versions": []
928
+ * }
929
+ * @path {GET} /rest/api/3/project/{projectIdOrKey}
930
+ * @scopes-current read:jira-work
931
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
932
+ * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
933
+ * read:issue-type-hierarchy:jira, read:project-category:jira,
934
+ * read:project-version:jira, read:project.component:jira
935
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-get
936
+ */
937
+ this.getProject = ({ projectIdOrKey, expand, properties, }) => {
938
+ return this.getClientInstance()
939
+ .request({
940
+ path: "/rest/api/3/project/{projectIdOrKey}",
941
+ method: "GET",
942
+ pathParams: {
943
+ projectIdOrKey,
944
+ },
945
+ query: {
946
+ expand,
947
+ properties,
948
+ },
949
+ })
950
+ .then(this.getClientInstance().responseHandler({
951
+ 200: {
952
+ "application/json": "json",
953
+ },
954
+ }))
955
+ .then(commonHttpClient.castResponse())
956
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getProject.response"))
957
+ .then(commonHttpClient.getBody);
958
+ };
959
+ /**
960
+ * Returns a list of up to 20 projects recently viewed by the user that are still
961
+ * visible to the user.
962
+ *
963
+ * This operation can be accessed anonymously.
964
+ *
965
+ * **[Permissions](#permissions) required:** Projects are returned only where the
966
+ * user has one of:
967
+ *
968
+ * * *Browse Projects* [project
969
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
970
+ * * *Administer Projects* [project
971
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
972
+ * * *Administer Jira* [global
973
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
974
+ *
975
+ * @returns Returned if the request is successful.
976
+ *
977
+ * example: [
978
+ * {
979
+ * "avatarUrls": {
980
+ * "16x16":
981
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
982
+ * "24x24":
983
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
984
+ * "32x32":
985
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
986
+ * "48x48":
987
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
988
+ * },
989
+ * "id": "10000",
990
+ * "insight": {
991
+ * "lastIssueUpdateTime": 1619069825000,
992
+ * "totalIssueCount": 100
993
+ * },
994
+ * "key": "EX",
995
+ * "name": "Example",
996
+ * "projectCategory": {
997
+ * "description": "First Project Category",
998
+ * "id": "10000",
999
+ * "name": "FIRST",
1000
+ * "self":
1001
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1002
+ * },
1003
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1004
+ * "simplified": false,
1005
+ * "style": "CLASSIC"
1006
+ * },
1007
+ * {
1008
+ * "avatarUrls": {
1009
+ * "16x16":
1010
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
1011
+ * "24x24":
1012
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
1013
+ * "32x32":
1014
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
1015
+ * "48x48":
1016
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
1017
+ * },
1018
+ * "id": "10001",
1019
+ * "insight": {
1020
+ * "lastIssueUpdateTime": 1619069825000,
1021
+ * "totalIssueCount": 100
1022
+ * },
1023
+ * "key": "ABC",
1024
+ * "name": "Alphabetical",
1025
+ * "projectCategory": {
1026
+ * "description": "First Project Category",
1027
+ * "id": "10000",
1028
+ * "name": "FIRST",
1029
+ * "self":
1030
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1031
+ * },
1032
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
1033
+ * "simplified": false,
1034
+ * "style": "CLASSIC"
1035
+ * }
1036
+ * ]
1037
+ * @path {GET} /rest/api/3/project/recent
1038
+ * @scopes-current read:jira-work
1039
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1040
+ * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
1041
+ * read:issue-type-hierarchy:jira, read:project-category:jira,
1042
+ * read:project-version:jira, read:project.component:jira
1043
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-recent-get
1044
+ */
1045
+ this.getRecent = ({ expand, properties, } = {}) => {
1046
+ return this.getClientInstance()
1047
+ .request({
1048
+ path: "/rest/api/3/project/recent",
1049
+ method: "GET",
1050
+ query: {
1051
+ expand,
1052
+ properties,
1053
+ },
1054
+ })
1055
+ .then(this.getClientInstance().responseHandler({
1056
+ 200: {
1057
+ "application/json": "json",
1058
+ },
1059
+ }))
1060
+ .then(commonHttpClient.castResponse())
1061
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.getRecent.response"))
1062
+ .then(commonHttpClient.getBody);
1063
+ };
1064
+ /**
1065
+ * Restores a project that has been archived or placed in the Jira recycle bin.
1066
+ *
1067
+ * **[Permissions](#permissions) required:**
1068
+ *
1069
+ * * *Administer Jira* [global
1070
+ * permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed
1071
+ * projects.
1072
+ * * *Administer Jira* [global
1073
+ * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
1074
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
1075
+ * for Team managed projects.
1076
+ *
1077
+ * @returns Returned if the request is successful.
1078
+ *
1079
+ * example: {
1080
+ * "assigneeType": "PROJECT_LEAD",
1081
+ * "avatarUrls": {
1082
+ * "16x16":
1083
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1084
+ * "24x24":
1085
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1086
+ * "32x32":
1087
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1088
+ * "48x48":
1089
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1090
+ * },
1091
+ * "components": [
1092
+ * {
1093
+ * "ari":
1094
+ * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
1095
+ * "assignee": {
1096
+ * "accountId": "5b10a2844c20165700ede21g",
1097
+ * "accountType": "atlassian",
1098
+ * "active": false,
1099
+ * "avatarUrls": {
1100
+ * "16x16":
1101
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1102
+ * "24x24":
1103
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1104
+ * "32x32":
1105
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1106
+ * "48x48":
1107
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1108
+ * },
1109
+ * "displayName": "Mia Krystof",
1110
+ * "key": "",
1111
+ * "name": "",
1112
+ * "self":
1113
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1114
+ * },
1115
+ * "assigneeType": "PROJECT_LEAD",
1116
+ * "description": "This is a Jira component",
1117
+ * "id": "10000",
1118
+ * "isAssigneeTypeValid": false,
1119
+ * "lead": {
1120
+ * "accountId": "5b10a2844c20165700ede21g",
1121
+ * "accountType": "atlassian",
1122
+ * "active": false,
1123
+ * "avatarUrls": {
1124
+ * "16x16":
1125
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1126
+ * "24x24":
1127
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1128
+ * "32x32":
1129
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1130
+ * "48x48":
1131
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1132
+ * },
1133
+ * "displayName": "Mia Krystof",
1134
+ * "key": "",
1135
+ * "name": "",
1136
+ * "self":
1137
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1138
+ * },
1139
+ * "metadata": {
1140
+ * "icon": "https://www.example.com/icon.png"
1141
+ * },
1142
+ * "name": "Component 1",
1143
+ * "project": "HSP",
1144
+ * "projectId": 10000,
1145
+ * "realAssignee": {
1146
+ * "accountId": "5b10a2844c20165700ede21g",
1147
+ * "accountType": "atlassian",
1148
+ * "active": false,
1149
+ * "avatarUrls": {
1150
+ * "16x16":
1151
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1152
+ * "24x24":
1153
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1154
+ * "32x32":
1155
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1156
+ * "48x48":
1157
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1158
+ * },
1159
+ * "displayName": "Mia Krystof",
1160
+ * "key": "",
1161
+ * "name": "",
1162
+ * "self":
1163
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1164
+ * },
1165
+ * "realAssigneeType": "PROJECT_LEAD",
1166
+ * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
1167
+ * }
1168
+ * ],
1169
+ * "description": "This project was created as an example for REST.",
1170
+ * "email": "from-jira@example.com",
1171
+ * "id": "10000",
1172
+ * "insight": {
1173
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1174
+ * "totalIssueCount": 100
1175
+ * },
1176
+ * "issueTypes": [
1177
+ * {
1178
+ * "avatarId": 1,
1179
+ * "description": "A task that needs to be done.",
1180
+ * "hierarchyLevel": 0,
1181
+ * "iconUrl":
1182
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
1183
+ * "id": "3",
1184
+ * "name": "Task",
1185
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
1186
+ * "subtask": false
1187
+ * },
1188
+ * {
1189
+ * "avatarId": 10002,
1190
+ * "description": "A problem with the software.",
1191
+ * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
1192
+ * "hierarchyLevel": 0,
1193
+ * "iconUrl":
1194
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
1195
+ * "id": "1",
1196
+ * "name": "Bug",
1197
+ * "scope": {
1198
+ * "project": {
1199
+ * "id": "10000"
1200
+ * },
1201
+ * "type": "PROJECT"
1202
+ * },
1203
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1204
+ * "subtask": false
1205
+ * }
1206
+ * ],
1207
+ * "key": "EX",
1208
+ * "lead": {
1209
+ * "accountId": "5b10a2844c20165700ede21g",
1210
+ * "accountType": "atlassian",
1211
+ * "active": false,
1212
+ * "avatarUrls": {
1213
+ * "16x16":
1214
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1215
+ * "24x24":
1216
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1217
+ * "32x32":
1218
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1219
+ * "48x48":
1220
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1221
+ * },
1222
+ * "displayName": "Mia Krystof",
1223
+ * "key": "",
1224
+ * "name": "",
1225
+ * "self":
1226
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1227
+ * },
1228
+ * "name": "Example",
1229
+ * "projectCategory": {
1230
+ * "description": "First Project Category",
1231
+ * "id": "10000",
1232
+ * "name": "FIRST",
1233
+ * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1234
+ * },
1235
+ * "properties": {
1236
+ * "propertyKey": "propertyValue"
1237
+ * },
1238
+ * "roles": {
1239
+ * "Developers":
1240
+ * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
1241
+ * },
1242
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1243
+ * "simplified": false,
1244
+ * "style": "classic",
1245
+ * "url": "https://www.example.com",
1246
+ * "versions": []
1247
+ * }
1248
+ * @path {POST} /rest/api/3/project/{projectIdOrKey}/restore
1249
+ * @scopes-current manage:jira-configuration
1250
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1251
+ * read:user:jira, write:project:jira, read:application-role:jira,
1252
+ * read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira,
1253
+ * read:project-category:jira, read:project-version:jira,
1254
+ * read:project.component:jira
1255
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-restore-post
1256
+ */
1257
+ this.restore = ({ projectIdOrKey, }) => {
1258
+ return this.getClientInstance()
1259
+ .request({
1260
+ path: "/rest/api/3/project/{projectIdOrKey}/restore",
1261
+ method: "POST",
1262
+ pathParams: {
1263
+ projectIdOrKey,
1264
+ },
1265
+ })
1266
+ .then(this.getClientInstance().responseHandler({
1267
+ 200: {
1268
+ "application/json": "json",
1269
+ },
1270
+ }))
1271
+ .then(commonHttpClient.castResponse())
1272
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.restore.response"))
1273
+ .then(commonHttpClient.getBody);
1274
+ };
1275
+ /**
1276
+ * Returns a [paginated](#pagination) list of projects visible to the user.
1277
+ *
1278
+ * This operation can be accessed anonymously.
1279
+ *
1280
+ * **[Permissions](#permissions) required:** Projects are returned only where the
1281
+ * user has one of:
1282
+ *
1283
+ * * *Browse Projects* [project
1284
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
1285
+ * * *Administer Projects* [project
1286
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
1287
+ * * *Administer Jira* [global
1288
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
1289
+ *
1290
+ * @returns Returned if the request is successful.
1291
+ *
1292
+ * example: {
1293
+ * "isLast": false,
1294
+ * "maxResults": 2,
1295
+ * "nextPage":
1296
+ * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
1297
+ * "self":
1298
+ * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
1299
+ * "startAt": 0,
1300
+ * "total": 7,
1301
+ * "values": [
1302
+ * {
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
+ * {
1332
+ * "avatarUrls": {
1333
+ * "16x16":
1334
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
1335
+ * "24x24":
1336
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
1337
+ * "32x32":
1338
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
1339
+ * "48x48":
1340
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
1341
+ * },
1342
+ * "id": "10001",
1343
+ * "insight": {
1344
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1345
+ * "totalIssueCount": 100
1346
+ * },
1347
+ * "key": "ABC",
1348
+ * "name": "Alphabetical",
1349
+ * "projectCategory": {
1350
+ * "description": "First Project Category",
1351
+ * "id": "10000",
1352
+ * "name": "FIRST",
1353
+ * "self":
1354
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1355
+ * },
1356
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC",
1357
+ * "simplified": false,
1358
+ * "style": "classic"
1359
+ * }
1360
+ * ]
1361
+ * }
1362
+ * @path {GET} /rest/api/3/project/search
1363
+ * @scopes-current read:jira-work
1364
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1365
+ * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
1366
+ * read:issue-type-hierarchy:jira, read:project-category:jira,
1367
+ * read:project-version:jira, read:project.component:jira
1368
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-search-get
1369
+ */
1370
+ this.searchProjects = ({ startAt, maxResults, orderBy, id, keys, query, typeKey, categoryId, action, expand, status, properties, propertyQuery, } = {}) => {
1371
+ return this.getClientInstance()
1372
+ .request({
1373
+ path: "/rest/api/3/project/search",
1374
+ method: "GET",
1375
+ query: {
1376
+ startAt,
1377
+ maxResults,
1378
+ orderBy,
1379
+ id,
1380
+ keys,
1381
+ query,
1382
+ typeKey,
1383
+ categoryId,
1384
+ action,
1385
+ expand,
1386
+ status,
1387
+ properties,
1388
+ propertyQuery,
1389
+ },
1390
+ })
1391
+ .then(this.getClientInstance().responseHandler({
1392
+ 200: {
1393
+ "application/json": "json",
1394
+ },
1395
+ }))
1396
+ .then(commonHttpClient.castResponse())
1397
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.searchProjects.response"))
1398
+ .then(commonHttpClient.getBody);
1399
+ };
1400
+ /**
1401
+ * Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a
1402
+ * project.
1403
+ *
1404
+ * All parameters are optional in the body of the request. Schemes will only be
1405
+ * updated if they are included in the request, any omitted schemes will be left
1406
+ * unchanged.
1407
+ *
1408
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
1409
+ * permission](https://confluence.atlassian.com/x/x4dKLg). is only needed when
1410
+ * changing the schemes or project key. Otherwise you will only need *Administer
1411
+ * Projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
1412
+ *
1413
+ * @returns Returned if the project is updated.
1414
+ *
1415
+ * example: {
1416
+ * "assigneeType": "PROJECT_LEAD",
1417
+ * "avatarUrls": {
1418
+ * "16x16":
1419
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1420
+ * "24x24":
1421
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1422
+ * "32x32":
1423
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1424
+ * "48x48":
1425
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1426
+ * },
1427
+ * "components": [
1428
+ * {
1429
+ * "ari":
1430
+ * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
1431
+ * "assignee": {
1432
+ * "accountId": "5b10a2844c20165700ede21g",
1433
+ * "accountType": "atlassian",
1434
+ * "active": false,
1435
+ * "avatarUrls": {
1436
+ * "16x16":
1437
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1438
+ * "24x24":
1439
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1440
+ * "32x32":
1441
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1442
+ * "48x48":
1443
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1444
+ * },
1445
+ * "displayName": "Mia Krystof",
1446
+ * "key": "",
1447
+ * "name": "",
1448
+ * "self":
1449
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1450
+ * },
1451
+ * "assigneeType": "PROJECT_LEAD",
1452
+ * "description": "This is a Jira component",
1453
+ * "id": "10000",
1454
+ * "isAssigneeTypeValid": false,
1455
+ * "lead": {
1456
+ * "accountId": "5b10a2844c20165700ede21g",
1457
+ * "accountType": "atlassian",
1458
+ * "active": false,
1459
+ * "avatarUrls": {
1460
+ * "16x16":
1461
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1462
+ * "24x24":
1463
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1464
+ * "32x32":
1465
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1466
+ * "48x48":
1467
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1468
+ * },
1469
+ * "displayName": "Mia Krystof",
1470
+ * "key": "",
1471
+ * "name": "",
1472
+ * "self":
1473
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1474
+ * },
1475
+ * "metadata": {
1476
+ * "icon": "https://www.example.com/icon.png"
1477
+ * },
1478
+ * "name": "Component 1",
1479
+ * "project": "HSP",
1480
+ * "projectId": 10000,
1481
+ * "realAssignee": {
1482
+ * "accountId": "5b10a2844c20165700ede21g",
1483
+ * "accountType": "atlassian",
1484
+ * "active": false,
1485
+ * "avatarUrls": {
1486
+ * "16x16":
1487
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1488
+ * "24x24":
1489
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1490
+ * "32x32":
1491
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1492
+ * "48x48":
1493
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1494
+ * },
1495
+ * "displayName": "Mia Krystof",
1496
+ * "key": "",
1497
+ * "name": "",
1498
+ * "self":
1499
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1500
+ * },
1501
+ * "realAssigneeType": "PROJECT_LEAD",
1502
+ * "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
1503
+ * }
1504
+ * ],
1505
+ * "description": "This project was created as an example for REST.",
1506
+ * "email": "from-jira@example.com",
1507
+ * "id": "10000",
1508
+ * "insight": {
1509
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1510
+ * "totalIssueCount": 100
1511
+ * },
1512
+ * "issueTypes": [
1513
+ * {
1514
+ * "avatarId": 1,
1515
+ * "description": "A task that needs to be done.",
1516
+ * "hierarchyLevel": 0,
1517
+ * "iconUrl":
1518
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
1519
+ * "id": "3",
1520
+ * "name": "Task",
1521
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
1522
+ * "subtask": false
1523
+ * },
1524
+ * {
1525
+ * "avatarId": 10002,
1526
+ * "description": "A problem with the software.",
1527
+ * "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
1528
+ * "hierarchyLevel": 0,
1529
+ * "iconUrl":
1530
+ * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
1531
+ * "id": "1",
1532
+ * "name": "Bug",
1533
+ * "scope": {
1534
+ * "project": {
1535
+ * "id": "10000"
1536
+ * },
1537
+ * "type": "PROJECT"
1538
+ * },
1539
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
1540
+ * "subtask": false
1541
+ * }
1542
+ * ],
1543
+ * "key": "EX",
1544
+ * "lead": {
1545
+ * "accountId": "5b10a2844c20165700ede21g",
1546
+ * "accountType": "atlassian",
1547
+ * "active": false,
1548
+ * "avatarUrls": {
1549
+ * "16x16":
1550
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1551
+ * "24x24":
1552
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1553
+ * "32x32":
1554
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1555
+ * "48x48":
1556
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1557
+ * },
1558
+ * "displayName": "Mia Krystof",
1559
+ * "key": "",
1560
+ * "name": "",
1561
+ * "self":
1562
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1563
+ * },
1564
+ * "name": "Example",
1565
+ * "projectCategory": {
1566
+ * "description": "First Project Category",
1567
+ * "id": "10000",
1568
+ * "name": "FIRST",
1569
+ * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1570
+ * },
1571
+ * "properties": {
1572
+ * "propertyKey": "propertyValue"
1573
+ * },
1574
+ * "roles": {
1575
+ * "Developers":
1576
+ * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
1577
+ * },
1578
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1579
+ * "simplified": false,
1580
+ * "style": "classic",
1581
+ * "url": "https://www.example.com",
1582
+ * "versions": []
1583
+ * }
1584
+ * @path {PUT} /rest/api/3/project/{projectIdOrKey}
1585
+ * @scopes-current manage:jira-project
1586
+ * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
1587
+ * read:user:jira, write:project:jira, write:project.avatar:jira,
1588
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
1589
+ * read:issue-type-hierarchy:jira, read:project-category:jira,
1590
+ * read:project-version:jira, read:project.component:jira
1591
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects#api-rest-api-3-project-projectidorkey-put
1592
+ */
1593
+ this.updateProject = ({ projectIdOrKey, expand, updateProjectDetails, }) => {
1594
+ return this.getClientInstance()
1595
+ .request({
1596
+ path: "/rest/api/3/project/{projectIdOrKey}",
1597
+ method: "PUT",
1598
+ pathParams: {
1599
+ projectIdOrKey,
1600
+ },
1601
+ query: {
1602
+ expand,
1603
+ },
1604
+ headers: {
1605
+ "Content-Type": "application/json",
1606
+ },
1607
+ body: updateProjectDetails,
1608
+ })
1609
+ .then(this.getClientInstance().responseHandler({
1610
+ 200: {
1611
+ "application/json": "json",
1612
+ },
1613
+ }))
1614
+ .then(commonHttpClient.castResponse())
1615
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectsService.updateProject.response"))
1616
+ .then(commonHttpClient.getBody);
1617
+ };
1615
1618
  }
1616
1619
  static initialize() {
1617
1620
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ProjectsService.getAllProjects.response", zod_1.z