@resolution/jira-api-client 0.4.4 → 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 (326) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +28 -4
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +24 -1
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  5. package/lib/openapi/platform/models/common.d.ts +6 -0
  6. package/lib/openapi/platform/models/common.js +12 -1
  7. package/lib/openapi/platform/models/common.js.map +1 -1
  8. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  9. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  10. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  11. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  12. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  13. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  14. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  15. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  16. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  17. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  18. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  19. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  20. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  21. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  22. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  23. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  24. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  25. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  26. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  27. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  28. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  29. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  30. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  31. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  32. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  33. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  34. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  35. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  36. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  37. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  38. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  39. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  40. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  41. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  42. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  43. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  44. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  45. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  46. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  47. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  48. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  49. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  50. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  51. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  52. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  53. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  54. package/lib/openapi/platform/services/GroupsService.js +385 -382
  55. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  56. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  57. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  58. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  59. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  60. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  61. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  62. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  63. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  64. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  65. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  66. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  67. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  68. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  69. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  70. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  71. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  72. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  73. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  74. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  75. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  76. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  77. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  80. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  81. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  82. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  83. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  84. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  85. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  86. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  87. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  88. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  89. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  90. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  91. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  92. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  93. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  94. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  95. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  96. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  97. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  98. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  99. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  100. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  101. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  102. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  103. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  104. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  105. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  106. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  107. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  108. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  109. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  110. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  111. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  112. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  113. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  114. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  115. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  116. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  117. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  118. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  119. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  120. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  121. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  122. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  123. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  124. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  125. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  126. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  127. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  128. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  129. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  130. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  131. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  132. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  133. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  134. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  135. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  136. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  137. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  138. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  139. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  140. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  141. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  142. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  143. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  144. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  145. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  146. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  147. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  148. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  149. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  150. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  151. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  152. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  153. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  154. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  155. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  156. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  157. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  158. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  159. package/lib/openapi/platform/services/JqlService.js +635 -632
  160. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  161. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  162. package/lib/openapi/platform/services/LabelsService.js +41 -38
  163. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  164. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  165. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  166. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  167. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  168. package/lib/openapi/platform/services/MyselfService.js +321 -318
  169. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  170. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  171. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  172. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  173. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  174. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  175. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  176. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  177. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  178. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  179. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  180. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  181. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  182. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  183. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  184. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  185. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  186. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  187. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  188. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  189. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  190. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  191. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  192. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  193. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  194. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  195. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  196. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  197. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  198. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  199. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  200. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  201. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  202. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  203. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  204. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  205. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  206. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  207. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  208. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  209. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  210. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  211. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  212. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  213. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  214. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  215. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  216. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  217. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  218. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  219. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  220. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  221. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  222. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  223. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  224. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  225. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  226. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  227. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  228. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  229. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  230. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  231. package/lib/openapi/platform/services/ScreensService.js +281 -278
  232. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  233. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  234. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  235. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  236. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  237. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  238. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  239. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  240. package/lib/openapi/platform/services/StatusService.js +271 -268
  241. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  242. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  243. package/lib/openapi/platform/services/TasksService.js +93 -90
  244. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  245. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  246. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  247. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  248. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  249. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  250. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  251. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  252. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  253. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  254. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  255. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  256. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  257. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  258. package/lib/openapi/platform/services/UsersService.js +637 -634
  259. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  260. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  261. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  262. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  263. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  264. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  265. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  266. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  267. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  268. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  269. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  270. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  271. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  272. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  273. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  274. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  275. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  276. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  277. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  278. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  279. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  280. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  281. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  282. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  283. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  284. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  285. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  286. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  287. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  288. package/lib/openapi/software/services/BacklogService.js +81 -78
  289. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  290. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  291. package/lib/openapi/software/services/BoardService.js +2048 -2045
  292. package/lib/openapi/software/services/BoardService.js.map +1 -1
  293. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  294. package/lib/openapi/software/services/BuildsService.js +164 -161
  295. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  296. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  297. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  298. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  299. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  300. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  301. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  302. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  303. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  304. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  305. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  306. package/lib/openapi/software/services/EpicService.js +597 -594
  307. package/lib/openapi/software/services/EpicService.js.map +1 -1
  308. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  309. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  310. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  311. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  312. package/lib/openapi/software/services/IssueService.js +359 -356
  313. package/lib/openapi/software/services/IssueService.js.map +1 -1
  314. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  315. package/lib/openapi/software/services/OperationsService.js +301 -298
  316. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  317. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  318. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  319. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  320. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  321. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  322. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  323. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  324. package/lib/openapi/software/services/SprintService.js +594 -591
  325. package/lib/openapi/software/services/SprintService.js.map +1 -1
  326. package/package.json +4 -3
@@ -46,819 +46,822 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
46
46
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes
47
47
  */
