@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
@@ -29,902 +29,905 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
29
29
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes
30
30
  */
31
31
  class WorkflowSchemesService extends CommonHttpService_1.CommonHttpService {
32
- /**
33
- * Creates a workflow scheme.
34
- *
35
- * **[Permissions](#permissions) required:** *Administer Jira* [global
36
- * permission](https://confluence.atlassian.com/x/x4dKLg).
37
- *
38
- * @returns Returned if the request is successful.
39
- *
40
- * example: {
41
- * "defaultWorkflow": "jira",
42
- * "description": "The description of the example workflow scheme.",
43
- * "draft": false,
44
- * "id": 101010,
45
- * "issueTypeMappings": {
46
- * "10000": "scrum workflow",
47
- * "10001": "builds workflow"
48
- * },
49
- * "name": "Example workflow scheme",
50
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
51
- * }
52
- * @path {POST} /rest/api/3/workflowscheme
53
- * @scopes-current manage:jira-configuration
54
- * @scopes-beta write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
55
- * read:group:jira, read:issue-type:jira, read:project-category:jira,
56
- * read:project:jira, read:user:jira, read:workflow-scheme:jira
57
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-post
58
- */
59
- createWorkflowScheme({ workflowScheme, }) {
60
- return this.getClientInstance()
61
- .request({
62
- path: "/rest/api/3/workflowscheme",
63
- method: "POST",
64
- headers: {
65
- "Content-Type": "application/json",
66
- },
67
- body: workflowScheme,
68
- })
69
- .then(this.getClientInstance().responseHandler({
70
- 201: {
71
- "application/json": "json",
72
- },
73
- }))
74
- .then(commonHttpClient.castResponse())
75
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.createWorkflowScheme.response"))
76
- .then(commonHttpClient.getBody);
77
- }
78
- /**
79
- * Resets the default workflow for a workflow scheme. That is, the default
80
- * workflow is set to Jira's system workflow (the *jira* workflow).
81
- *
82
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
83
- * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
84
- * created or updated with the default workflow reset. The draft workflow scheme
85
- * can be published in Jira.
86
- *
87
- * **[Permissions](#permissions) required:** *Administer Jira* [global
88
- * permission](https://confluence.atlassian.com/x/x4dKLg).
89
- *
90
- * @returns Returned if the request is successful.
91
- *
92
- * example: {
93
- * "defaultWorkflow": "jira",
94
- * "description": "The description of the example workflow scheme.",
95
- * "draft": false,
96
- * "id": 101010,
97
- * "issueTypeMappings": {
98
- * "10000": "scrum workflow",
99
- * "10001": "builds workflow"
100
- * },
101
- * "name": "Example workflow scheme",
102
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
103
- * }
104
- * @path {DELETE} /rest/api/3/workflowscheme/{id}/default
105
- * @scopes-current manage:jira-configuration
106
- * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
107
- * read:application-role:jira, read:avatar:jira, read:group:jira,
108
- * read:issue-type:jira, read:project-category:jira, read:project:jira,
109
- * read:user:jira
110
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-delete
111
- */
112
- deleteDefaultWorkflow({ id, updateDraftIfNeeded, }) {
113
- return this.getClientInstance()
114
- .request({
115
- path: "/rest/api/3/workflowscheme/{id}/default",
116
- method: "DELETE",
117
- pathParams: {
118
- id,
119
- },
120
- query: {
121
- updateDraftIfNeeded,
122
- },
123
- })
124
- .then(this.getClientInstance().responseHandler({
125
- 200: {
126
- "application/json": "json",
127
- },
128
- }))
129
- .then(commonHttpClient.castResponse())
130
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteDefaultWorkflow.response"))
131
- .then(commonHttpClient.getBody);
132
- }
133
- /**
134
- * Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
135
- *
136
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
137
- * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
138
- * created or updated with the workflow-issue type mapping deleted. The draft
139
- * workflow scheme can be published in Jira.
140
- *
141
- * **[Permissions](#permissions) required:** *Administer Jira* [global
142
- * permission](https://confluence.atlassian.com/x/x4dKLg).
143
- *
144
- * @path {DELETE} /rest/api/3/workflowscheme/{id}/workflow
145
- * @scopes-current manage:jira-configuration
146
- * @scopes-beta delete:workflow-scheme:jira
147
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-delete
148
- */
149
- deleteWorkflowMapping({ id, workflowName, updateDraftIfNeeded, }) {
150
- return this.getClientInstance()
151
- .request({
152
- path: "/rest/api/3/workflowscheme/{id}/workflow",
153
- method: "DELETE",
154
- pathParams: {
155
- id,
156
- },
157
- query: {
158
- workflowName,
159
- updateDraftIfNeeded,
160
- },
161
- })
162
- .then(commonHttpClient.discardResult);
163
- }
164
- /**
165
- * Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it
166
- * is active (that is, being used by at least one project).
167
- *
168
- * **[Permissions](#permissions) required:** *Administer Jira* [global
169
- * permission](https://confluence.atlassian.com/x/x4dKLg).
170
- *
171
- * @returns Returned if the request is successful.
172
- * @path {DELETE} /rest/api/3/workflowscheme/{id}
173
- * @scopes-current manage:jira-configuration
174
- * @scopes-beta delete:workflow-scheme:jira
175
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-delete
176
- */
177
- deleteWorkflowScheme({ id, }) {
178
- return this.getClientInstance()
179
- .request({
180
- path: "/rest/api/3/workflowscheme/{id}",
181
- method: "DELETE",
182
- pathParams: {
183
- id,
184
- },
185
- })
186
- .then(this.getClientInstance().responseHandler({
187
- 204: {
188
- "application/json": "json",
189
- },
190
- }))
191
- .then(commonHttpClient.castResponse())
192
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowScheme.response"))
193
- .then(commonHttpClient.getBody);
194
- }
195
- /**
196
- * Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
197
- *
198
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
199
- * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
200
- * created or updated with the issue type-workflow mapping deleted. The draft
201
- * workflow scheme can be published in Jira.
202
- *
203
- * **[Permissions](#permissions) required:** *Administer Jira* [global
204
- * permission](https://confluence.atlassian.com/x/x4dKLg).
205
- *
206
- * @returns Returned if the request is successful.
207
- *
208
- * example: {
209
- * "defaultWorkflow": "jira",
210
- * "description": "The description of the example workflow scheme.",
211
- * "draft": false,
212
- * "id": 101010,
213
- * "issueTypeMappings": {
214
- * "10000": "scrum workflow",
215
- * "10001": "builds workflow"
216
- * },
217
- * "name": "Example workflow scheme",
218
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
219
- * }
220
- * @path {DELETE} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
221
- * @scopes-current manage:jira-configuration
222
- * @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
223
- * read:group:jira, read:issue-type:jira, read:project-category:jira,
224
- * read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira
225
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-delete
226
- */
227
- deleteWorkflowSchemeIssueType({ id, issueType, updateDraftIfNeeded, }) {
228
- return this.getClientInstance()
229
- .request({
230
- path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
231
- method: "DELETE",
232
- pathParams: {
233
- id,
234
- issueType,
235
- },
236
- query: {
237
- updateDraftIfNeeded,
238
- },
239
- })
240
- .then(this.getClientInstance().responseHandler({
241
- 200: {
242
- "application/json": "json",
243
- },
244
- }))
245
- .then(commonHttpClient.castResponse())
246
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowSchemeIssueType.response"))
247
- .then(commonHttpClient.getBody);
248
- }
249
- /**
250
- * Returns a [paginated](#pagination) list of all workflow schemes, not including
251
- * draft workflow schemes.
252
- *
253
- * **[Permissions](#permissions) required:** *Administer Jira* [global
254
- * permission](https://confluence.atlassian.com/x/x4dKLg).
255
- *
256
- * @returns Returned if the request is successful.
257
- *
258
- * example: {
259
- * "isLast": true,
260
- * "maxResults": 50,
261
- * "startAt": 0,
262
- * "total": 2,
263
- * "values": [
264
- * {
265
- * "defaultWorkflow": "jira",
266
- * "description": "The description of the example workflow scheme.",
267
- * "id": 101010,
268
- * "issueTypeMappings": {
269
- * "10000": "scrum workflow",
270
- * "10001": "builds workflow"
271
- * },
272
- * "name": "Example workflow scheme",
273
- * "self":
274
- * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
275
- * },
276
- * {
277
- * "defaultWorkflow": "jira",
278
- * "description": "The description of the another example workflow scheme.",
279
- * "id": 101011,
280
- * "issueTypeMappings": {
281
- * "10000": "scrum workflow",
282
- * "10001": "builds workflow"
283
- * },
284
- * "name": "Another example workflow scheme",
285
- * "self":
286
- * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
287
- * }
288
- * ]
289
- * }
290
- * @path {GET} /rest/api/3/workflowscheme
291
- * @scopes-current manage:jira-configuration
292
- * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
293
- * read:group:jira, read:issue-type:jira, read:project-category:jira,
294
- * read:project:jira, read:user:jira
295
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-get
296
- */
297
- getAllWorkflowSchemes({ startAt, maxResults, } = {}) {
298
- return this.getClientInstance()
299
- .request({
300
- path: "/rest/api/3/workflowscheme",
301
- method: "GET",
302
- query: {
303
- startAt,
304
- maxResults,
305
- },
306
- })
307
- .then(this.getClientInstance().responseHandler({
308
- 200: {
309
- "application/json": "json",
310
- },
311
- }))
312
- .then(commonHttpClient.castResponse())
313
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getAllWorkflowSchemes.response"))
314
- .then(commonHttpClient.getBody);
315
- }
316
- /**
317
- * Returns the default workflow for a workflow scheme. The default workflow is the
318
- * workflow that is assigned any issue types that have not been mapped to any
319
- * other workflow. The default workflow has *All Unassigned Issue Types* listed in
320
- * its issue types for the workflow scheme in Jira.
321
- *
322
- * **[Permissions](#permissions) required:** *Administer Jira* [global
323
- * permission](https://confluence.atlassian.com/x/x4dKLg).
324
- *
325
- * @returns Returned if the request is successful.
326
- *
327
- * example: {
328
- * "workflow": "jira"
329
- * }
330
- * @path {GET} /rest/api/3/workflowscheme/{id}/default
331
- * @scopes-current manage:jira-configuration
332
- * @scopes-beta read:workflow-scheme:jira, read:workflow:jira
333
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-get
334
- */
335
- getDefaultWorkflow({ id, returnDraftIfExists, }) {
336
- return this.getClientInstance()
337
- .request({
338
- path: "/rest/api/3/workflowscheme/{id}/default",
339
- method: "GET",
340
- pathParams: {
341
- id,
342
- },
343
- query: {
344
- returnDraftIfExists,
345
- },
346
- })
347
- .then(this.getClientInstance().responseHandler({
348
- 200: {
349
- "application/json": "json",
350
- },
351
- }))
352
- .then(commonHttpClient.castResponse())
353
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getDefaultWorkflow.response"))
354
- .then(commonHttpClient.getBody);
355
- }
356
- /**
357
- * Returns the workflow-issue type mappings for a workflow scheme.
358
- *
359
- * **[Permissions](#permissions) required:** *Administer Jira* [global
360
- * permission](https://confluence.atlassian.com/x/x4dKLg).
361
- *
362
- * @returns Returned if the request is successful.
363
- *
364
- * example: {
365
- * "defaultMapping": false,
366
- * "issueTypes": [
367
- * "10000",
368
- * "10001"
369
- * ],
370
- * "workflow": "jira"
371
- * }
372
- * @path {GET} /rest/api/3/workflowscheme/{id}/workflow
373
- * @scopes-current manage:jira-configuration
374
- * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
375
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-get
376
- */
377
- getWorkflow({ id, workflowName, returnDraftIfExists, }) {
378
- return this.getClientInstance()
379
- .request({
380
- path: "/rest/api/3/workflowscheme/{id}/workflow",
381
- method: "GET",
382
- pathParams: {
383
- id,
384
- },
385
- query: {
386
- workflowName,
387
- returnDraftIfExists,
388
- },
389
- })
390
- .then(this.getClientInstance().responseHandler({
391
- 200: {
392
- "application/json": "json",
393
- },
394
- }))
395
- .then(commonHttpClient.castResponse())
396
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflow.response"))
397
- .then(commonHttpClient.getBody);
398
- }
399
- /**
400
- * Returns a workflow scheme.
401
- *
402
- * **[Permissions](#permissions) required:** *Administer Jira* [global
403
- * permission](https://confluence.atlassian.com/x/x4dKLg).
404
- *
405
- * @returns Returned if the request is successful.
406
- *
407
- * example: {
408
- * "defaultWorkflow": "jira",
409
- * "description": "The description of the example workflow scheme.",
410
- * "draft": false,
411
- * "id": 101010,
412
- * "issueTypeMappings": {
413
- * "10000": "scrum workflow",
414
- * "10001": "builds workflow"
415
- * },
416
- * "name": "Example workflow scheme",
417
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
418
- * }
419
- * @path {GET} /rest/api/3/workflowscheme/{id}
420
- * @scopes-current manage:jira-configuration
421
- * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
422
- * read:group:jira, read:issue-type:jira, read:project-category:jira,
423
- * read:project:jira, read:user:jira
424
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-get
425
- */
426
- getWorkflowScheme({ id, returnDraftIfExists, }) {
427
- return this.getClientInstance()
428
- .request({
429
- path: "/rest/api/3/workflowscheme/{id}",
430
- method: "GET",
431
- pathParams: {
432
- id,
433
- },
434
- query: {
435
- returnDraftIfExists,
436
- },
437
- })
438
- .then(this.getClientInstance().responseHandler({
439
- 200: {
440
- "application/json": "json",
441
- },
442
- }))
443
- .then(commonHttpClient.castResponse())
444
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowScheme.response"))
445
- .then(commonHttpClient.getBody);
446
- }
447
- /**
448
- * Returns the issue type-workflow mapping for an issue type in a workflow scheme.
449
- *
450
- * **[Permissions](#permissions) required:** *Administer Jira* [global
451
- * permission](https://confluence.atlassian.com/x/x4dKLg).
452
- *
453
- * @returns Returned if the request is successful.
454
- *
455
- * example: {
456
- * "issueType": "10000",
457
- * "workflow": "jira"
458
- * }
459
- * @path {GET} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
460
- * @scopes-current manage:jira-configuration
461
- * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
462
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-get
463
- */
464
- getWorkflowSchemeIssueType({ id, issueType, returnDraftIfExists, }) {
465
- return this.getClientInstance()
466
- .request({
467
- path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
468
- method: "GET",
469
- pathParams: {
470
- id,
471
- issueType,
472
- },
473
- query: {
474
- returnDraftIfExists,
475
- },
476
- })
477
- .then(this.getClientInstance().responseHandler({
478
- 200: {
479
- "application/json": "json",
480
- },
481
- }))
482
- .then(commonHttpClient.castResponse())
483
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowSchemeIssueType.response"))
484
- .then(commonHttpClient.getBody);
485
- }
486
- /**
487
- * Returns a list of workflow schemes by providing workflow scheme IDs or project
488
- * IDs.
489
- *
490
- * **[Permissions](#permissions) required:**
491
- *
492
- * * *Administer Jira* global permission to access all, including
493
- * project-scoped, workflow schemes
494
- * * *Administer projects* project permissions to access project-scoped workflow
495
- * schemes
496
- *
497
- * @returns Returned if the request is successful.
498
- *
499
- * example: [
500
- * {
501
- * "defaultWorkflow": {
502
- * "description": "This is the default workflow for Software Development
503
- * projects.",
504
- * "id": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
505
- * "name": "Default Software Development Workflow",
506
- * "usage": [
507
- * {
508
- * "issueTypeIds": [],
509
- * "projectId": "10047"
510
- * }
511
- * ],
512
- * "version": {
513
- * "id": "657812fc-bc72-400f-aae0-df8d88db3d9g",
514
- * "versionNumber": 1
515
- * }
516
- * },
517
- * "description": "This is the workflow scheme for the Software Development
518
- * project type.",
519
- * "id": "3g78dg2a-ns2n-56ab-9812-42h5j1464567",
520
- * "name": "Software Developer Workflow Scheme",
521
- * "projectIdsUsingScheme": [
522
- * "10047"
523
- * ],
524
- * "scope": {
525
- * "project": {
526
- * "id": "10047"
527
- * },
528
- * "type": "GLOBAL"
529
- * },
530
- * "taskId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629",
531
- * "version": {
532
- * "id": "527213fc-bc72-400f-aae0-df8d88db2c8a",
533
- * "versionNumber": 1
534
- * },
535
- * "workflowsForIssueTypes": [
536
- * {
537
- * "issueTypeIds": [
538
- * "10013"
539
- * ],
540
- * "workflow": {
541
- * "description": "This is the workflow for the Software Development bug
542
- * issue type.",
543
- * "id": "5e79ae0f-ed6c-47ce-8d50-80c0c4572745",
544
- * "name": "Software Development Bug Workflow",
545
- * "usage": [
546
- * {
547
- * "issueTypeIds": [
548
- * "10013"
549
- * ],
550
- * "projectId": "10047"
551
- * }
552
- * ],
553
- * "version": {
554
- * "id": "897812dc-bc72-400f-aae0-df8d88fe3d8f",
555
- * "versionNumber": 1
556
- * }
557
- * }
558
- * }
559
- * ]
560
- * }
561
- * ]
562
- * @path {POST} /rest/api/3/workflowscheme/read
563
- * @scopes-current manage:jira-configuration
564
- * @scopes-beta read:workflow-scheme:jira
565
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-read-post
566
- */
567
- readWorkflowSchemes({ expand, workflowSchemeReadRequest, }) {
568
- return this.getClientInstance()
569
- .request({
570
- path: "/rest/api/3/workflowscheme/read",
571
- method: "POST",
572
- query: {
573
- expand,
574
- },
575
- headers: {
576
- "Content-Type": "application/json",
577
- },
578
- body: workflowSchemeReadRequest,
579
- })
580
- .then(this.getClientInstance().responseHandler({
581
- 200: {
582
- "application/json": "json",
583
- },
584
- }))
585
- .then(commonHttpClient.castResponse())
586
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.readWorkflowSchemes.response"))
587
- .then(commonHttpClient.getBody);
588
- }
589
- /**
590
- * Sets the workflow for an issue type in a workflow scheme.
591
- *
592
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
593
- * active, set `updateDraftIfNeeded` to `true` in the request body and a draft
594
- * workflow scheme is created or updated with the new issue type-workflow mapping.
595
- * The draft workflow scheme can be published in Jira.
596
- *
597
- * **[Permissions](#permissions) required:** *Administer Jira* [global
598
- * permission](https://confluence.atlassian.com/x/x4dKLg).
599
- *
600
- * @returns Returned if the request is successful.
601
- *
602
- * example: {
603
- * "defaultWorkflow": "jira",
604
- * "description": "The description of the example workflow scheme.",
605
- * "draft": false,
606
- * "id": 101010,
607
- * "issueTypeMappings": {
608
- * "10000": "scrum workflow",
609
- * "10001": "builds workflow"
610
- * },
611
- * "name": "Example workflow scheme",
612
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
613
- * }
614
- * @path {PUT} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
615
- * @scopes-current manage:jira-configuration
616
- * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
617
- * read:application-role:jira, read:avatar:jira, read:group:jira,
618
- * read:issue-type:jira, read:project-category:jira, read:project:jira,
619
- * read:user:jira
620
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-put
621
- */
622
- setWorkflowSchemeIssueType({ id, issueType, issueTypeWorkflowMapping, }) {
623
- return this.getClientInstance()
624
- .request({
625
- path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
626
- method: "PUT",
627
- pathParams: {
628
- id,
629
- issueType,
630
- },
631
- headers: {
632
- "Content-Type": "application/json",
633
- },
634
- body: issueTypeWorkflowMapping,
635
- })
636
- .then(this.getClientInstance().responseHandler({
637
- 200: {
638
- "application/json": "json",
639
- },
640
- }))
641
- .then(commonHttpClient.castResponse())
642
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.setWorkflowSchemeIssueType.response"))
643
- .then(commonHttpClient.getBody);
644
- }
645
- /**
646
- * Sets the default workflow for a workflow scheme.
647
- *
648
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
649
- * active, set `updateDraftIfNeeded` to `true` in the request object and a draft
650
- * workflow scheme is created or updated with the new default workflow. The draft
651
- * workflow scheme can be published in Jira.
652
- *
653
- * **[Permissions](#permissions) required:** *Administer Jira* [global
654
- * permission](https://confluence.atlassian.com/x/x4dKLg).
655
- *
656
- * @returns Returned if the request is successful.
657
- *
658
- * example: {
659
- * "defaultWorkflow": "jira",
660
- * "description": "The description of the example workflow scheme.",
661
- * "draft": false,
662
- * "id": 101010,
663
- * "issueTypeMappings": {
664
- * "10000": "scrum workflow",
665
- * "10001": "builds workflow"
666
- * },
667
- * "name": "Example workflow scheme",
668
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
669
- * }
670
- * @path {PUT} /rest/api/3/workflowscheme/{id}/default
671
- * @scopes-current manage:jira-configuration
672
- * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
673
- * read:application-role:jira, read:avatar:jira, read:group:jira,
674
- * read:issue-type:jira, read:project-category:jira, read:project:jira,
675
- * read:user:jira
676
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-put
677
- */
678
- updateDefaultWorkflow({ id, defaultWorkflow, }) {
679
- return this.getClientInstance()
680
- .request({
681
- path: "/rest/api/3/workflowscheme/{id}/default",
682
- method: "PUT",
683
- pathParams: {
684
- id,
685
- },
686
- headers: {
687
- "Content-Type": "application/json",
688
- },
689
- body: defaultWorkflow,
690
- })
691
- .then(this.getClientInstance().responseHandler({
692
- 200: {
693
- "application/json": "json",
694
- },
695
- }))
696
- .then(commonHttpClient.castResponse())
697
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateDefaultWorkflow.response"))
698
- .then(commonHttpClient.getBody);
699
- }
700
- /**
701
- * Updates company-managed and team-managed project workflow schemes. This API
702
- * doesn't have a concept of draft, so any changes made to a workflow scheme are
703
- * immediately available. When changing the available statuses for issue types, an
704
- * [asynchronous task](#async) migrates the issues as defined in the provided
705
- * mappings.
706
- *
707
- * **[Permissions](#permissions) required:**
708
- *
709
- * * *Administer Jira* project permission to update all, including
710
- * global-scoped, workflow schemes.
711
- * * *Administer projects* project permission to update project-scoped workflow
712
- * schemes.
713
- *
714
- * @returns Returned if the request is successful and there is no asynchronous task.
715
- * @path {POST} /rest/api/3/workflowscheme/update
716
- * @scopes-current manage:jira-configuration
717
- * @scopes-beta write:workflow-scheme:jira
718
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-post
719
- */
720
- updateSchemes({ workflowSchemeUpdateRequest, }) {
721
- return this.getClientInstance()
722
- .request({
723
- path: "/rest/api/3/workflowscheme/update",
724
- method: "POST",
725
- headers: {
726
- "Content-Type": "application/json",
727
- },
728
- body: workflowSchemeUpdateRequest,
729
- })
730
- .then(this.getClientInstance().responseHandler({
731
- 200: {
732
- "application/json": "json",
733
- },
734
- }))
735
- .then(commonHttpClient.castResponse())
736
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateSchemes.response"))
737
- .then(commonHttpClient.getBody);
738
- }
739
- /**
740
- * Sets the issue types for a workflow in a workflow scheme. The workflow can also
741
- * be set as the default workflow for the workflow scheme. Unmapped issues types
742
- * are mapped to the default workflow.
743
- *
744
- * Note that active workflow schemes cannot be edited. If the workflow scheme is
745
- * active, set `updateDraftIfNeeded` to `true` in the request body and a draft
746
- * workflow scheme is created or updated with the new workflow-issue types
747
- * mappings. The draft workflow scheme can be published in Jira.
748
- *
749
- * **[Permissions](#permissions) required:** *Administer Jira* [global
750
- * permission](https://confluence.atlassian.com/x/x4dKLg).
751
- *
752
- * @returns Returned if the request is successful.
753
- *
754
- * example: {
755
- * "defaultWorkflow": "jira",
756
- * "description": "The description of the example workflow scheme.",
757
- * "draft": false,
758
- * "id": 101010,
759
- * "issueTypeMappings": {
760
- * "10000": "scrum workflow",
761
- * "10001": "builds workflow"
762
- * },
763
- * "name": "Example workflow scheme",
764
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
765
- * }
766
- * @path {PUT} /rest/api/3/workflowscheme/{id}/workflow
767
- * @scopes-current manage:jira-configuration
768
- * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
769
- * read:application-role:jira, read:avatar:jira, read:group:jira,
770
- * read:issue-type:jira, read:project-category:jira, read:project:jira,
771
- * read:user:jira
772
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-put
773
- */
774
- updateWorkflowMapping({ id, workflowName, issueTypesWorkflowMapping, }) {
775
- return this.getClientInstance()
776
- .request({
777
- path: "/rest/api/3/workflowscheme/{id}/workflow",
778
- method: "PUT",
779
- pathParams: {
780
- id,
781
- },
782
- query: {
783
- workflowName,
784
- },
785
- headers: {
786
- "Content-Type": "application/json",
787
- },
788
- body: issueTypesWorkflowMapping,
789
- })
790
- .then(this.getClientInstance().responseHandler({
791
- 200: {
792
- "application/json": "json",
793
- },
794
- }))
795
- .then(commonHttpClient.castResponse())
796
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowMapping.response"))
797
- .then(commonHttpClient.getBody);
798
- }
799
- /**
800
- * Updates a company-manged project workflow scheme, including the name, default
801
- * workflow, issue type to project mappings, and more. If the workflow scheme is
802
- * active (that is, being used by at least one project), then a draft workflow
803
- * scheme is created or updated instead, provided that `updateDraftIfNeeded` is
804
- * set to `true`.
805
- *
806
- * **[Permissions](#permissions) required:** *Administer Jira* [global
807
- * permission](https://confluence.atlassian.com/x/x4dKLg).
808
- *
809
- * @returns Returned if the request is successful.
810
- *
811
- * example: {
812
- * "defaultWorkflow": "jira",
813
- * "description": "The description of the example workflow scheme.",
814
- * "draft": false,
815
- * "id": 101010,
816
- * "issueTypeMappings": {
817
- * "10000": "scrum workflow",
818
- * "10001": "builds workflow"
819
- * },
820
- * "name": "Example workflow scheme",
821
- * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
822
- * }
823
- * @path {PUT} /rest/api/3/workflowscheme/{id}
824
- * @scopes-current manage:jira-configuration
825
- * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
826
- * read:application-role:jira, read:avatar:jira, read:group:jira,
827
- * read:issue-type:jira, read:project-category:jira, read:project:jira,
828
- * read:user:jira
829
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-put
830
- */
831
- updateWorkflowScheme({ id, workflowScheme, }) {
832
- return this.getClientInstance()
833
- .request({
834
- path: "/rest/api/3/workflowscheme/{id}",
835
- method: "PUT",
836
- pathParams: {
837
- id,
838
- },
839
- headers: {
840
- "Content-Type": "application/json",
841
- },
842
- body: workflowScheme,
843
- })
844
- .then(this.getClientInstance().responseHandler({
845
- 200: {
846
- "application/json": "json",
847
- },
848
- }))
849
- .then(commonHttpClient.castResponse())
850
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowScheme.response"))
851
- .then(commonHttpClient.getBody);
852
- }
853
- /**
854
- * Gets the required status mappings for the desired changes to a workflow scheme.
855
- * The results are provided per issue type and workflow. When updating a workflow
856
- * scheme, status mappings can be provided per issue type, per workflow, or both.
857
- *
858
- * **[Permissions](#permissions) required:**
859
- *
860
- * * *Administer Jira* permission to update all, including global-scoped,
861
- * workflow schemes.
862
- * * *Administer projects* project permission to update project-scoped workflow
863
- * schemes.
864
- *
865
- * @returns Returned if the request is successful.
866
- *
867
- * example: {
868
- * "statusMappingsByIssueTypes": [
869
- * {
870
- * "issueTypeId": "10000",
871
- * "statusIds": [
872
- * "10000",
873
- * "10001"
874
- * ]
875
- * }
876
- * ],
877
- * "statusMappingsByWorkflows": [
878
- * {
879
- * "sourceWorkflowId": "10000",
880
- * "statusIds": [
881
- * "10000",
882
- * "10001"
883
- * ],
884
- * "targetWorkflowId": "10001"
885
- * }
886
- * ],
887
- * "statuses": [
888
- * {
889
- * "category": "TODO",
890
- * "id": "10000",
891
- * "name": "To Do"
892
- * }
893
- * ],
894
- * "statusesPerWorkflow": [
895
- * {
896
- * "initialStatusId": "10000",
897
- * "statuses": [
898
- * "10000",
899
- * "10001"
900
- * ],
901
- * "workflowId": "10000"
902
- * }
903
- * ]
904
- * }
905
- * @path {POST} /rest/api/3/workflowscheme/update/mappings
906
- * @scopes-current manage:jira-configuration
907
- * @scopes-beta write:workflow-scheme:jira
908
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-mappings-post
909
- */
910
- updateWorkflowSchemeMappings({ workflowSchemeUpdateRequiredMappingsRequest, }) {
911
- return this.getClientInstance()
912
- .request({
913
- path: "/rest/api/3/workflowscheme/update/mappings",
914
- method: "POST",
915
- headers: {
916
- "Content-Type": "application/json",
917
- },
918
- body: workflowSchemeUpdateRequiredMappingsRequest,
919
- })
920
- .then(this.getClientInstance().responseHandler({
921
- 200: {
922
- "application/json": "json",
923
- },
924
- }))
925
- .then(commonHttpClient.castResponse())
926
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowSchemeMappings.response"))
927
- .then(commonHttpClient.getBody);
32
+ constructor() {
33
+ super(...arguments);
34
+ /**
35
+ * Creates a workflow scheme.
36
+ *
37
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
38
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
39
+ *
40
+ * @returns Returned if the request is successful.
41
+ *
42
+ * example: {
43
+ * "defaultWorkflow": "jira",
44
+ * "description": "The description of the example workflow scheme.",
45
+ * "draft": false,
46
+ * "id": 101010,
47
+ * "issueTypeMappings": {
48
+ * "10000": "scrum workflow",
49
+ * "10001": "builds workflow"
50
+ * },
51
+ * "name": "Example workflow scheme",
52
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
53
+ * }
54
+ * @path {POST} /rest/api/3/workflowscheme
55
+ * @scopes-current manage:jira-configuration
56
+ * @scopes-beta write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
57
+ * read:group:jira, read:issue-type:jira, read:project-category:jira,
58
+ * read:project:jira, read:user:jira, read:workflow-scheme:jira
59
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-post
60
+ */
61
+ this.createWorkflowScheme = ({ workflowScheme, }) => {
62
+ return this.getClientInstance()
63
+ .request({
64
+ path: "/rest/api/3/workflowscheme",
65
+ method: "POST",
66
+ headers: {
67
+ "Content-Type": "application/json",
68
+ },
69
+ body: workflowScheme,
70
+ })
71
+ .then(this.getClientInstance().responseHandler({
72
+ 201: {
73
+ "application/json": "json",
74
+ },
75
+ }))
76
+ .then(commonHttpClient.castResponse())
77
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.createWorkflowScheme.response"))
78
+ .then(commonHttpClient.getBody);
79
+ };
80
+ /**
81
+ * Resets the default workflow for a workflow scheme. That is, the default
82
+ * workflow is set to Jira's system workflow (the *jira* workflow).
83
+ *
84
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
85
+ * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
86
+ * created or updated with the default workflow reset. The draft workflow scheme
87
+ * can be published in Jira.
88
+ *
89
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
90
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
91
+ *
92
+ * @returns Returned if the request is successful.
93
+ *
94
+ * example: {
95
+ * "defaultWorkflow": "jira",
96
+ * "description": "The description of the example workflow scheme.",
97
+ * "draft": false,
98
+ * "id": 101010,
99
+ * "issueTypeMappings": {
100
+ * "10000": "scrum workflow",
101
+ * "10001": "builds workflow"
102
+ * },
103
+ * "name": "Example workflow scheme",
104
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
105
+ * }
106
+ * @path {DELETE} /rest/api/3/workflowscheme/{id}/default
107
+ * @scopes-current manage:jira-configuration
108
+ * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
109
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
110
+ * read:issue-type:jira, read:project-category:jira, read:project:jira,
111
+ * read:user:jira
112
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-delete
113
+ */
114
+ this.deleteDefaultWorkflow = ({ id, updateDraftIfNeeded, }) => {
115
+ return this.getClientInstance()
116
+ .request({
117
+ path: "/rest/api/3/workflowscheme/{id}/default",
118
+ method: "DELETE",
119
+ pathParams: {
120
+ id,
121
+ },
122
+ query: {
123
+ updateDraftIfNeeded,
124
+ },
125
+ })
126
+ .then(this.getClientInstance().responseHandler({
127
+ 200: {
128
+ "application/json": "json",
129
+ },
130
+ }))
131
+ .then(commonHttpClient.castResponse())
132
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteDefaultWorkflow.response"))
133
+ .then(commonHttpClient.getBody);
134
+ };
135
+ /**
136
+ * Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
137
+ *
138
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
139
+ * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
140
+ * created or updated with the workflow-issue type mapping deleted. The draft
141
+ * workflow scheme can be published in Jira.
142
+ *
143
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
144
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
145
+ *
146
+ * @path {DELETE} /rest/api/3/workflowscheme/{id}/workflow
147
+ * @scopes-current manage:jira-configuration
148
+ * @scopes-beta delete:workflow-scheme:jira
149
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-delete
150
+ */
151
+ this.deleteWorkflowMapping = ({ id, workflowName, updateDraftIfNeeded, }) => {
152
+ return this.getClientInstance()
153
+ .request({
154
+ path: "/rest/api/3/workflowscheme/{id}/workflow",
155
+ method: "DELETE",
156
+ pathParams: {
157
+ id,
158
+ },
159
+ query: {
160
+ workflowName,
161
+ updateDraftIfNeeded,
162
+ },
163
+ })
164
+ .then(commonHttpClient.discardResult);
165
+ };
166
+ /**
167
+ * Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it
168
+ * is active (that is, being used by at least one project).
169
+ *
170
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
171
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
172
+ *
173
+ * @returns Returned if the request is successful.
174
+ * @path {DELETE} /rest/api/3/workflowscheme/{id}
175
+ * @scopes-current manage:jira-configuration
176
+ * @scopes-beta delete:workflow-scheme:jira
177
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-delete
178
+ */
179
+ this.deleteWorkflowScheme = ({ id, }) => {
180
+ return this.getClientInstance()
181
+ .request({
182
+ path: "/rest/api/3/workflowscheme/{id}",
183
+ method: "DELETE",
184
+ pathParams: {
185
+ id,
186
+ },
187
+ })
188
+ .then(this.getClientInstance().responseHandler({
189
+ 204: {
190
+ "application/json": "json",
191
+ },
192
+ }))
193
+ .then(commonHttpClient.castResponse())
194
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowScheme.response"))
195
+ .then(commonHttpClient.getBody);
196
+ };
197
+ /**
198
+ * Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
199
+ *
200
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
201
+ * active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is
202
+ * created or updated with the issue type-workflow mapping deleted. The draft
203
+ * workflow scheme can be published in Jira.
204
+ *
205
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
206
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
207
+ *
208
+ * @returns Returned if the request is successful.
209
+ *
210
+ * example: {
211
+ * "defaultWorkflow": "jira",
212
+ * "description": "The description of the example workflow scheme.",
213
+ * "draft": false,
214
+ * "id": 101010,
215
+ * "issueTypeMappings": {
216
+ * "10000": "scrum workflow",
217
+ * "10001": "builds workflow"
218
+ * },
219
+ * "name": "Example workflow scheme",
220
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
221
+ * }
222
+ * @path {DELETE} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
223
+ * @scopes-current manage:jira-configuration
224
+ * @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
225
+ * read:group:jira, read:issue-type:jira, read:project-category:jira,
226
+ * read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira
227
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-delete
228
+ */
229
+ this.deleteWorkflowSchemeIssueType = ({ id, issueType, updateDraftIfNeeded, }) => {
230
+ return this.getClientInstance()
231
+ .request({
232
+ path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
233
+ method: "DELETE",
234
+ pathParams: {
235
+ id,
236
+ issueType,
237
+ },
238
+ query: {
239
+ updateDraftIfNeeded,
240
+ },
241
+ })
242
+ .then(this.getClientInstance().responseHandler({
243
+ 200: {
244
+ "application/json": "json",
245
+ },
246
+ }))
247
+ .then(commonHttpClient.castResponse())
248
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.deleteWorkflowSchemeIssueType.response"))
249
+ .then(commonHttpClient.getBody);
250
+ };
251
+ /**
252
+ * Returns a [paginated](#pagination) list of all workflow schemes, not including
253
+ * draft workflow schemes.
254
+ *
255
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
256
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
257
+ *
258
+ * @returns Returned if the request is successful.
259
+ *
260
+ * example: {
261
+ * "isLast": true,
262
+ * "maxResults": 50,
263
+ * "startAt": 0,
264
+ * "total": 2,
265
+ * "values": [
266
+ * {
267
+ * "defaultWorkflow": "jira",
268
+ * "description": "The description of the example workflow scheme.",
269
+ * "id": 101010,
270
+ * "issueTypeMappings": {
271
+ * "10000": "scrum workflow",
272
+ * "10001": "builds workflow"
273
+ * },
274
+ * "name": "Example workflow scheme",
275
+ * "self":
276
+ * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
277
+ * },
278
+ * {
279
+ * "defaultWorkflow": "jira",
280
+ * "description": "The description of the another example workflow scheme.",
281
+ * "id": 101011,
282
+ * "issueTypeMappings": {
283
+ * "10000": "scrum workflow",
284
+ * "10001": "builds workflow"
285
+ * },
286
+ * "name": "Another example workflow scheme",
287
+ * "self":
288
+ * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
289
+ * }
290
+ * ]
291
+ * }
292
+ * @path {GET} /rest/api/3/workflowscheme
293
+ * @scopes-current manage:jira-configuration
294
+ * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
295
+ * read:group:jira, read:issue-type:jira, read:project-category:jira,
296
+ * read:project:jira, read:user:jira
297
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-get
298
+ */
299
+ this.getAllWorkflowSchemes = ({ startAt, maxResults, } = {}) => {
300
+ return this.getClientInstance()
301
+ .request({
302
+ path: "/rest/api/3/workflowscheme",
303
+ method: "GET",
304
+ query: {
305
+ startAt,
306
+ maxResults,
307
+ },
308
+ })
309
+ .then(this.getClientInstance().responseHandler({
310
+ 200: {
311
+ "application/json": "json",
312
+ },
313
+ }))
314
+ .then(commonHttpClient.castResponse())
315
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getAllWorkflowSchemes.response"))
316
+ .then(commonHttpClient.getBody);
317
+ };
318
+ /**
319
+ * Returns the default workflow for a workflow scheme. The default workflow is the
320
+ * workflow that is assigned any issue types that have not been mapped to any
321
+ * other workflow. The default workflow has *All Unassigned Issue Types* listed in
322
+ * its issue types for the workflow scheme in Jira.
323
+ *
324
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
325
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
326
+ *
327
+ * @returns Returned if the request is successful.
328
+ *
329
+ * example: {
330
+ * "workflow": "jira"
331
+ * }
332
+ * @path {GET} /rest/api/3/workflowscheme/{id}/default
333
+ * @scopes-current manage:jira-configuration
334
+ * @scopes-beta read:workflow-scheme:jira, read:workflow:jira
335
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-get
336
+ */
337
+ this.getDefaultWorkflow = ({ id, returnDraftIfExists, }) => {
338
+ return this.getClientInstance()
339
+ .request({
340
+ path: "/rest/api/3/workflowscheme/{id}/default",
341
+ method: "GET",
342
+ pathParams: {
343
+ id,
344
+ },
345
+ query: {
346
+ returnDraftIfExists,
347
+ },
348
+ })
349
+ .then(this.getClientInstance().responseHandler({
350
+ 200: {
351
+ "application/json": "json",
352
+ },
353
+ }))
354
+ .then(commonHttpClient.castResponse())
355
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getDefaultWorkflow.response"))
356
+ .then(commonHttpClient.getBody);
357
+ };
358
+ /**
359
+ * Returns the workflow-issue type mappings for a workflow scheme.
360
+ *
361
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
362
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
363
+ *
364
+ * @returns Returned if the request is successful.
365
+ *
366
+ * example: {
367
+ * "defaultMapping": false,
368
+ * "issueTypes": [
369
+ * "10000",
370
+ * "10001"
371
+ * ],
372
+ * "workflow": "jira"
373
+ * }
374
+ * @path {GET} /rest/api/3/workflowscheme/{id}/workflow
375
+ * @scopes-current manage:jira-configuration
376
+ * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
377
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-get
378
+ */
379
+ this.getWorkflow = ({ id, workflowName, returnDraftIfExists, }) => {
380
+ return this.getClientInstance()
381
+ .request({
382
+ path: "/rest/api/3/workflowscheme/{id}/workflow",
383
+ method: "GET",
384
+ pathParams: {
385
+ id,
386
+ },
387
+ query: {
388
+ workflowName,
389
+ returnDraftIfExists,
390
+ },
391
+ })
392
+ .then(this.getClientInstance().responseHandler({
393
+ 200: {
394
+ "application/json": "json",
395
+ },
396
+ }))
397
+ .then(commonHttpClient.castResponse())
398
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflow.response"))
399
+ .then(commonHttpClient.getBody);
400
+ };
401
+ /**
402
+ * Returns a workflow scheme.
403
+ *
404
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
405
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
406
+ *
407
+ * @returns Returned if the request is successful.
408
+ *
409
+ * example: {
410
+ * "defaultWorkflow": "jira",
411
+ * "description": "The description of the example workflow scheme.",
412
+ * "draft": false,
413
+ * "id": 101010,
414
+ * "issueTypeMappings": {
415
+ * "10000": "scrum workflow",
416
+ * "10001": "builds workflow"
417
+ * },
418
+ * "name": "Example workflow scheme",
419
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
420
+ * }
421
+ * @path {GET} /rest/api/3/workflowscheme/{id}
422
+ * @scopes-current manage:jira-configuration
423
+ * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
424
+ * read:group:jira, read:issue-type:jira, read:project-category:jira,
425
+ * read:project:jira, read:user:jira
426
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-get
427
+ */
428
+ this.getWorkflowScheme = ({ id, returnDraftIfExists, }) => {
429
+ return this.getClientInstance()
430
+ .request({
431
+ path: "/rest/api/3/workflowscheme/{id}",
432
+ method: "GET",
433
+ pathParams: {
434
+ id,
435
+ },
436
+ query: {
437
+ returnDraftIfExists,
438
+ },
439
+ })
440
+ .then(this.getClientInstance().responseHandler({
441
+ 200: {
442
+ "application/json": "json",
443
+ },
444
+ }))
445
+ .then(commonHttpClient.castResponse())
446
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowScheme.response"))
447
+ .then(commonHttpClient.getBody);
448
+ };
449
+ /**
450
+ * Returns the issue type-workflow mapping for an issue type in a workflow scheme.
451
+ *
452
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
453
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
454
+ *
455
+ * @returns Returned if the request is successful.
456
+ *
457
+ * example: {
458
+ * "issueType": "10000",
459
+ * "workflow": "jira"
460
+ * }
461
+ * @path {GET} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
462
+ * @scopes-current manage:jira-configuration
463
+ * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
464
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-get
465
+ */
466
+ this.getWorkflowSchemeIssueType = ({ id, issueType, returnDraftIfExists, }) => {
467
+ return this.getClientInstance()
468
+ .request({
469
+ path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
470
+ method: "GET",
471
+ pathParams: {
472
+ id,
473
+ issueType,
474
+ },
475
+ query: {
476
+ returnDraftIfExists,
477
+ },
478
+ })
479
+ .then(this.getClientInstance().responseHandler({
480
+ 200: {
481
+ "application/json": "json",
482
+ },
483
+ }))
484
+ .then(commonHttpClient.castResponse())
485
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.getWorkflowSchemeIssueType.response"))
486
+ .then(commonHttpClient.getBody);
487
+ };
488
+ /**
489
+ * Returns a list of workflow schemes by providing workflow scheme IDs or project
490
+ * IDs.
491
+ *
492
+ * **[Permissions](#permissions) required:**
493
+ *
494
+ * * *Administer Jira* global permission to access all, including
495
+ * project-scoped, workflow schemes
496
+ * * *Administer projects* project permissions to access project-scoped workflow
497
+ * schemes
498
+ *
499
+ * @returns Returned if the request is successful.
500
+ *
501
+ * example: [
502
+ * {
503
+ * "defaultWorkflow": {
504
+ * "description": "This is the default workflow for Software Development
505
+ * projects.",
506
+ * "id": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
507
+ * "name": "Default Software Development Workflow",
508
+ * "usage": [
509
+ * {
510
+ * "issueTypeIds": [],
511
+ * "projectId": "10047"
512
+ * }
513
+ * ],
514
+ * "version": {
515
+ * "id": "657812fc-bc72-400f-aae0-df8d88db3d9g",
516
+ * "versionNumber": 1
517
+ * }
518
+ * },
519
+ * "description": "This is the workflow scheme for the Software Development
520
+ * project type.",
521
+ * "id": "3g78dg2a-ns2n-56ab-9812-42h5j1464567",
522
+ * "name": "Software Developer Workflow Scheme",
523
+ * "projectIdsUsingScheme": [
524
+ * "10047"
525
+ * ],
526
+ * "scope": {
527
+ * "project": {
528
+ * "id": "10047"
529
+ * },
530
+ * "type": "GLOBAL"
531
+ * },
532
+ * "taskId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629",
533
+ * "version": {
534
+ * "id": "527213fc-bc72-400f-aae0-df8d88db2c8a",
535
+ * "versionNumber": 1
536
+ * },
537
+ * "workflowsForIssueTypes": [
538
+ * {
539
+ * "issueTypeIds": [
540
+ * "10013"
541
+ * ],
542
+ * "workflow": {
543
+ * "description": "This is the workflow for the Software Development bug
544
+ * issue type.",
545
+ * "id": "5e79ae0f-ed6c-47ce-8d50-80c0c4572745",
546
+ * "name": "Software Development Bug Workflow",
547
+ * "usage": [
548
+ * {
549
+ * "issueTypeIds": [
550
+ * "10013"
551
+ * ],
552
+ * "projectId": "10047"
553
+ * }
554
+ * ],
555
+ * "version": {
556
+ * "id": "897812dc-bc72-400f-aae0-df8d88fe3d8f",
557
+ * "versionNumber": 1
558
+ * }
559
+ * }
560
+ * }
561
+ * ]
562
+ * }
563
+ * ]
564
+ * @path {POST} /rest/api/3/workflowscheme/read
565
+ * @scopes-current manage:jira-configuration
566
+ * @scopes-beta read:workflow-scheme:jira
567
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-read-post
568
+ */
569
+ this.readWorkflowSchemes = ({ expand, workflowSchemeReadRequest, }) => {
570
+ return this.getClientInstance()
571
+ .request({
572
+ path: "/rest/api/3/workflowscheme/read",
573
+ method: "POST",
574
+ query: {
575
+ expand,
576
+ },
577
+ headers: {
578
+ "Content-Type": "application/json",
579
+ },
580
+ body: workflowSchemeReadRequest,
581
+ })
582
+ .then(this.getClientInstance().responseHandler({
583
+ 200: {
584
+ "application/json": "json",
585
+ },
586
+ }))
587
+ .then(commonHttpClient.castResponse())
588
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.readWorkflowSchemes.response"))
589
+ .then(commonHttpClient.getBody);
590
+ };
591
+ /**
592
+ * Sets the workflow for an issue type in a workflow scheme.
593
+ *
594
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
595
+ * active, set `updateDraftIfNeeded` to `true` in the request body and a draft
596
+ * workflow scheme is created or updated with the new issue type-workflow mapping.
597
+ * The draft workflow scheme can be published in Jira.
598
+ *
599
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
600
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
601
+ *
602
+ * @returns Returned if the request is successful.
603
+ *
604
+ * example: {
605
+ * "defaultWorkflow": "jira",
606
+ * "description": "The description of the example workflow scheme.",
607
+ * "draft": false,
608
+ * "id": 101010,
609
+ * "issueTypeMappings": {
610
+ * "10000": "scrum workflow",
611
+ * "10001": "builds workflow"
612
+ * },
613
+ * "name": "Example workflow scheme",
614
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
615
+ * }
616
+ * @path {PUT} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
617
+ * @scopes-current manage:jira-configuration
618
+ * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
619
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
620
+ * read:issue-type:jira, read:project-category:jira, read:project:jira,
621
+ * read:user:jira
622
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-put
623
+ */
624
+ this.setWorkflowSchemeIssueType = ({ id, issueType, issueTypeWorkflowMapping, }) => {
625
+ return this.getClientInstance()
626
+ .request({
627
+ path: "/rest/api/3/workflowscheme/{id}/issuetype/{issueType}",
628
+ method: "PUT",
629
+ pathParams: {
630
+ id,
631
+ issueType,
632
+ },
633
+ headers: {
634
+ "Content-Type": "application/json",
635
+ },
636
+ body: issueTypeWorkflowMapping,
637
+ })
638
+ .then(this.getClientInstance().responseHandler({
639
+ 200: {
640
+ "application/json": "json",
641
+ },
642
+ }))
643
+ .then(commonHttpClient.castResponse())
644
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.setWorkflowSchemeIssueType.response"))
645
+ .then(commonHttpClient.getBody);
646
+ };
647
+ /**
648
+ * Sets the default workflow for a workflow scheme.
649
+ *
650
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
651
+ * active, set `updateDraftIfNeeded` to `true` in the request object and a draft
652
+ * workflow scheme is created or updated with the new default workflow. The draft
653
+ * workflow scheme can be published in Jira.
654
+ *
655
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
656
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
657
+ *
658
+ * @returns Returned if the request is successful.
659
+ *
660
+ * example: {
661
+ * "defaultWorkflow": "jira",
662
+ * "description": "The description of the example workflow scheme.",
663
+ * "draft": false,
664
+ * "id": 101010,
665
+ * "issueTypeMappings": {
666
+ * "10000": "scrum workflow",
667
+ * "10001": "builds workflow"
668
+ * },
669
+ * "name": "Example workflow scheme",
670
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
671
+ * }
672
+ * @path {PUT} /rest/api/3/workflowscheme/{id}/default
673
+ * @scopes-current manage:jira-configuration
674
+ * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
675
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
676
+ * read:issue-type:jira, read:project-category:jira, read:project:jira,
677
+ * read:user:jira
678
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-put
679
+ */
680
+ this.updateDefaultWorkflow = ({ id, defaultWorkflow, }) => {
681
+ return this.getClientInstance()
682
+ .request({
683
+ path: "/rest/api/3/workflowscheme/{id}/default",
684
+ method: "PUT",
685
+ pathParams: {
686
+ id,
687
+ },
688
+ headers: {
689
+ "Content-Type": "application/json",
690
+ },
691
+ body: defaultWorkflow,
692
+ })
693
+ .then(this.getClientInstance().responseHandler({
694
+ 200: {
695
+ "application/json": "json",
696
+ },
697
+ }))
698
+ .then(commonHttpClient.castResponse())
699
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateDefaultWorkflow.response"))
700
+ .then(commonHttpClient.getBody);
701
+ };
702
+ /**
703
+ * Updates company-managed and team-managed project workflow schemes. This API
704
+ * doesn't have a concept of draft, so any changes made to a workflow scheme are
705
+ * immediately available. When changing the available statuses for issue types, an
706
+ * [asynchronous task](#async) migrates the issues as defined in the provided
707
+ * mappings.
708
+ *
709
+ * **[Permissions](#permissions) required:**
710
+ *
711
+ * * *Administer Jira* project permission to update all, including
712
+ * global-scoped, workflow schemes.
713
+ * * *Administer projects* project permission to update project-scoped workflow
714
+ * schemes.
715
+ *
716
+ * @returns Returned if the request is successful and there is no asynchronous task.
717
+ * @path {POST} /rest/api/3/workflowscheme/update
718
+ * @scopes-current manage:jira-configuration
719
+ * @scopes-beta write:workflow-scheme:jira
720
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-post
721
+ */
722
+ this.updateSchemes = ({ workflowSchemeUpdateRequest, }) => {
723
+ return this.getClientInstance()
724
+ .request({
725
+ path: "/rest/api/3/workflowscheme/update",
726
+ method: "POST",
727
+ headers: {
728
+ "Content-Type": "application/json",
729
+ },
730
+ body: workflowSchemeUpdateRequest,
731
+ })
732
+ .then(this.getClientInstance().responseHandler({
733
+ 200: {
734
+ "application/json": "json",
735
+ },
736
+ }))
737
+ .then(commonHttpClient.castResponse())
738
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateSchemes.response"))
739
+ .then(commonHttpClient.getBody);
740
+ };
741
+ /**
742
+ * Sets the issue types for a workflow in a workflow scheme. The workflow can also
743
+ * be set as the default workflow for the workflow scheme. Unmapped issues types
744
+ * are mapped to the default workflow.
745
+ *
746
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is
747
+ * active, set `updateDraftIfNeeded` to `true` in the request body and a draft
748
+ * workflow scheme is created or updated with the new workflow-issue types
749
+ * mappings. The draft workflow scheme can be published in Jira.
750
+ *
751
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
752
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
753
+ *
754
+ * @returns Returned if the request is successful.
755
+ *
756
+ * example: {
757
+ * "defaultWorkflow": "jira",
758
+ * "description": "The description of the example workflow scheme.",
759
+ * "draft": false,
760
+ * "id": 101010,
761
+ * "issueTypeMappings": {
762
+ * "10000": "scrum workflow",
763
+ * "10001": "builds workflow"
764
+ * },
765
+ * "name": "Example workflow scheme",
766
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
767
+ * }
768
+ * @path {PUT} /rest/api/3/workflowscheme/{id}/workflow
769
+ * @scopes-current manage:jira-configuration
770
+ * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
771
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
772
+ * read:issue-type:jira, read:project-category:jira, read:project:jira,
773
+ * read:user:jira
774
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-put
775
+ */
776
+ this.updateWorkflowMapping = ({ id, workflowName, issueTypesWorkflowMapping, }) => {
777
+ return this.getClientInstance()
778
+ .request({
779
+ path: "/rest/api/3/workflowscheme/{id}/workflow",
780
+ method: "PUT",
781
+ pathParams: {
782
+ id,
783
+ },
784
+ query: {
785
+ workflowName,
786
+ },
787
+ headers: {
788
+ "Content-Type": "application/json",
789
+ },
790
+ body: issueTypesWorkflowMapping,
791
+ })
792
+ .then(this.getClientInstance().responseHandler({
793
+ 200: {
794
+ "application/json": "json",
795
+ },
796
+ }))
797
+ .then(commonHttpClient.castResponse())
798
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowMapping.response"))
799
+ .then(commonHttpClient.getBody);
800
+ };
801
+ /**
802
+ * Updates a company-manged project workflow scheme, including the name, default
803
+ * workflow, issue type to project mappings, and more. If the workflow scheme is
804
+ * active (that is, being used by at least one project), then a draft workflow
805
+ * scheme is created or updated instead, provided that `updateDraftIfNeeded` is
806
+ * set to `true`.
807
+ *
808
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
809
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
810
+ *
811
+ * @returns Returned if the request is successful.
812
+ *
813
+ * example: {
814
+ * "defaultWorkflow": "jira",
815
+ * "description": "The description of the example workflow scheme.",
816
+ * "draft": false,
817
+ * "id": 101010,
818
+ * "issueTypeMappings": {
819
+ * "10000": "scrum workflow",
820
+ * "10001": "builds workflow"
821
+ * },
822
+ * "name": "Example workflow scheme",
823
+ * "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
824
+ * }
825
+ * @path {PUT} /rest/api/3/workflowscheme/{id}
826
+ * @scopes-current manage:jira-configuration
827
+ * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
828
+ * read:application-role:jira, read:avatar:jira, read:group:jira,
829
+ * read:issue-type:jira, read:project-category:jira, read:project:jira,
830
+ * read:user:jira
831
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-put
832
+ */
833
+ this.updateWorkflowScheme = ({ id, workflowScheme, }) => {
834
+ return this.getClientInstance()
835
+ .request({
836
+ path: "/rest/api/3/workflowscheme/{id}",
837
+ method: "PUT",
838
+ pathParams: {
839
+ id,
840
+ },
841
+ headers: {
842
+ "Content-Type": "application/json",
843
+ },
844
+ body: workflowScheme,
845
+ })
846
+ .then(this.getClientInstance().responseHandler({
847
+ 200: {
848
+ "application/json": "json",
849
+ },
850
+ }))
851
+ .then(commonHttpClient.castResponse())
852
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowScheme.response"))
853
+ .then(commonHttpClient.getBody);
854
+ };
855
+ /**
856
+ * Gets the required status mappings for the desired changes to a workflow scheme.
857
+ * The results are provided per issue type and workflow. When updating a workflow
858
+ * scheme, status mappings can be provided per issue type, per workflow, or both.
859
+ *
860
+ * **[Permissions](#permissions) required:**
861
+ *
862
+ * * *Administer Jira* permission to update all, including global-scoped,
863
+ * workflow schemes.
864
+ * * *Administer projects* project permission to update project-scoped workflow
865
+ * schemes.
866
+ *
867
+ * @returns Returned if the request is successful.
868
+ *
869
+ * example: {
870
+ * "statusMappingsByIssueTypes": [
871
+ * {
872
+ * "issueTypeId": "10000",
873
+ * "statusIds": [
874
+ * "10000",
875
+ * "10001"
876
+ * ]
877
+ * }
878
+ * ],
879
+ * "statusMappingsByWorkflows": [
880
+ * {
881
+ * "sourceWorkflowId": "10000",
882
+ * "statusIds": [
883
+ * "10000",
884
+ * "10001"
885
+ * ],
886
+ * "targetWorkflowId": "10001"
887
+ * }
888
+ * ],
889
+ * "statuses": [
890
+ * {
891
+ * "category": "TODO",
892
+ * "id": "10000",
893
+ * "name": "To Do"
894
+ * }
895
+ * ],
896
+ * "statusesPerWorkflow": [
897
+ * {
898
+ * "initialStatusId": "10000",
899
+ * "statuses": [
900
+ * "10000",
901
+ * "10001"
902
+ * ],
903
+ * "workflowId": "10000"
904
+ * }
905
+ * ]
906
+ * }
907
+ * @path {POST} /rest/api/3/workflowscheme/update/mappings
908
+ * @scopes-current manage:jira-configuration
909
+ * @scopes-beta write:workflow-scheme:jira
910
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-mappings-post
911
+ */
912
+ this.updateWorkflowSchemeMappings = ({ workflowSchemeUpdateRequiredMappingsRequest, }) => {
913
+ return this.getClientInstance()
914
+ .request({
915
+ path: "/rest/api/3/workflowscheme/update/mappings",
916
+ method: "POST",
917
+ headers: {
918
+ "Content-Type": "application/json",
919
+ },
920
+ body: workflowSchemeUpdateRequiredMappingsRequest,
921
+ })
922
+ .then(this.getClientInstance().responseHandler({
923
+ 200: {
924
+ "application/json": "json",
925
+ },
926
+ }))
927
+ .then(commonHttpClient.castResponse())
928
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("WorkflowSchemesService.updateWorkflowSchemeMappings.response"))
929
+ .then(commonHttpClient.getBody);
930
+ };
928
931
  }
929
932
  static initialize() {
930
933
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("WorkflowSchemesService.getAllWorkflowSchemes.response", zod_1.z