@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
@@ -21,640 +21,643 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
21
21
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users
22
22
  */
23
23
  class UsersService extends CommonHttpService_1.CommonHttpService {
24
- /**
25
- * Returns a [paginated](#pagination) list of the users specified by one or more
26
- * account IDs.
27
- *
28
- * **[Permissions](#permissions) required:** Permission to access Jira.
29
- *
30
- * @returns Returned if the request is successful.
31
- *
32
- * example: {
33
- * "isLast": true,
34
- * "maxResults": 100,
35
- * "startAt": 0,
36
- * "total": 1,
37
- * "values": [
38
- * {
39
- * "accountId": "5b10a2844c20165700ede21g",
40
- * "accountType": "atlassian",
41
- * "active": true,
42
- * "avatarUrls": {
43
- * "16x16":
44
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
45
- * "24x24":
46
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
47
- * "32x32":
48
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
49
- * "48x48":
50
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
51
- * },
52
- * "displayName": "Mia Krystof",
53
- * "emailAddress": "mia@example.com",
54
- * "self":
55
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
56
- * "timeZone": "Australia/Sydney"
57
- * }
58
- * ]
59
- * }
60
- * @path {GET} /rest/api/3/user/bulk
61
- * @scopes-current read:jira-user
62
- * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
63
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-get
64
- */
65
- bulkGetUsers({ startAt, maxResults, username, key, accountId, }) {
66
- return this.getClientInstance()
67
- .request({
68
- path: "/rest/api/3/user/bulk",
69
- method: "GET",
70
- query: {
71
- startAt,
72
- maxResults,
73
- username,
74
- key,
75
- accountId,
76
- },
77
- })
78
- .then(this.getClientInstance().responseHandler({
79
- 200: {
80
- "application/json": "json",
81
- },
82
- }))
83
- .then(commonHttpClient.castResponse())
84
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.bulkGetUsers.response"))
85
- .then(commonHttpClient.getBody);
86
- }
87
- /**
88
- * Returns the account IDs for the users specified in the `key` or `username`
89
- * parameters. Note that multiple `key` or `username` parameters can be specified.
90
- *
91
- * **[Permissions](#permissions) required:** Permission to access Jira.
92
- *
93
- * @returns Returned if the request is successful.
94
- *
95
- * example: [
96
- * {
97
- * "username": "mia",
98
- * "accountId": "5b10a2844c20165700ede21g"
99
- * },
100
- * {
101
- * "username": "emma",
102
- * "accountId": "5b10ac8d82e05b22cc7d4ef5"
103
- * }
104
- * ]
105
- * @path {GET} /rest/api/3/user/bulk/migration
106
- * @scopes-current read:jira-user
107
- * @scopes-beta read:user:jira
108
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-migration-get
109
- */
110
- bulkGetUsersMigration({ startAt, maxResults, username, key, } = {}) {
111
- return this.getClientInstance()
112
- .request({
113
- path: "/rest/api/3/user/bulk/migration",
114
- method: "GET",
115
- query: {
116
- startAt,
117
- maxResults,
118
- username,
119
- key,
120
- },
121
- })
122
- .then(this.getClientInstance().responseHandler({
123
- 200: {
124
- "application/json": "json",
125
- },
126
- }))
127
- .then(commonHttpClient.castResponse())
128
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.bulkGetUsersMigration.response"))
129
- .then(commonHttpClient.getBody);
130
- }
131
- /**
132
- * Creates a user. This resource is retained for legacy compatibility. As soon as
133
- * a more suitable alternative is available this resource will be deprecated.
134
- *
135
- * If the user exists and has access to Jira, the operation returns a 201 status.
136
- * If the user exists but does not have access to Jira, the operation returns a
137
- * 400 status.
138
- *
139
- * **[Permissions](#permissions) required:** *Administer Jira* [global
140
- * permission](https://confluence.atlassian.com/x/x4dKLg).
141
- *
142
- * @returns Returned if the request is successful.
143
- *
144
- * example: {
145
- * "accountId": "5b10a2844c20165700ede21g",
146
- * "accountType": "atlassian",
147
- * "active": true,
148
- * "applicationRoles": {
149
- * "items": [],
150
- * "size": 1
151
- * },
152
- * "avatarUrls": {
153
- * "16x16":
154
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
155
- * "24x24":
156
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
157
- * "32x32":
158
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
159
- * "48x48":
160
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
161
- * },
162
- * "displayName": "Mia Krystof",
163
- * "emailAddress": "mia@example.com",
164
- * "groups": {
165
- * "items": [],
166
- * "size": 3
167
- * },
168
- * "key": "",
169
- * "name": "",
170
- * "self":
171
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
172
- * "timeZone": "Australia/Sydney"
173
- * }
174
- * @path {POST} /rest/api/3/user
175
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-post
176
- */
177
- createUser({ newUserDetails, }) {
178
- return this.getClientInstance()
179
- .request({
180
- path: "/rest/api/3/user",
181
- method: "POST",
182
- headers: {
183
- "Content-Type": "application/json",
184
- },
185
- body: newUserDetails,
186
- })
187
- .then(this.getClientInstance().responseHandler({
188
- 201: {
189
- "application/json": "json",
190
- },
191
- }))
192
- .then(commonHttpClient.castResponse())
193
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.createUser.response"))
194
- .then(commonHttpClient.getBody);
195
- }
196
- /**
197
- * Returns a list of all users, including active users, inactive users and
198
- * previously deleted users that have an Atlassian account.
199
- *
200
- * Privacy controls are applied to the response based on the users' preferences.
201
- * This could mean, for example, that the user's email address is hidden. See the
202
- * [Profile visibility
203
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
204
- * for more details.
205
- *
206
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
207
- * permission](https://confluence.atlassian.com/x/x4dKLg).
208
- *
209
- * @returns Returned if the request is successful.
210
- *
211
- * example: [
212
- * {
213
- * "accountId": "5b10a2844c20165700ede21g",
214
- * "accountType": "atlassian",
215
- * "active": false,
216
- * "avatarUrls": {
217
- * "16x16":
218
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
219
- * "24x24":
220
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
221
- * "32x32":
222
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
223
- * "48x48":
224
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
225
- * },
226
- * "displayName": "Mia Krystof",
227
- * "key": "",
228
- * "name": "",
229
- * "self":
230
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
231
- * },
232
- * {
233
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
234
- * "accountType": "atlassian",
235
- * "active": false,
236
- * "avatarUrls": {
237
- * "16x16":
238
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
239
- * "24x24":
240
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
241
- * "32x32":
242
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
243
- * "48x48":
244
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
245
- * },
246
- * "displayName": "Emma Richards",
247
- * "key": "",
248
- * "name": "",
249
- * "self":
250
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
251
- * }
252
- * ]
253
- * @path {GET} /rest/api/3/users/search
254
- * @scopes-current read:jira-user
255
- * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
256
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-search-get
257
- */
258
- getAllUsers({ startAt, maxResults, } = {}) {
259
- return this.getClientInstance()
260
- .request({
261
- path: "/rest/api/3/users/search",
262
- method: "GET",
263
- query: {
264
- startAt,
265
- maxResults,
266
- },
267
- })
268
- .then(this.getClientInstance().responseHandler({
269
- 200: {
270
- "application/json": "json",
271
- },
272
- }))
273
- .then(commonHttpClient.castResponse())
274
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getAllUsers.response"))
275
- .then(commonHttpClient.getBody);
276
- }
277
- /**
278
- * Returns a list of all users, including active users, inactive users and
279
- * previously deleted users that have an Atlassian account.
280
- *
281
- * Privacy controls are applied to the response based on the users' preferences.
282
- * This could mean, for example, that the user's email address is hidden. See the
283
- * [Profile visibility
284
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
285
- * for more details.
286
- *
287
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
288
- * permission](https://confluence.atlassian.com/x/x4dKLg).
289
- *
290
- * @returns Returned if the request is successful.
291
- *
292
- * example: [
293
- * {
294
- * "accountId": "5b10a2844c20165700ede21g",
295
- * "accountType": "atlassian",
296
- * "active": false,
297
- * "avatarUrls": {
298
- * "16x16":
299
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
300
- * "24x24":
301
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
302
- * "32x32":
303
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
304
- * "48x48":
305
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
306
- * },
307
- * "displayName": "Mia Krystof",
308
- * "key": "",
309
- * "name": "",
310
- * "self":
311
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
312
- * },
313
- * {
314
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
315
- * "accountType": "atlassian",
316
- * "active": false,
317
- * "avatarUrls": {
318
- * "16x16":
319
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
320
- * "24x24":
321
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
322
- * "32x32":
323
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
324
- * "48x48":
325
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
326
- * },
327
- * "displayName": "Emma Richards",
328
- * "key": "",
329
- * "name": "",
330
- * "self":
331
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
332
- * }
333
- * ]
334
- * @path {GET} /rest/api/3/users
335
- * @scopes-current read:jira-user
336
- * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
337
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-get
338
- */
339
- getAllUsersDefault({ startAt, maxResults, } = {}) {
340
- return this.getClientInstance()
341
- .request({
342
- path: "/rest/api/3/users",
343
- method: "GET",
344
- query: {
345
- startAt,
346
- maxResults,
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("UsersService.getAllUsersDefault.response"))
356
- .then(commonHttpClient.getBody);
357
- }
358
- /**
359
- * Returns a user.
360
- *
361
- * Privacy controls are applied to the response based on the user's preferences.
362
- * This could mean, for example, that the user's email address is hidden. See the
363
- * [Profile visibility
364
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
365
- * for more details.
366
- *
367
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
368
- * permission](https://confluence.atlassian.com/x/x4dKLg).
369
- *
370
- * @returns Returned if the request is successful.
371
- *
372
- * example: {
373
- * "accountId": "5b10a2844c20165700ede21g",
374
- * "accountType": "atlassian",
375
- * "active": true,
376
- * "applicationRoles": {
377
- * "items": [],
378
- * "size": 1
379
- * },
380
- * "avatarUrls": {
381
- * "16x16":
382
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
383
- * "24x24":
384
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
385
- * "32x32":
386
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
387
- * "48x48":
388
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
389
- * },
390
- * "displayName": "Mia Krystof",
391
- * "emailAddress": "mia@example.com",
392
- * "groups": {
393
- * "items": [],
394
- * "size": 3
395
- * },
396
- * "key": "",
397
- * "name": "",
398
- * "self":
399
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
400
- * "timeZone": "Australia/Sydney"
401
- * }
402
- * @path {GET} /rest/api/3/user
403
- * @scopes-current read:jira-user
404
- * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
405
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-get
406
- */
407
- getUser({ accountId, username, key, expand, } = {}) {
408
- return this.getClientInstance()
409
- .request({
410
- path: "/rest/api/3/user",
411
- method: "GET",
412
- query: {
413
- accountId,
414
- username,
415
- key,
416
- expand,
417
- },
418
- })
419
- .then(this.getClientInstance().responseHandler({
420
- 200: {
421
- "application/json": "json",
422
- },
423
- }))
424
- .then(commonHttpClient.castResponse())
425
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUser.response"))
426
- .then(commonHttpClient.getBody);
427
- }
428
- /**
429
- * Returns the default [issue table
430
- * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If
431
- * `accountId` is not passed in the request, the calling user's details are
432
- * returned.
433
- *
434
- * **[Permissions](#permissions) required:**
435
- *
436
- * * *Administer Jira* [global
437
- * permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column
438
- * details for any user.
439
- * * Permission to access Jira, to get the calling user's column details.
440
- *
441
- * @returns Returned if the request is successful.
442
- * @path {GET} /rest/api/3/user/columns
443
- * @scopes-current read:jira-user
444
- * @scopes-beta read:user.columns:jira, read:filter.column:jira
445
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-get
446
- */
447
- getUserDefaultColumns({ accountId, username, } = {}) {
448
- return this.getClientInstance()
449
- .request({
450
- path: "/rest/api/3/user/columns",
451
- method: "GET",
452
- query: {
453
- accountId,
454
- username,
455
- },
456
- })
457
- .then(this.getClientInstance().responseHandler({
458
- 200: {
459
- "application/json": "json",
460
- },
461
- }))
462
- .then(commonHttpClient.castResponse())
463
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserDefaultColumns.response"))
464
- .then(commonHttpClient.getBody);
465
- }
466
- /**
467
- * Returns a user's email address. This API is only available to apps approved by
468
- * Atlassian, according to these
469
- * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
470
- *
471
- * @returns Returned if the request is successful.
472
- *
473
- * example: name@example.com
474
- * @path {GET} /rest/api/3/user/email
475
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-get
476
- */
477
- getUserEmail({ accountId, }) {
478
- return this.getClientInstance()
479
- .request({
480
- path: "/rest/api/3/user/email",
481
- method: "GET",
482
- query: {
483
- accountId,
484
- },
485
- })
486
- .then(this.getClientInstance().responseHandler({
487
- 200: {
488
- "application/json": "json",
489
- },
490
- }))
491
- .then(commonHttpClient.castResponse())
492
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserEmail.response"))
493
- .then(commonHttpClient.getBody);
494
- }
495
- /**
496
- * Returns a user's email address. This API is only available to apps approved by
497
- * Atlassian, according to these
498
- * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
499
- *
500
- * @returns Returned if the request is successful.
501
- * @path {GET} /rest/api/3/user/email/bulk
502
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-bulk-get
503
- */
504
- getUserEmailBulk({ accountId, }) {
505
- return this.getClientInstance()
506
- .request({
507
- path: "/rest/api/3/user/email/bulk",
508
- method: "GET",
509
- query: {
510
- accountId,
511
- },
512
- })
513
- .then(this.getClientInstance().responseHandler({
514
- 200: {
515
- "application/json": "json",
516
- },
517
- }))
518
- .then(commonHttpClient.castResponse())
519
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserEmailBulk.response"))
520
- .then(commonHttpClient.getBody);
521
- }
522
- /**
523
- * Returns the groups to which a user belongs.
524
- *
525
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
526
- * permission](https://confluence.atlassian.com/x/x4dKLg).
527
- *
528
- * @returns Returned if the request is successful.
529
- *
530
- * example: {
531
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
532
- * "name": "jira-administrators",
533
- * "self":
534
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
535
- * }
536
- * @path {GET} /rest/api/3/user/groups
537
- * @scopes-current read:jira-user
538
- * @scopes-beta read:group:jira
539
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-groups-get
540
- */
541
- getUserGroups({ accountId, username, key, }) {
542
- return this.getClientInstance()
543
- .request({
544
- path: "/rest/api/3/user/groups",
545
- method: "GET",
546
- query: {
547
- accountId,
548
- username,
549
- key,
550
- },
551
- })
552
- .then(this.getClientInstance().responseHandler({
553
- 200: {
554
- "application/json": "json",
555
- },
556
- }))
557
- .then(commonHttpClient.castResponse())
558
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserGroups.response"))
559
- .then(commonHttpClient.getBody);
560
- }
561
- /**
562
- * Deletes a user. If the operation completes successfully then the user is
563
- * removed from Jira's user base. This operation does not delete the user's
564
- * Atlassian account.
565
- *
566
- * **[Permissions](#permissions) required:** Site administration (that is,
567
- * membership of the *site-admin*
568
- * [group](https://confluence.atlassian.com/x/24xjL)).
569
- *
570
- * @path {DELETE} /rest/api/3/user
571
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-delete
572
- */
573
- removeUser({ accountId, username, key, }) {
574
- return this.getClientInstance()
575
- .request({
576
- path: "/rest/api/3/user",
577
- method: "DELETE",
578
- query: {
579
- accountId,
580
- username,
581
- key,
582
- },
583
- })
584
- .then(commonHttpClient.discardResult);
585
- }
586
- /**
587
- * Resets the default [ issue table
588
- * columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system
589
- * default. If `accountId` is not passed, the calling user's default columns are
590
- * reset.
591
- *
592
- * **[Permissions](#permissions) required:**
593
- *
594
- * * *Administer Jira* [global
595
- * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
596
- * any user.
597
- * * Permission to access Jira, to set the calling user's columns.
598
- *
599
- * @path {DELETE} /rest/api/3/user/columns
600
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-delete
601
- */
602
- resetUserColumns({ accountId, username, } = {}) {
603
- return this.getClientInstance()
604
- .request({
605
- path: "/rest/api/3/user/columns",
606
- method: "DELETE",
607
- query: {
608
- accountId,
609
- username,
610
- },
611
- })
612
- .then(commonHttpClient.discardResult);
613
- }
614
- /**
615
- * Sets the default [ issue table
616
- * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account
617
- * ID is not passed, the calling user's default columns are set. If no column
618
- * details are sent, then all default columns are removed.
619
- *
620
- * The parameters for this resource are expressed as HTML form data. For example,
621
- * in curl:
622
- *
623
- * `curl -X PUT -d columns=summary -d columns=description
624
- * https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`
625
- *
626
- * **[Permissions](#permissions) required:**
627
- *
628
- * * *Administer Jira* [global
629
- * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
630
- * any user.
631
- * * Permission to access Jira, to set the calling user's columns.
632
- *
633
- * @returns Returned if the request is successful.
634
- * @path {PUT} /rest/api/3/user/columns
635
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-put
636
- */
637
- setUserColumns({ accountId, userColumnRequestBody, }) {
638
- return this.getClientInstance()
639
- .request({
640
- path: "/rest/api/3/user/columns",
641
- method: "PUT",
642
- query: {
643
- accountId,
644
- },
645
- headers: {
646
- "Content-Type": "multipart/form-data",
647
- },
648
- body: userColumnRequestBody,
649
- })
650
- .then(this.getClientInstance().responseHandler({
651
- 200: {
652
- "application/json": "json",
653
- },
654
- }))
655
- .then(commonHttpClient.castResponse())
656
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.setUserColumns.response"))
657
- .then(commonHttpClient.getBody);
24
+ constructor() {
25
+ super(...arguments);
26
+ /**
27
+ * Returns a [paginated](#pagination) list of the users specified by one or more
28
+ * account IDs.
29
+ *
30
+ * **[Permissions](#permissions) required:** Permission to access Jira.
31
+ *
32
+ * @returns Returned if the request is successful.
33
+ *
34
+ * example: {
35
+ * "isLast": true,
36
+ * "maxResults": 100,
37
+ * "startAt": 0,
38
+ * "total": 1,
39
+ * "values": [
40
+ * {
41
+ * "accountId": "5b10a2844c20165700ede21g",
42
+ * "accountType": "atlassian",
43
+ * "active": true,
44
+ * "avatarUrls": {
45
+ * "16x16":
46
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
47
+ * "24x24":
48
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
49
+ * "32x32":
50
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
51
+ * "48x48":
52
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
53
+ * },
54
+ * "displayName": "Mia Krystof",
55
+ * "emailAddress": "mia@example.com",
56
+ * "self":
57
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
58
+ * "timeZone": "Australia/Sydney"
59
+ * }
60
+ * ]
61
+ * }
62
+ * @path {GET} /rest/api/3/user/bulk
63
+ * @scopes-current read:jira-user
64
+ * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
65
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-get
66
+ */
67
+ this.bulkGetUsers = ({ startAt, maxResults, username, key, accountId, }) => {
68
+ return this.getClientInstance()
69
+ .request({
70
+ path: "/rest/api/3/user/bulk",
71
+ method: "GET",
72
+ query: {
73
+ startAt,
74
+ maxResults,
75
+ username,
76
+ key,
77
+ accountId,
78
+ },
79
+ })
80
+ .then(this.getClientInstance().responseHandler({
81
+ 200: {
82
+ "application/json": "json",
83
+ },
84
+ }))
85
+ .then(commonHttpClient.castResponse())
86
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.bulkGetUsers.response"))
87
+ .then(commonHttpClient.getBody);
88
+ };
89
+ /**
90
+ * Returns the account IDs for the users specified in the `key` or `username`
91
+ * parameters. Note that multiple `key` or `username` parameters can be specified.
92
+ *
93
+ * **[Permissions](#permissions) required:** Permission to access Jira.
94
+ *
95
+ * @returns Returned if the request is successful.
96
+ *
97
+ * example: [
98
+ * {
99
+ * "username": "mia",
100
+ * "accountId": "5b10a2844c20165700ede21g"
101
+ * },
102
+ * {
103
+ * "username": "emma",
104
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5"
105
+ * }
106
+ * ]
107
+ * @path {GET} /rest/api/3/user/bulk/migration
108
+ * @scopes-current read:jira-user
109
+ * @scopes-beta read:user:jira
110
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-migration-get
111
+ */
112
+ this.bulkGetUsersMigration = ({ startAt, maxResults, username, key, } = {}) => {
113
+ return this.getClientInstance()
114
+ .request({
115
+ path: "/rest/api/3/user/bulk/migration",
116
+ method: "GET",
117
+ query: {
118
+ startAt,
119
+ maxResults,
120
+ username,
121
+ key,
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("UsersService.bulkGetUsersMigration.response"))
131
+ .then(commonHttpClient.getBody);
132
+ };
133
+ /**
134
+ * Creates a user. This resource is retained for legacy compatibility. As soon as
135
+ * a more suitable alternative is available this resource will be deprecated.
136
+ *
137
+ * If the user exists and has access to Jira, the operation returns a 201 status.
138
+ * If the user exists but does not have access to Jira, the operation returns a
139
+ * 400 status.
140
+ *
141
+ * **[Permissions](#permissions) required:** *Administer Jira* [global
142
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
143
+ *
144
+ * @returns Returned if the request is successful.
145
+ *
146
+ * example: {
147
+ * "accountId": "5b10a2844c20165700ede21g",
148
+ * "accountType": "atlassian",
149
+ * "active": true,
150
+ * "applicationRoles": {
151
+ * "items": [],
152
+ * "size": 1
153
+ * },
154
+ * "avatarUrls": {
155
+ * "16x16":
156
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
157
+ * "24x24":
158
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
159
+ * "32x32":
160
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
161
+ * "48x48":
162
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
163
+ * },
164
+ * "displayName": "Mia Krystof",
165
+ * "emailAddress": "mia@example.com",
166
+ * "groups": {
167
+ * "items": [],
168
+ * "size": 3
169
+ * },
170
+ * "key": "",
171
+ * "name": "",
172
+ * "self":
173
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
174
+ * "timeZone": "Australia/Sydney"
175
+ * }
176
+ * @path {POST} /rest/api/3/user
177
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-post
178
+ */
179
+ this.createUser = ({ newUserDetails, }) => {
180
+ return this.getClientInstance()
181
+ .request({
182
+ path: "/rest/api/3/user",
183
+ method: "POST",
184
+ headers: {
185
+ "Content-Type": "application/json",
186
+ },
187
+ body: newUserDetails,
188
+ })
189
+ .then(this.getClientInstance().responseHandler({
190
+ 201: {
191
+ "application/json": "json",
192
+ },
193
+ }))
194
+ .then(commonHttpClient.castResponse())
195
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.createUser.response"))
196
+ .then(commonHttpClient.getBody);
197
+ };
198
+ /**
199
+ * Returns a list of all users, including active users, inactive users and
200
+ * previously deleted users that have an Atlassian account.
201
+ *
202
+ * Privacy controls are applied to the response based on the users' preferences.
203
+ * This could mean, for example, that the user's email address is hidden. See the
204
+ * [Profile visibility
205
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
206
+ * for more details.
207
+ *
208
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
209
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
210
+ *
211
+ * @returns Returned if the request is successful.
212
+ *
213
+ * example: [
214
+ * {
215
+ * "accountId": "5b10a2844c20165700ede21g",
216
+ * "accountType": "atlassian",
217
+ * "active": false,
218
+ * "avatarUrls": {
219
+ * "16x16":
220
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
221
+ * "24x24":
222
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
223
+ * "32x32":
224
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
225
+ * "48x48":
226
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
227
+ * },
228
+ * "displayName": "Mia Krystof",
229
+ * "key": "",
230
+ * "name": "",
231
+ * "self":
232
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
233
+ * },
234
+ * {
235
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
236
+ * "accountType": "atlassian",
237
+ * "active": false,
238
+ * "avatarUrls": {
239
+ * "16x16":
240
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
241
+ * "24x24":
242
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
243
+ * "32x32":
244
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
245
+ * "48x48":
246
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
247
+ * },
248
+ * "displayName": "Emma Richards",
249
+ * "key": "",
250
+ * "name": "",
251
+ * "self":
252
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
253
+ * }
254
+ * ]
255
+ * @path {GET} /rest/api/3/users/search
256
+ * @scopes-current read:jira-user
257
+ * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
258
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-search-get
259
+ */
260
+ this.getAllUsers = ({ startAt, maxResults, } = {}) => {
261
+ return this.getClientInstance()
262
+ .request({
263
+ path: "/rest/api/3/users/search",
264
+ method: "GET",
265
+ query: {
266
+ startAt,
267
+ maxResults,
268
+ },
269
+ })
270
+ .then(this.getClientInstance().responseHandler({
271
+ 200: {
272
+ "application/json": "json",
273
+ },
274
+ }))
275
+ .then(commonHttpClient.castResponse())
276
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getAllUsers.response"))
277
+ .then(commonHttpClient.getBody);
278
+ };
279
+ /**
280
+ * Returns a list of all users, including active users, inactive users and
281
+ * previously deleted users that have an Atlassian account.
282
+ *
283
+ * Privacy controls are applied to the response based on the users' preferences.
284
+ * This could mean, for example, that the user's email address is hidden. See the
285
+ * [Profile visibility
286
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
287
+ * for more details.
288
+ *
289
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
290
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
291
+ *
292
+ * @returns Returned if the request is successful.
293
+ *
294
+ * example: [
295
+ * {
296
+ * "accountId": "5b10a2844c20165700ede21g",
297
+ * "accountType": "atlassian",
298
+ * "active": false,
299
+ * "avatarUrls": {
300
+ * "16x16":
301
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
302
+ * "24x24":
303
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
304
+ * "32x32":
305
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
306
+ * "48x48":
307
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
308
+ * },
309
+ * "displayName": "Mia Krystof",
310
+ * "key": "",
311
+ * "name": "",
312
+ * "self":
313
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
314
+ * },
315
+ * {
316
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
317
+ * "accountType": "atlassian",
318
+ * "active": false,
319
+ * "avatarUrls": {
320
+ * "16x16":
321
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
322
+ * "24x24":
323
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
324
+ * "32x32":
325
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
326
+ * "48x48":
327
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
328
+ * },
329
+ * "displayName": "Emma Richards",
330
+ * "key": "",
331
+ * "name": "",
332
+ * "self":
333
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
334
+ * }
335
+ * ]
336
+ * @path {GET} /rest/api/3/users
337
+ * @scopes-current read:jira-user
338
+ * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
339
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-get
340
+ */
341
+ this.getAllUsersDefault = ({ startAt, maxResults, } = {}) => {
342
+ return this.getClientInstance()
343
+ .request({
344
+ path: "/rest/api/3/users",
345
+ method: "GET",
346
+ query: {
347
+ startAt,
348
+ maxResults,
349
+ },
350
+ })
351
+ .then(this.getClientInstance().responseHandler({
352
+ 200: {
353
+ "application/json": "json",
354
+ },
355
+ }))
356
+ .then(commonHttpClient.castResponse())
357
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getAllUsersDefault.response"))
358
+ .then(commonHttpClient.getBody);
359
+ };
360
+ /**
361
+ * Returns a user.
362
+ *
363
+ * Privacy controls are applied to the response based on the user's preferences.
364
+ * This could mean, for example, that the user's email address is hidden. See the
365
+ * [Profile visibility
366
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
367
+ * for more details.
368
+ *
369
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
370
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
371
+ *
372
+ * @returns Returned if the request is successful.
373
+ *
374
+ * example: {
375
+ * "accountId": "5b10a2844c20165700ede21g",
376
+ * "accountType": "atlassian",
377
+ * "active": true,
378
+ * "applicationRoles": {
379
+ * "items": [],
380
+ * "size": 1
381
+ * },
382
+ * "avatarUrls": {
383
+ * "16x16":
384
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
385
+ * "24x24":
386
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
387
+ * "32x32":
388
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
389
+ * "48x48":
390
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
391
+ * },
392
+ * "displayName": "Mia Krystof",
393
+ * "emailAddress": "mia@example.com",
394
+ * "groups": {
395
+ * "items": [],
396
+ * "size": 3
397
+ * },
398
+ * "key": "",
399
+ * "name": "",
400
+ * "self":
401
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
402
+ * "timeZone": "Australia/Sydney"
403
+ * }
404
+ * @path {GET} /rest/api/3/user
405
+ * @scopes-current read:jira-user
406
+ * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
407
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-get
408
+ */
409
+ this.getUser = ({ accountId, username, key, expand, } = {}) => {
410
+ return this.getClientInstance()
411
+ .request({
412
+ path: "/rest/api/3/user",
413
+ method: "GET",
414
+ query: {
415
+ accountId,
416
+ username,
417
+ key,
418
+ expand,
419
+ },
420
+ })
421
+ .then(this.getClientInstance().responseHandler({
422
+ 200: {
423
+ "application/json": "json",
424
+ },
425
+ }))
426
+ .then(commonHttpClient.castResponse())
427
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUser.response"))
428
+ .then(commonHttpClient.getBody);
429
+ };
430
+ /**
431
+ * Returns the default [issue table
432
+ * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If
433
+ * `accountId` is not passed in the request, the calling user's details are
434
+ * returned.
435
+ *
436
+ * **[Permissions](#permissions) required:**
437
+ *
438
+ * * *Administer Jira* [global
439
+ * permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column
440
+ * details for any user.
441
+ * * Permission to access Jira, to get the calling user's column details.
442
+ *
443
+ * @returns Returned if the request is successful.
444
+ * @path {GET} /rest/api/3/user/columns
445
+ * @scopes-current read:jira-user
446
+ * @scopes-beta read:user.columns:jira, read:filter.column:jira
447
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-get
448
+ */
449
+ this.getUserDefaultColumns = ({ accountId, username, } = {}) => {
450
+ return this.getClientInstance()
451
+ .request({
452
+ path: "/rest/api/3/user/columns",
453
+ method: "GET",
454
+ query: {
455
+ accountId,
456
+ username,
457
+ },
458
+ })
459
+ .then(this.getClientInstance().responseHandler({
460
+ 200: {
461
+ "application/json": "json",
462
+ },
463
+ }))
464
+ .then(commonHttpClient.castResponse())
465
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserDefaultColumns.response"))
466
+ .then(commonHttpClient.getBody);
467
+ };
468
+ /**
469
+ * Returns a user's email address. This API is only available to apps approved by
470
+ * Atlassian, according to these
471
+ * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
472
+ *
473
+ * @returns Returned if the request is successful.
474
+ *
475
+ * example: name@example.com
476
+ * @path {GET} /rest/api/3/user/email
477
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-get
478
+ */
479
+ this.getUserEmail = ({ accountId, }) => {
480
+ return this.getClientInstance()
481
+ .request({
482
+ path: "/rest/api/3/user/email",
483
+ method: "GET",
484
+ query: {
485
+ accountId,
486
+ },
487
+ })
488
+ .then(this.getClientInstance().responseHandler({
489
+ 200: {
490
+ "application/json": "json",
491
+ },
492
+ }))
493
+ .then(commonHttpClient.castResponse())
494
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserEmail.response"))
495
+ .then(commonHttpClient.getBody);
496
+ };
497
+ /**
498
+ * Returns a user's email address. This API is only available to apps approved by
499
+ * Atlassian, according to these
500
+ * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
501
+ *
502
+ * @returns Returned if the request is successful.
503
+ * @path {GET} /rest/api/3/user/email/bulk
504
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-bulk-get
505
+ */
506
+ this.getUserEmailBulk = ({ accountId, }) => {
507
+ return this.getClientInstance()
508
+ .request({
509
+ path: "/rest/api/3/user/email/bulk",
510
+ method: "GET",
511
+ query: {
512
+ accountId,
513
+ },
514
+ })
515
+ .then(this.getClientInstance().responseHandler({
516
+ 200: {
517
+ "application/json": "json",
518
+ },
519
+ }))
520
+ .then(commonHttpClient.castResponse())
521
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserEmailBulk.response"))
522
+ .then(commonHttpClient.getBody);
523
+ };
524
+ /**
525
+ * Returns the groups to which a user belongs.
526
+ *
527
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
528
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
529
+ *
530
+ * @returns Returned if the request is successful.
531
+ *
532
+ * example: {
533
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
534
+ * "name": "jira-administrators",
535
+ * "self":
536
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
537
+ * }
538
+ * @path {GET} /rest/api/3/user/groups
539
+ * @scopes-current read:jira-user
540
+ * @scopes-beta read:group:jira
541
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-groups-get
542
+ */
543
+ this.getUserGroups = ({ accountId, username, key, }) => {
544
+ return this.getClientInstance()
545
+ .request({
546
+ path: "/rest/api/3/user/groups",
547
+ method: "GET",
548
+ query: {
549
+ accountId,
550
+ username,
551
+ key,
552
+ },
553
+ })
554
+ .then(this.getClientInstance().responseHandler({
555
+ 200: {
556
+ "application/json": "json",
557
+ },
558
+ }))
559
+ .then(commonHttpClient.castResponse())
560
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.getUserGroups.response"))
561
+ .then(commonHttpClient.getBody);
562
+ };
563
+ /**
564
+ * Deletes a user. If the operation completes successfully then the user is
565
+ * removed from Jira's user base. This operation does not delete the user's
566
+ * Atlassian account.
567
+ *
568
+ * **[Permissions](#permissions) required:** Site administration (that is,
569
+ * membership of the *site-admin*
570
+ * [group](https://confluence.atlassian.com/x/24xjL)).
571
+ *
572
+ * @path {DELETE} /rest/api/3/user
573
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-delete
574
+ */
575
+ this.removeUser = ({ accountId, username, key, }) => {
576
+ return this.getClientInstance()
577
+ .request({
578
+ path: "/rest/api/3/user",
579
+ method: "DELETE",
580
+ query: {
581
+ accountId,
582
+ username,
583
+ key,
584
+ },
585
+ })
586
+ .then(commonHttpClient.discardResult);
587
+ };
588
+ /**
589
+ * Resets the default [ issue table
590
+ * columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system
591
+ * default. If `accountId` is not passed, the calling user's default columns are
592
+ * reset.
593
+ *
594
+ * **[Permissions](#permissions) required:**
595
+ *
596
+ * * *Administer Jira* [global
597
+ * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
598
+ * any user.
599
+ * * Permission to access Jira, to set the calling user's columns.
600
+ *
601
+ * @path {DELETE} /rest/api/3/user/columns
602
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-delete
603
+ */
604
+ this.resetUserColumns = ({ accountId, username, } = {}) => {
605
+ return this.getClientInstance()
606
+ .request({
607
+ path: "/rest/api/3/user/columns",
608
+ method: "DELETE",
609
+ query: {
610
+ accountId,
611
+ username,
612
+ },
613
+ })
614
+ .then(commonHttpClient.discardResult);
615
+ };
616
+ /**
617
+ * Sets the default [ issue table
618
+ * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account
619
+ * ID is not passed, the calling user's default columns are set. If no column
620
+ * details are sent, then all default columns are removed.
621
+ *
622
+ * The parameters for this resource are expressed as HTML form data. For example,
623
+ * in curl:
624
+ *
625
+ * `curl -X PUT -d columns=summary -d columns=description
626
+ * https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`
627
+ *
628
+ * **[Permissions](#permissions) required:**
629
+ *
630
+ * * *Administer Jira* [global
631
+ * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
632
+ * any user.
633
+ * * Permission to access Jira, to set the calling user's columns.
634
+ *
635
+ * @returns Returned if the request is successful.
636
+ * @path {PUT} /rest/api/3/user/columns
637
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-put
638
+ */
639
+ this.setUserColumns = ({ accountId, userColumnRequestBody, }) => {
640
+ return this.getClientInstance()
641
+ .request({
642
+ path: "/rest/api/3/user/columns",
643
+ method: "PUT",
644
+ query: {
645
+ accountId,
646
+ },
647
+ headers: {
648
+ "Content-Type": "multipart/form-data",
649
+ },
650
+ body: userColumnRequestBody,
651
+ })
652
+ .then(this.getClientInstance().responseHandler({
653
+ 200: {
654
+ "application/json": "json",
655
+ },
656
+ }))
657
+ .then(commonHttpClient.castResponse())
658
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UsersService.setUserColumns.response"))
659
+ .then(commonHttpClient.getBody);
660
+ };
658
661
  }
659
662
  static initialize() {
660
663
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UsersService.getUser.response", zod_1.z