48
48
  class IssueNotificationSchemesService extends CommonHttpService_1.CommonHttpService {
49
- /**
50
- * Adds notifications to a notification scheme. You can add up to 1000
51
- * notifications per request.
52
- *
53
- * *Deprecated: The notification type `EmailAddress` is no longer supported in
54
- * Cloud. Refer to the
55
- * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031)
56
- * for more details.*
57
- *
58
- * **[Permissions](#permissions) required:** *Administer Jira* [global
59
- * permission](https://confluence.atlassian.com/x/x4dKLg).
60
- *
61
- * @returns Returned if the request is successful.
62
- * @path {PUT} /rest/api/3/notificationscheme/{id}/notification
63
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-notification-put
64
- */
65
- addNotifications({ id, addNotificationsDetails, }) {
66
- return this.getClientInstance()
67
- .request({
68
- path: "/rest/api/3/notificationscheme/{id}/notification",
69
- method: "PUT",
70
- pathParams: {
71
- id,
72
- },
73
- headers: {
74
- "Content-Type": "application/json",
75
- },
76
- body: addNotificationsDetails,
77
- })
78
- .then(this.getClientInstance().responseHandler({
79
- 204: {
80
- "application/json": "json",
81
- },
82
- }))
83
- .then(commonHttpClient.castResponse())
84
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.addNotifications.response"))
85
- .then(commonHttpClient.getBody);
86
- }
87
- /**
88
- * Creates a notification scheme with notifications. You can create up to 1000
89
- * notifications per request.
90
- *
91
- * **[Permissions](#permissions) required:** *Administer Jira* [global
92
- * permission](https://confluence.atlassian.com/x/x4dKLg).
93
- *
94
- * @returns Returned if the request is successful.
95
- *
96
- * example: {
97
- * "id": "10001"
98
- * }
99
- * @path {POST} /rest/api/3/notificationscheme
100
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-post
101
- */
102
- createNotificationScheme({ createNotificationSchemeDetails, }) {
103
- return this.getClientInstance()
104
- .request({
105
- path: "/rest/api/3/notificationscheme",
106
- method: "POST",
107
- headers: {
108
- "Content-Type": "application/json",
109
- },
110
- body: createNotificationSchemeDetails,
111
- })
112
- .then(this.getClientInstance().responseHandler({
113
- 201: {
114
- "application/json": "json",
115
- },
116
- }))
117
- .then(commonHttpClient.castResponse())
118
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.createNotificationScheme.response"))
119
- .then(commonHttpClient.getBody);
120
- }
121
- /**
122
- * Deletes a notification scheme.
123
- *
124
- * **[Permissions](#permissions) required:** *Administer Jira* [global
125
- * permission](https://confluence.atlassian.com/x/x4dKLg).
126
- *
127
- * @returns Returned if the request is successful.
128
- * @path {DELETE} /rest/api/3/notificationscheme/{notificationSchemeId}
129
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-delete
130
- */
131
- deleteNotificationScheme({ notificationSchemeId, }) {
132
- return this.getClientInstance()
133
- .request({
134
- path: "/rest/api/3/notificationscheme/{notificationSchemeId}",
135
- method: "DELETE",
136
- pathParams: {
137
- notificationSchemeId,
138
- },
139
- })
140
- .then(this.getClientInstance().responseHandler({
141
- 204: {
142
- "application/json": "json",
143
- },
144
- }))
145
- .then(commonHttpClient.castResponse())
146
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.deleteNotificationScheme.response"))
147
- .then(commonHttpClient.getBody);
148
- }
149
- /**
150
- * Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg),
151
- * including the list of events and the recipients who will receive notifications
152
- * for those events.
153
- *
154
- * **[Permissions](#permissions) required:** Permission to access Jira, however,
155
- * the user must have permission to administer at least one project associated
156
- * with the notification scheme.
157
- *
158
- * @returns Returned if the request is successful.
159
- *
160
- * example: {
161
- * "description": "description",
162
- * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
163
- * "id": 10100,
164
- * "name": "notification scheme name",
165
- * "notificationSchemeEvents": [
166
- * {
167
- * "event": {
168
- * "description": "Event published when an issue is created",
169
- * "id": 1,
170
- * "name": "Issue created"
171
- * },
172
- * "notifications": [
173
- * {
174
- * "expand": "group",
175
- * "group": {
176
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
177
- * "name": "jira-administrators",
178
- * "self":
179
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
180
- * },
181
- * "id": 1,
182
- * "notificationType": "Group",
183
- * "parameter": "jira-administrators",
184
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
185
- * },
186
- * {
187
- * "id": 2,
188
- * "notificationType": "CurrentAssignee"
189
- * },
190
- * {
191
- * "expand": "projectRole",
192
- * "id": 3,
193
- * "notificationType": "ProjectRole",
194
- * "parameter": "10360",
195
- * "projectRole": {
196
- * "self":
197
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
198
- * "name": "Developers",
199
- * "id": 10360,
200
- * "description": "A project role that represents developers in a
201
- * project",
202
- * "actors": [
203
- * {
204
- * "actorGroup": {
205
- * "name": "jira-developers",
206
- * "displayName": "jira-developers",
207
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
208
- * },
209
- * "displayName": "jira-developers",
210
- * "id": 10240,
211
- * "name": "jira-developers",
212
- * "type": "atlassian-group-role-actor"
213
- * },
214
- * {
215
- * "actorUser": {
216
- * "accountId": "5b10a2844c20165700ede21g"
217
- * },
218
- * "displayName": "Mia Krystof",
219
- * "id": 10241,
220
- * "type": "atlassian-user-role-actor"
221
- * }
222
- * ],
223
- * "scope": {
224
- * "project": {
225
- * "id": "10000",
226
- * "key": "KEY",
227
- * "name": "Next Gen Project"
228
- * },
229
- * "type": "PROJECT"
230
- * }
231
- * },
232
- * "recipient": "10360"
233
- * },
234
- * {
235
- * "emailAddress": "rest-developer@atlassian.com",
236
- * "id": 4,
237
- * "notificationType": "EmailAddress",
238
- * "parameter": "rest-developer@atlassian.com",
239
- * "recipient": "rest-developer@atlassian.com"
240
- * },
241
- * {
242
- * "expand": "user",
243
- * "id": 5,
244
- * "notificationType": "User",
245
- * "parameter": "5b10a2844c20165700ede21g",
246
- * "recipient": "5b10a2844c20165700ede21g",
247
- * "user": {
248
- * "accountId": "5b10a2844c20165700ede21g",
249
- * "active": false,
250
- * "displayName": "Mia Krystof",
251
- * "self":
252
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
253
- * }
254
- * },
255
- * {
256
- * "expand": "field",
257
- * "field": {
258
- * "clauseNames": [
259
- * "cf[10101]",
260
- * "New custom field"
261
- * ],
262
- * "custom": true,
263
- * "id": "customfield_10101",
264
- * "key": "customfield_10101",
265
- * "name": "New custom field",
266
- * "navigable": true,
267
- * "orderable": true,
268
- * "schema": {
269
- * "custom":
270
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
271
- * "customId": 10101,
272
- * "type": "project"
273
- * },
274
- * "searchable": true,
275
- * "untranslatedName": "New custom field"
276
- * },
277
- * "id": 6,
278
- * "notificationType": "GroupCustomField",
279
- * "parameter": "customfield_10101",
280
- * "recipient": "customfield_10101"
281
- * }
282
- * ]
283
- * },
284
- * {
285
- * "event": {
286
- * "description": "Custom event that is published together with an issue
287
- * created event",
288
- * "id": 20,
289
- * "name": "Custom event",
290
- * "templateEvent": {
291
- * "description": "Event published when an issue is created",
292
- * "id": 1,
293
- * "name": "Issue created"
294
- * }
295
- * },
296
- * "notifications": [
297
- * {
298
- * "expand": "group",
299
- * "group": {
300
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
301
- * "name": "jira-administrators",
302
- * "self":
303
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
304
- * },
305
- * "id": 1,
306
- * "notificationType": "Group",
307
- * "parameter": "jira-administrators",
308
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
309
- * },
310
- * {
311
- * "id": 2,
312
- * "notificationType": "CurrentAssignee"
313
- * },
314
- * {
315
- * "expand": "projectRole",
316
- * "id": 3,
317
- * "notificationType": "ProjectRole",
318
- * "parameter": "10360",
319
- * "projectRole": {
320
- * "self":
321
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
322
- * "name": "Developers",
323
- * "id": 10360,
324
- * "description": "A project role that represents developers in a
325
- * project",
326
- * "actors": [
327
- * {
328
- * "actorGroup": {
329
- * "name": "jira-developers",
330
- * "displayName": "jira-developers",
331
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
332
- * },
333
- * "displayName": "jira-developers",
334
- * "id": 10240,
335
- * "name": "jira-developers",
336
- * "type": "atlassian-group-role-actor"
337
- * },
338
- * {
339
- * "actorUser": {
340
- * "accountId": "5b10a2844c20165700ede21g"
341
- * },
342
- * "displayName": "Mia Krystof",
343
- * "id": 10241,
344
- * "type": "atlassian-user-role-actor"
345
- * }
346
- * ],
347
- * "scope": {
348
- * "project": {
349
- * "id": "10000",
350
- * "key": "KEY",
351
- * "name": "Next Gen Project"
352
- * },
353
- * "type": "PROJECT"
354
- * }
355
- * },
356
- * "recipient": "10360"
357
- * },
358
- * {
359
- * "emailAddress": "rest-developer@atlassian.com",
360
- * "id": 4,
361
- * "notificationType": "EmailAddress",
362
- * "parameter": "rest-developer@atlassian.com",
363
- * "recipient": "rest-developer@atlassian.com"
364
- * },
365
- * {
366
- * "expand": "user",
367
- * "id": 5,
368
- * "notificationType": "User",
369
- * "parameter": "5b10a2844c20165700ede21g",
370
- * "recipient": "5b10a2844c20165700ede21g",
371
- * "user": {
372
- * "accountId": "5b10a2844c20165700ede21g",
373
- * "active": false,
374
- * "displayName": "Mia Krystof",
375
- * "self":
376
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
377
- * }
378
- * },
379
- * {
380
- * "expand": "field",
381
- * "field": {
382
- * "clauseNames": [
383
- * "cf[10101]",
384
- * "New custom field"
385
- * ],
386
- * "custom": true,
387
- * "id": "customfield_10101",
388
- * "key": "customfield_10101",
389
- * "name": "New custom field",
390
- * "navigable": true,
391
- * "orderable": true,
392
- * "schema": {
393
- * "custom":
394
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
395
- * "customId": 10101,
396
- * "type": "project"
397
- * },
398
- * "searchable": true,
399
- * "untranslatedName": "New custom field"
400
- * },
401
- * "id": 6,
402
- * "notificationType": "GroupCustomField",
403
- * "parameter": "customfield_10101",
404
- * "recipient": "customfield_10101"
405
- * }
406
- * ]
407
- * }
408
- * ],
409
- * "projects": [
410
- * 10001,
411
- * 10002
412
- * ],
413
- * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
414
- * }
415
- * @path {GET} /rest/api/3/notificationscheme/{id}
416
- * @scopes-current manage:jira-configuration
417
- * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
418
- * read:project-role:jira, read:user:jira, read:avatar:jira,
419
- * read:field-configuration:jira, read:group:jira, read:project-category:jira
420
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-get
421
- */
422
- getNotificationScheme({ id, expand, }) {
423
- return this.getClientInstance()
424
- .request({
425
- path: "/rest/api/3/notificationscheme/{id}",
426
- method: "GET",
427
- pathParams: {
428
- id,
429
- },
430
- query: {
431
- expand,
432
- },
433
- })
434
- .then(this.getClientInstance().responseHandler({
435
- 200: {
436
- "application/json": "json",
437
- },
438
- }))
439
- .then(commonHttpClient.castResponse())
440
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationScheme.response"))
441
- .then(commonHttpClient.getBody);
442
- }
443
- /**
444
- * Returns a [paginated](#pagination) list of [notification
445
- * schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
446
- *
447
- * *Note that you should allow for events without recipients to appear in
448
- * responses.*
449
- *
450
- * **[Permissions](#permissions) required:** Permission to access Jira, however,
451
- * the user must have permission to administer at least one project associated
452
- * with a notification scheme for it to be returned.
453
- *
454
- * @returns Returned if the request is successful. Only returns notification schemes that
455
- * the user has permission to access. An empty list is returned if the user lacks
456
- * permission to access all notification schemes.
457
- *
458
- * example: {
459
- * "isLast": false,
460
- * "maxResults": 6,
461
- * "startAt": 1,
462
- * "total": 5,
463
- * "values": [
464
- * {
465
- * "description": "description",
466
- * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
467
- * "id": 10100,
468
- * "name": "notification scheme name",
469
- * "notificationSchemeEvents": [
470
- * {
471
- * "event": {
472
- * "description": "Event published when an issue is created",
473
- * "id": 1,
474
- * "name": "Issue created"
475
- * },
476
- * "notifications": [
477
- * {
478
- * "expand": "group",
479
- * "group": {
480
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
481
- * "name": "jira-administrators",
482
- * "self":
483
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
484
- * },
485
- * "id": 1,
486
- * "notificationType": "Group",
487
- * "parameter": "jira-administrators",
488
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
489
- * },
490
- * {
491
- * "id": 2,
492
- * "notificationType": "CurrentAssignee"
493
- * },
494
- * {
495
- * "expand": "projectRole",
496
- * "id": 3,
497
- * "notificationType": "ProjectRole",
498
- * "parameter": "10360",
499
- * "projectRole": {
500
- * "self":
501
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
502
- * "name": "Developers",
503
- * "id": 10360,
504
- * "description": "A project role that represents developers in a
505
- * project",
506
- * "actors": [
507
- * {
508
- * "actorGroup": {
509
- * "name": "jira-developers",
510
- * "displayName": "jira-developers",
511
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
512
- * },
513
- * "displayName": "jira-developers",
514
- * "id": 10240,
515
- * "name": "jira-developers",
516
- * "type": "atlassian-group-role-actor"
517
- * },
518
- * {
519
- * "actorUser": {
520
- * "accountId": "5b10a2844c20165700ede21g"
521
- * },
522
- * "displayName": "Mia Krystof",
523
- * "id": 10241,
524
- * "type": "atlassian-user-role-actor"
525
- * }
526
- * ],
527
- * "scope": {
528
- * "project": {
529
- * "id": "10000",
530
- * "key": "KEY",
531
- * "name": "Next Gen Project"
532
- * },
533
- * "type": "PROJECT"
534
- * }
535
- * },
536
- * "recipient": "10360"
537
- * },
538
- * {
539
- * "emailAddress": "rest-developer@atlassian.com",
540
- * "id": 4,
541
- * "notificationType": "EmailAddress",
542
- * "parameter": "rest-developer@atlassian.com",
543
- * "recipient": "rest-developer@atlassian.com"
544
- * },
545
- * {
546
- * "expand": "user",
547
- * "id": 5,
548
- * "notificationType": "User",
549
- * "parameter": "5b10a2844c20165700ede21g",
550
- * "recipient": "5b10a2844c20165700ede21g",
551
- * "user": {
552
- * "accountId": "5b10a2844c20165700ede21g",
553
- * "active": false,
554
- * "displayName": "Mia Krystof",
555
- * "self":
556
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
557
- * }
558
- * },
559
- * {
560
- * "expand": "field",
561
- * "field": {
562
- * "clauseNames": [
563
- * "cf[10101]",
564
- * "New custom field"
565
- * ],
566
- * "custom": true,
567
- * "id": "customfield_10101",
568
- * "key": "customfield_10101",
569
- * "name": "New custom field",
570
- * "navigable": true,
571
- * "orderable": true,
572
- * "schema": {
573
- * "custom":
574
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
575
- * "customId": 10101,
576
- * "type": "project"
577
- * },
578
- * "searchable": true,
579
- * "untranslatedName": "New custom field"
580
- * },
581
- * "id": 6,
582
- * "notificationType": "GroupCustomField",
583
- * "parameter": "customfield_10101",
584
- * "recipient": "customfield_10101"
585
- * }
586
- * ]
587
- * },
588
- * {
589
- * "event": {
590
- * "description": "Custom event that is published together with an
591
- * issue created event",
592
- * "id": 20,
593
- * "name": "Custom event",
594
- * "templateEvent": {
595
- * "description": "Event published when an issue is created",
596
- * "id": 1,
597
- * "name": "Issue created"
598
- * }
599
- * },
600
- * "notifications": [
601
- * {
602
- * "expand": "group",
603
- * "group": {
604
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
605
- * "name": "jira-administrators",
606
- * "self":
607
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
608
- * },
609
- * "id": 1,
610
- * "notificationType": "Group",
611
- * "parameter": "jira-administrators",
612
- * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
613
- * },
614
- * {
615
- * "id": 2,
616
- * "notificationType": "CurrentAssignee"
617
- * },
618
- * {
619
- * "expand": "projectRole",
620
- * "id": 3,
621
- * "notificationType": "ProjectRole",
622
- * "parameter": "10360",
623
- * "projectRole": {
624
- * "self":
625
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
626
- * "name": "Developers",
627
- * "id": 10360,
628
- * "description": "A project role that represents developers in a
629
- * project",
630
- * "actors": [
631
- * {
632
- * "actorGroup": {
633
- * "name": "jira-developers",
634
- * "displayName": "jira-developers",
635
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
636
- * },
637
- * "displayName": "jira-developers",
638
- * "id": 10240,
639
- * "name": "jira-developers",
640
- * "type": "atlassian-group-role-actor"
641
- * },
642
- * {
643
- * "actorUser": {
644
- * "accountId": "5b10a2844c20165700ede21g"
645
- * },
646
- * "displayName": "Mia Krystof",
647
- * "id": 10241,
648
- * "type": "atlassian-user-role-actor"
649
- * }
650
- * ],
651
- * "scope": {
652
- * "project": {
653
- * "id": "10000",
654
- * "key": "KEY",
655
- * "name": "Next Gen Project"
656
- * },
657
- * "type": "PROJECT"
658
- * }
659
- * },
660
- * "recipient": "10360"
661
- * },
662
- * {
663
- * "emailAddress": "rest-developer@atlassian.com",
664
- * "id": 4,
665
- * "notificationType": "EmailAddress",
666
- * "parameter": "rest-developer@atlassian.com",
667
- * "recipient": "rest-developer@atlassian.com"
668
- * },
669
- * {
670
- * "expand": "user",
671
- * "id": 5,
672
- * "notificationType": "User",
673
- * "parameter": "5b10a2844c20165700ede21g",
674
- * "recipient": "5b10a2844c20165700ede21g",
675
- * "user": {
676
- * "accountId": "5b10a2844c20165700ede21g",
677
- * "active": false,
678
- * "displayName": "Mia Krystof",
679
- * "self":
680
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
681
- * }
682
- * },
683
- * {
684
- * "expand": "field",
685
- * "field": {
686
- * "clauseNames": [
687
- * "cf[10101]",
688
- * "New custom field"
689
- * ],
690
- * "custom": true,
691
- * "id": "customfield_10101",
692
- * "key": "customfield_10101",
693
- * "name": "New custom field",
694
- * "navigable": true,
695
- * "orderable": true,
696
- * "schema": {
697
- * "custom":
698
- * "com.atlassian.jira.plugin.system.customfieldtypes:project",
699
- * "customId": 10101,
700
- * "type": "project"
701
- * },
702
- * "searchable": true,
703
- * "untranslatedName": "New custom field"
704
- * },
705
- * "id": 6,
706
- * "notificationType": "GroupCustomField",
707
- * "parameter": "customfield_10101",
708
- * "recipient": "customfield_10101"
709
- * }
710
- * ]
711
- * }
712
- * ],
713
- * "projects": [
714
- * 10001,
715
- * 10002
716
- * ],
717
- * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
718
- * }
719
- * ]
720
- * }
721
- * @path {GET} /rest/api/3/notificationscheme
722
- * @scopes-current manage:jira-configuration
723
- * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
724
- * read:project-role:jira, read:user:jira, read:avatar:jira, read:group:jira,
725
- * read:project-category:jira, read:field-configuration:jira
726
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-get
727
- */
728
- getNotificationSchemes({ startAt, maxResults, id, projectId, onlyDefault, expand, } = {}) {
729
- return this.getClientInstance()
730
- .request({
731
- path: "/rest/api/3/notificationscheme",
732
- method: "GET",
733
- query: {
734
- startAt,
735
- maxResults,
736
- id,
737
- projectId,
738
- onlyDefault,
739
- expand,
740
- },
741
- })
742
- .then(this.getClientInstance().responseHandler({
743
- 200: {
744
- "application/json": "json",
745
- },
746
- }))
747
- .then(commonHttpClient.castResponse())
748
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemes.response"))
749
- .then(commonHttpClient.getBody);
750
- }
751
- /**
752
- * Returns a [paginated](#pagination) mapping of project that have notification
753
- * scheme assigned. You can provide either one or multiple notification scheme IDs
754
- * or project IDs to filter by. If you don't provide any, this will return a list
755
- * of all mappings. Note that only company-managed (classic) projects are
756
- * supported. This is because team-managed projects don't have a concept of a
757
- * default notification scheme. The mappings are ordered by projectId.
758
- *
759
- * **[Permissions](#permissions) required:** Permission to access Jira.
760
- *
761
- * @returns Returned if the request is successful.
762
- *
763
- * example: {
764
- * "isLast": true,
765
- * "maxResults": 50,
766
- * "startAt": 0,
767
- * "total": 4,
768
- * "values": [
769
- * {
770
- * "notificationSchemeId": "10001",
771
- * "projectId": "100001"
772
- * }
773
- * ]
774
- * }
775
- * @path {GET} /rest/api/3/notificationscheme/project
776
- * @scopes-current manage:jira-configuration
777
- * @scopes-beta read:notification-scheme:jira, read:project:jira
778
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-project-get
779
- */
780
- getNotificationSchemeToProjectMappings({ startAt, maxResults, notificationSchemeId, projectId, } = {}) {
781
- return this.getClientInstance()
782
- .request({
783
- path: "/rest/api/3/notificationscheme/project",
784
- method: "GET",
785
- query: {
786
- startAt,
787
- maxResults,
788
- notificationSchemeId,
789
- projectId,
790
- },
791
- })
792
- .then(this.getClientInstance().responseHandler({
793
- 200: {
794
- "application/json": "json",
795
- },
796
- }))
797
- .then(commonHttpClient.castResponse())
798
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemeToProjectMappings.response"))
799
- .then(commonHttpClient.getBody);
800
- }
801
- /**
802
- * Removes a notification from a notification scheme.
803
- *
804
- * **[Permissions](#permissions) required:** *Administer Jira* [global
805
- * permission](https://confluence.atlassian.com/x/x4dKLg).
806
- *
807
- * @returns Returned if the request is successful.
808
- * @path {DELETE}
809
- * /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
810
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-notification-notificationid-delete
811
- */
812
- removeNotificationFromNotificationScheme({ notificationSchemeId, notificationId, }) {
813
- return this.getClientInstance()
814
- .request({
815
- path: "/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}",
816
- method: "DELETE",
817
- pathParams: {
818
- notificationSchemeId,
819
- notificationId,
820
- },
821
- })
822
- .then(this.getClientInstance().responseHandler({
823
- 204: {
824
- "application/json": "json",
825
- },
826
- }))
827
- .then(commonHttpClient.castResponse())
828
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.removeNotificationFromNotificationScheme.response"))
829
- .then(commonHttpClient.getBody);
830
- }
831
- /**
832
- * Updates a notification scheme.
833
- *
834
- * **[Permissions](#permissions) required:** *Administer Jira* [global
835
- * permission](https://confluence.atlassian.com/x/x4dKLg).
836
- *
837
- * @returns Returned if the request is successful.
838
- * @path {PUT} /rest/api/3/notificationscheme/{id}
839
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-put
840
- */
841
- updateNotificationScheme({ id, updateNotificationSchemeDetails, }) {
842
- return this.getClientInstance()
843
- .request({
844
- path: "/rest/api/3/notificationscheme/{id}",
845
- method: "PUT",
846
- pathParams: {
847
- id,
848
- },
849
- headers: {
850
- "Content-Type": "application/json",
851
- },
852
- body: updateNotificationSchemeDetails,
853
- })
854
- .then(this.getClientInstance().responseHandler({
855
- 204: {
856
- "application/json": "json",
857
- },
858
- }))
859
- .then(commonHttpClient.castResponse())
860
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.updateNotificationScheme.response"))
861
- .then(commonHttpClient.getBody);
49
+ constructor() {
50
+ super(...arguments);
51
+ /**
52
+ * Adds notifications to a notification scheme. You can add up to 1000
53
+ * notifications per request.
54
+ *
55
+ * *Deprecated: The notification type `EmailAddress` is no longer supported in
56
+ * Cloud. Refer to the
57
+ * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031)
58
+ * for more details.*
59
+ *
60
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
61
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
62
+ *
63
+ * @returns Returned if the request is successful.
64
+ * @path {PUT} /rest/api/3/notificationscheme/{id}/notification
65
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-notification-put
66
+ */
67
+ this.addNotifications = ({ id, addNotificationsDetails, }) => {
68
+ return this.getClientInstance()
69
+ .request({
70
+ path: "/rest/api/3/notificationscheme/{id}/notification",
71
+ method: "PUT",
72
+ pathParams: {
73
+ id,
74
+ },
75
+ headers: {
76
+ "Content-Type": "application/json",
77
+ },
78
+ body: addNotificationsDetails,
79
+ })
80
+ .then(this.getClientInstance().responseHandler({
81
+ 204: {
82
+ "application/json": "json",
83
+ },
84
+ }))
85
+ .then(commonHttpClient.castResponse())
86
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.addNotifications.response"))
87
+ .then(commonHttpClient.getBody);
88
+ };
89
+ /**
90
+ * Creates a notification scheme with notifications. You can create up to 1000
91
+ * notifications per request.
92
+ *
93
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
94
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
95
+ *
96
+ * @returns Returned if the request is successful.
97
+ *
98
+ * example: {
99
+ * "id": "10001"
100
+ * }
101
+ * @path {POST} /rest/api/3/notificationscheme
102
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-post
103
+ */
104
+ this.createNotificationScheme = ({ createNotificationSchemeDetails, }) => {
105
+ return this.getClientInstance()
106
+ .request({
107
+ path: "/rest/api/3/notificationscheme",
108
+ method: "POST",
109
+ headers: {
110
+ "Content-Type": "application/json",
111
+ },
112
+ body: createNotificationSchemeDetails,
113
+ })
114
+ .then(this.getClientInstance().responseHandler({
115
+ 201: {
116
+ "application/json": "json",
117
+ },
118
+ }))
119
+ .then(commonHttpClient.castResponse())
120
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.createNotificationScheme.response"))
121
+ .then(commonHttpClient.getBody);
122
+ };
123
+ /**
124
+ * Deletes a notification scheme.
125
+ *
126
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
127
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
128
+ *
129
+ * @returns Returned if the request is successful.
130
+ * @path {DELETE} /rest/api/3/notificationscheme/{notificationSchemeId}
131
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-delete
132
+ */
133
+ this.deleteNotificationScheme = ({ notificationSchemeId, }) => {
134
+ return this.getClientInstance()
135
+ .request({
136
+ path: "/rest/api/3/notificationscheme/{notificationSchemeId}",
137
+ method: "DELETE",
138
+ pathParams: {
139
+ notificationSchemeId,
140
+ },
141
+ })
142
+ .then(this.getClientInstance().responseHandler({
143
+ 204: {
144
+ "application/json": "json",
145
+ },
146
+ }))
147
+ .then(commonHttpClient.castResponse())
148
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.deleteNotificationScheme.response"))
149
+ .then(commonHttpClient.getBody);
150
+ };
151
+ /**
152
+ * Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg),
153
+ * including the list of events and the recipients who will receive notifications
154
+ * for those events.
155
+ *
156
+ * **[Permissions](#permissions) required:** Permission to access Jira, however,
157
+ * the user must have permission to administer at least one project associated
158
+ * with the notification scheme.
159
+ *
160
+ * @returns Returned if the request is successful.
161
+ *
162
+ * example: {
163
+ * "description": "description",
164
+ * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
165
+ * "id": 10100,
166
+ * "name": "notification scheme name",
167
+ * "notificationSchemeEvents": [
168
+ * {
169
+ * "event": {
170
+ * "description": "Event published when an issue is created",
171
+ * "id": 1,
172
+ * "name": "Issue created"
173
+ * },
174
+ * "notifications": [
175
+ * {
176
+ * "expand": "group",
177
+ * "group": {
178
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
179
+ * "name": "jira-administrators",
180
+ * "self":
181
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
182
+ * },
183
+ * "id": 1,
184
+ * "notificationType": "Group",
185
+ * "parameter": "jira-administrators",
186
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
187
+ * },
188
+ * {
189
+ * "id": 2,
190
+ * "notificationType": "CurrentAssignee"
191
+ * },
192
+ * {
193
+ * "expand": "projectRole",
194
+ * "id": 3,
195
+ * "notificationType": "ProjectRole",
196
+ * "parameter": "10360",
197
+ * "projectRole": {
198
+ * "self":
199
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
200
+ * "name": "Developers",
201
+ * "id": 10360,
202
+ * "description": "A project role that represents developers in a
203
+ * project",
204
+ * "actors": [
205
+ * {
206
+ * "actorGroup": {
207
+ * "name": "jira-developers",
208
+ * "displayName": "jira-developers",
209
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
210
+ * },
211
+ * "displayName": "jira-developers",
212
+ * "id": 10240,
213
+ * "name": "jira-developers",
214
+ * "type": "atlassian-group-role-actor"
215
+ * },
216
+ * {
217
+ * "actorUser": {
218
+ * "accountId": "5b10a2844c20165700ede21g"
219
+ * },
220
+ * "displayName": "Mia Krystof",
221
+ * "id": 10241,
222
+ * "type": "atlassian-user-role-actor"
223
+ * }
224
+ * ],
225
+ * "scope": {
226
+ * "project": {
227
+ * "id": "10000",
228
+ * "key": "KEY",
229
+ * "name": "Next Gen Project"
230
+ * },
231
+ * "type": "PROJECT"
232
+ * }
233
+ * },
234
+ * "recipient": "10360"
235
+ * },
236
+ * {
237
+ * "emailAddress": "rest-developer@atlassian.com",
238
+ * "id": 4,
239
+ * "notificationType": "EmailAddress",
240
+ * "parameter": "rest-developer@atlassian.com",
241
+ * "recipient": "rest-developer@atlassian.com"
242
+ * },
243
+ * {
244
+ * "expand": "user",
245
+ * "id": 5,
246
+ * "notificationType": "User",
247
+ * "parameter": "5b10a2844c20165700ede21g",
248
+ * "recipient": "5b10a2844c20165700ede21g",
249
+ * "user": {
250
+ * "accountId": "5b10a2844c20165700ede21g",
251
+ * "active": false,
252
+ * "displayName": "Mia Krystof",
253
+ * "self":
254
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
255
+ * }
256
+ * },
257
+ * {
258
+ * "expand": "field",
259
+ * "field": {
260
+ * "clauseNames": [
261
+ * "cf[10101]",
262
+ * "New custom field"
263
+ * ],
264
+ * "custom": true,
265
+ * "id": "customfield_10101",
266
+ * "key": "customfield_10101",
267
+ * "name": "New custom field",
268
+ * "navigable": true,
269
+ * "orderable": true,
270
+ * "schema": {
271
+ * "custom":
272
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
273
+ * "customId": 10101,
274
+ * "type": "project"
275
+ * },
276
+ * "searchable": true,
277
+ * "untranslatedName": "New custom field"
278
+ * },
279
+ * "id": 6,
280
+ * "notificationType": "GroupCustomField",
281
+ * "parameter": "customfield_10101",
282
+ * "recipient": "customfield_10101"
283
+ * }
284
+ * ]
285
+ * },
286
+ * {
287
+ * "event": {
288
+ * "description": "Custom event that is published together with an issue
289
+ * created event",
290
+ * "id": 20,
291
+ * "name": "Custom event",
292
+ * "templateEvent": {
293
+ * "description": "Event published when an issue is created",
294
+ * "id": 1,
295
+ * "name": "Issue created"
296
+ * }
297
+ * },
298
+ * "notifications": [
299
+ * {
300
+ * "expand": "group",
301
+ * "group": {
302
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
303
+ * "name": "jira-administrators",
304
+ * "self":
305
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
306
+ * },
307
+ * "id": 1,
308
+ * "notificationType": "Group",
309
+ * "parameter": "jira-administrators",
310
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
311
+ * },
312
+ * {
313
+ * "id": 2,
314
+ * "notificationType": "CurrentAssignee"
315
+ * },
316
+ * {
317
+ * "expand": "projectRole",
318
+ * "id": 3,
319
+ * "notificationType": "ProjectRole",
320
+ * "parameter": "10360",
321
+ * "projectRole": {
322
+ * "self":
323
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
324
+ * "name": "Developers",
325
+ * "id": 10360,
326
+ * "description": "A project role that represents developers in a
327
+ * project",
328
+ * "actors": [
329
+ * {
330
+ * "actorGroup": {
331
+ * "name": "jira-developers",
332
+ * "displayName": "jira-developers",
333
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
334
+ * },
335
+ * "displayName": "jira-developers",
336
+ * "id": 10240,
337
+ * "name": "jira-developers",
338
+ * "type": "atlassian-group-role-actor"
339
+ * },
340
+ * {
341
+ * "actorUser": {
342
+ * "accountId": "5b10a2844c20165700ede21g"
343
+ * },
344
+ * "displayName": "Mia Krystof",
345
+ * "id": 10241,
346
+ * "type": "atlassian-user-role-actor"
347
+ * }
348
+ * ],
349
+ * "scope": {
350
+ * "project": {
351
+ * "id": "10000",
352
+ * "key": "KEY",
353
+ * "name": "Next Gen Project"
354
+ * },
355
+ * "type": "PROJECT"
356
+ * }
357
+ * },
358
+ * "recipient": "10360"
359
+ * },
360
+ * {
361
+ * "emailAddress": "rest-developer@atlassian.com",
362
+ * "id": 4,
363
+ * "notificationType": "EmailAddress",
364
+ * "parameter": "rest-developer@atlassian.com",
365
+ * "recipient": "rest-developer@atlassian.com"
366
+ * },
367
+ * {
368
+ * "expand": "user",
369
+ * "id": 5,
370
+ * "notificationType": "User",
371
+ * "parameter": "5b10a2844c20165700ede21g",
372
+ * "recipient": "5b10a2844c20165700ede21g",
373
+ * "user": {
374
+ * "accountId": "5b10a2844c20165700ede21g",
375
+ * "active": false,
376
+ * "displayName": "Mia Krystof",
377
+ * "self":
378
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
379
+ * }
380
+ * },
381
+ * {
382
+ * "expand": "field",
383
+ * "field": {
384
+ * "clauseNames": [
385
+ * "cf[10101]",
386
+ * "New custom field"
387
+ * ],
388
+ * "custom": true,
389
+ * "id": "customfield_10101",
390
+ * "key": "customfield_10101",
391
+ * "name": "New custom field",
392
+ * "navigable": true,
393
+ * "orderable": true,
394
+ * "schema": {
395
+ * "custom":
396
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
397
+ * "customId": 10101,
398
+ * "type": "project"
399
+ * },
400
+ * "searchable": true,
401
+ * "untranslatedName": "New custom field"
402
+ * },
403
+ * "id": 6,
404
+ * "notificationType": "GroupCustomField",
405
+ * "parameter": "customfield_10101",
406
+ * "recipient": "customfield_10101"
407
+ * }
408
+ * ]
409
+ * }
410
+ * ],
411
+ * "projects": [
412
+ * 10001,
413
+ * 10002
414
+ * ],
415
+ * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
416
+ * }
417
+ * @path {GET} /rest/api/3/notificationscheme/{id}
418
+ * @scopes-current manage:jira-configuration
419
+ * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
420
+ * read:project-role:jira, read:user:jira, read:avatar:jira,
421
+ * read:field-configuration:jira, read:group:jira, read:project-category:jira
422
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-get
423
+ */
424
+ this.getNotificationScheme = ({ id, expand, }) => {
425
+ return this.getClientInstance()
426
+ .request({
427
+ path: "/rest/api/3/notificationscheme/{id}",
428
+ method: "GET",
429
+ pathParams: {
430
+ id,
431
+ },
432
+ query: {
433
+ expand,
434
+ },
435
+ })
436
+ .then(this.getClientInstance().responseHandler({
437
+ 200: {
438
+ "application/json": "json",
439
+ },
440
+ }))
441
+ .then(commonHttpClient.castResponse())
442
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationScheme.response"))
443
+ .then(commonHttpClient.getBody);
444
+ };
445
+ /**
446
+ * Returns a [paginated](#pagination) list of [notification
447
+ * schemes](https://confluence.atlassian.com/x/8YdKLg) ordered by the display name.
448
+ *
449
+ * *Note that you should allow for events without recipients to appear in
450
+ * responses.*
451
+ *
452
+ * **[Permissions](#permissions) required:** Permission to access Jira, however,
453
+ * the user must have permission to administer at least one project associated
454
+ * with a notification scheme for it to be returned.
455
+ *
456
+ * @returns Returned if the request is successful. Only returns notification schemes that
457
+ * the user has permission to access. An empty list is returned if the user lacks
458
+ * permission to access all notification schemes.
459
+ *
460
+ * example: {
461
+ * "isLast": false,
462
+ * "maxResults": 6,
463
+ * "startAt": 1,
464
+ * "total": 5,
465
+ * "values": [
466
+ * {
467
+ * "description": "description",
468
+ * "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
469
+ * "id": 10100,
470
+ * "name": "notification scheme name",
471
+ * "notificationSchemeEvents": [
472
+ * {
473
+ * "event": {
474
+ * "description": "Event published when an issue is created",
475
+ * "id": 1,
476
+ * "name": "Issue created"
477
+ * },
478
+ * "notifications": [
479
+ * {
480
+ * "expand": "group",
481
+ * "group": {
482
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
483
+ * "name": "jira-administrators",
484
+ * "self":
485
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
486
+ * },
487
+ * "id": 1,
488
+ * "notificationType": "Group",
489
+ * "parameter": "jira-administrators",
490
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
491
+ * },
492
+ * {
493
+ * "id": 2,
494
+ * "notificationType": "CurrentAssignee"
495
+ * },
496
+ * {
497
+ * "expand": "projectRole",
498
+ * "id": 3,
499
+ * "notificationType": "ProjectRole",
500
+ * "parameter": "10360",
501
+ * "projectRole": {
502
+ * "self":
503
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
504
+ * "name": "Developers",
505
+ * "id": 10360,
506
+ * "description": "A project role that represents developers in a
507
+ * project",
508
+ * "actors": [
509
+ * {
510
+ * "actorGroup": {
511
+ * "name": "jira-developers",
512
+ * "displayName": "jira-developers",
513
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
514
+ * },
515
+ * "displayName": "jira-developers",
516
+ * "id": 10240,
517
+ * "name": "jira-developers",
518
+ * "type": "atlassian-group-role-actor"
519
+ * },
520
+ * {
521
+ * "actorUser": {
522
+ * "accountId": "5b10a2844c20165700ede21g"
523
+ * },
524
+ * "displayName": "Mia Krystof",
525
+ * "id": 10241,
526
+ * "type": "atlassian-user-role-actor"
527
+ * }
528
+ * ],
529
+ * "scope": {
530
+ * "project": {
531
+ * "id": "10000",
532
+ * "key": "KEY",
533
+ * "name": "Next Gen Project"
534
+ * },
535
+ * "type": "PROJECT"
536
+ * }
537
+ * },
538
+ * "recipient": "10360"
539
+ * },
540
+ * {
541
+ * "emailAddress": "rest-developer@atlassian.com",
542
+ * "id": 4,
543
+ * "notificationType": "EmailAddress",
544
+ * "parameter": "rest-developer@atlassian.com",
545
+ * "recipient": "rest-developer@atlassian.com"
546
+ * },
547
+ * {
548
+ * "expand": "user",
549
+ * "id": 5,
550
+ * "notificationType": "User",
551
+ * "parameter": "5b10a2844c20165700ede21g",
552
+ * "recipient": "5b10a2844c20165700ede21g",
553
+ * "user": {
554
+ * "accountId": "5b10a2844c20165700ede21g",
555
+ * "active": false,
556
+ * "displayName": "Mia Krystof",
557
+ * "self":
558
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
559
+ * }
560
+ * },
561
+ * {
562
+ * "expand": "field",
563
+ * "field": {
564
+ * "clauseNames": [
565
+ * "cf[10101]",
566
+ * "New custom field"
567
+ * ],
568
+ * "custom": true,
569
+ * "id": "customfield_10101",
570
+ * "key": "customfield_10101",
571
+ * "name": "New custom field",
572
+ * "navigable": true,
573
+ * "orderable": true,
574
+ * "schema": {
575
+ * "custom":
576
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
577
+ * "customId": 10101,
578
+ * "type": "project"
579
+ * },
580
+ * "searchable": true,
581
+ * "untranslatedName": "New custom field"
582
+ * },
583
+ * "id": 6,
584
+ * "notificationType": "GroupCustomField",
585
+ * "parameter": "customfield_10101",
586
+ * "recipient": "customfield_10101"
587
+ * }
588
+ * ]
589
+ * },
590
+ * {
591
+ * "event": {
592
+ * "description": "Custom event that is published together with an
593
+ * issue created event",
594
+ * "id": 20,
595
+ * "name": "Custom event",
596
+ * "templateEvent": {
597
+ * "description": "Event published when an issue is created",
598
+ * "id": 1,
599
+ * "name": "Issue created"
600
+ * }
601
+ * },
602
+ * "notifications": [
603
+ * {
604
+ * "expand": "group",
605
+ * "group": {
606
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
607
+ * "name": "jira-administrators",
608
+ * "self":
609
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
610
+ * },
611
+ * "id": 1,
612
+ * "notificationType": "Group",
613
+ * "parameter": "jira-administrators",
614
+ * "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
615
+ * },
616
+ * {
617
+ * "id": 2,
618
+ * "notificationType": "CurrentAssignee"
619
+ * },
620
+ * {
621
+ * "expand": "projectRole",
622
+ * "id": 3,
623
+ * "notificationType": "ProjectRole",
624
+ * "parameter": "10360",
625
+ * "projectRole": {
626
+ * "self":
627
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
628
+ * "name": "Developers",
629
+ * "id": 10360,
630
+ * "description": "A project role that represents developers in a
631
+ * project",
632
+ * "actors": [
633
+ * {
634
+ * "actorGroup": {
635
+ * "name": "jira-developers",
636
+ * "displayName": "jira-developers",
637
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
638
+ * },
639
+ * "displayName": "jira-developers",
640
+ * "id": 10240,
641
+ * "name": "jira-developers",
642
+ * "type": "atlassian-group-role-actor"
643
+ * },
644
+ * {
645
+ * "actorUser": {
646
+ * "accountId": "5b10a2844c20165700ede21g"
647
+ * },
648
+ * "displayName": "Mia Krystof",
649
+ * "id": 10241,
650
+ * "type": "atlassian-user-role-actor"
651
+ * }
652
+ * ],
653
+ * "scope": {
654
+ * "project": {
655
+ * "id": "10000",
656
+ * "key": "KEY",
657
+ * "name": "Next Gen Project"
658
+ * },
659
+ * "type": "PROJECT"
660
+ * }
661
+ * },
662
+ * "recipient": "10360"
663
+ * },
664
+ * {
665
+ * "emailAddress": "rest-developer@atlassian.com",
666
+ * "id": 4,
667
+ * "notificationType": "EmailAddress",
668
+ * "parameter": "rest-developer@atlassian.com",
669
+ * "recipient": "rest-developer@atlassian.com"
670
+ * },
671
+ * {
672
+ * "expand": "user",
673
+ * "id": 5,
674
+ * "notificationType": "User",
675
+ * "parameter": "5b10a2844c20165700ede21g",
676
+ * "recipient": "5b10a2844c20165700ede21g",
677
+ * "user": {
678
+ * "accountId": "5b10a2844c20165700ede21g",
679
+ * "active": false,
680
+ * "displayName": "Mia Krystof",
681
+ * "self":
682
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
683
+ * }
684
+ * },
685
+ * {
686
+ * "expand": "field",
687
+ * "field": {
688
+ * "clauseNames": [
689
+ * "cf[10101]",
690
+ * "New custom field"
691
+ * ],
692
+ * "custom": true,
693
+ * "id": "customfield_10101",
694
+ * "key": "customfield_10101",
695
+ * "name": "New custom field",
696
+ * "navigable": true,
697
+ * "orderable": true,
698
+ * "schema": {
699
+ * "custom":
700
+ * "com.atlassian.jira.plugin.system.customfieldtypes:project",
701
+ * "customId": 10101,
702
+ * "type": "project"
703
+ * },
704
+ * "searchable": true,
705
+ * "untranslatedName": "New custom field"
706
+ * },
707
+ * "id": 6,
708
+ * "notificationType": "GroupCustomField",
709
+ * "parameter": "customfield_10101",
710
+ * "recipient": "customfield_10101"
711
+ * }
712
+ * ]
713
+ * }
714
+ * ],
715
+ * "projects": [
716
+ * 10001,
717
+ * 10002
718
+ * ],
719
+ * "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
720
+ * }
721
+ * ]
722
+ * }
723
+ * @path {GET} /rest/api/3/notificationscheme
724
+ * @scopes-current manage:jira-configuration
725
+ * @scopes-beta read:field:jira, read:notification-scheme:jira, read:project:jira,
726
+ * read:project-role:jira, read:user:jira, read:avatar:jira, read:group:jira,
727
+ * read:project-category:jira, read:field-configuration:jira
728
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-get
729
+ */
730
+ this.getNotificationSchemes = ({ startAt, maxResults, id, projectId, onlyDefault, expand, } = {}) => {
731
+ return this.getClientInstance()
732
+ .request({
733
+ path: "/rest/api/3/notificationscheme",
734
+ method: "GET",
735
+ query: {
736
+ startAt,
737
+ maxResults,
738
+ id,
739
+ projectId,
740
+ onlyDefault,
741
+ expand,
742
+ },
743
+ })
744
+ .then(this.getClientInstance().responseHandler({
745
+ 200: {
746
+ "application/json": "json",
747
+ },
748
+ }))
749
+ .then(commonHttpClient.castResponse())
750
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemes.response"))
751
+ .then(commonHttpClient.getBody);
752
+ };
753
+ /**
754
+ * Returns a [paginated](#pagination) mapping of project that have notification
755
+ * scheme assigned. You can provide either one or multiple notification scheme IDs
756
+ * or project IDs to filter by. If you don't provide any, this will return a list
757
+ * of all mappings. Note that only company-managed (classic) projects are
758
+ * supported. This is because team-managed projects don't have a concept of a
759
+ * default notification scheme. The mappings are ordered by projectId.
760
+ *
761
+ * **[Permissions](#permissions) required:** Permission to access Jira.
762
+ *
763
+ * @returns Returned if the request is successful.
764
+ *
765
+ * example: {
766
+ * "isLast": true,
767
+ * "maxResults": 50,
768
+ * "startAt": 0,
769
+ * "total": 4,
770
+ * "values": [
771
+ * {
772
+ * "notificationSchemeId": "10001",
773
+ * "projectId": "100001"
774
+ * }
775
+ * ]
776
+ * }
777
+ * @path {GET} /rest/api/3/notificationscheme/project
778
+ * @scopes-current manage:jira-configuration
779
+ * @scopes-beta read:notification-scheme:jira, read:project:jira
780
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-project-get
781
+ */
782
+ this.getNotificationSchemeToProjectMappings = ({ startAt, maxResults, notificationSchemeId, projectId, } = {}) => {
783
+ return this.getClientInstance()
784
+ .request({
785
+ path: "/rest/api/3/notificationscheme/project",
786
+ method: "GET",
787
+ query: {
788
+ startAt,
789
+ maxResults,
790
+ notificationSchemeId,
791
+ projectId,
792
+ },
793
+ })
794
+ .then(this.getClientInstance().responseHandler({
795
+ 200: {
796
+ "application/json": "json",
797
+ },
798
+ }))
799
+ .then(commonHttpClient.castResponse())
800
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.getNotificationSchemeToProjectMappings.response"))
801
+ .then(commonHttpClient.getBody);
802
+ };
803
+ /**
804
+ * Removes a notification from a notification scheme.
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
+ * @path {DELETE}
811
+ * /rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}
812
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-notificationschemeid-notification-notificationid-delete
813
+ */
814
+ this.removeNotificationFromNotificationScheme = ({ notificationSchemeId, notificationId, }) => {
815
+ return this.getClientInstance()
816
+ .request({
817
+ path: "/rest/api/3/notificationscheme/{notificationSchemeId}/notification/{notificationId}",
818
+ method: "DELETE",
819
+ pathParams: {
820
+ notificationSchemeId,
821
+ notificationId,
822
+ },
823
+ })
824
+ .then(this.getClientInstance().responseHandler({
825
+ 204: {
826
+ "application/json": "json",
827
+ },
828
+ }))
829
+ .then(commonHttpClient.castResponse())
830
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.removeNotificationFromNotificationScheme.response"))
831
+ .then(commonHttpClient.getBody);
832
+ };
833
+ /**
834
+ * Updates a notification scheme.
835
+ *
836
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
837
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
838
+ *
839
+ * @returns Returned if the request is successful.
840
+ * @path {PUT} /rest/api/3/notificationscheme/{id}
841
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes#api-rest-api-3-notificationscheme-id-put
842
+ */
843
+ this.updateNotificationScheme = ({ id, updateNotificationSchemeDetails, }) => {
844
+ return this.getClientInstance()
845
+ .request({
846
+ path: "/rest/api/3/notificationscheme/{id}",
847
+ method: "PUT",
848
+ pathParams: {
849
+ id,
850
+ },
851
+ headers: {
852
+ "Content-Type": "application/json",
853
+ },
854
+ body: updateNotificationSchemeDetails,
855
+ })
856
+ .then(this.getClientInstance().responseHandler({
857
+ 204: {
858
+ "application/json": "json",
859
+ },
860
+ }))
861
+ .then(commonHttpClient.castResponse())
862
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueNotificationSchemesService.updateNotificationScheme.response"))
863
+ .then(commonHttpClient.getBody);
864
+ };
862
865
  }
863
866
  static initialize() {
864
867
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueNotificationSchemesService.getNotificationSchemes.response", zod_1.z