@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
@@ -20,712 +20,715 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
20
20
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search
21
21
  */
22
22
  class UserSearchService extends CommonHttpService_1.CommonHttpService {
23
- /**
24
- * Returns a list of users that can be assigned to an issue. Use this operation to
25
- * find the list of users who can be assigned to:
26
- *
27
- * * a new issue, by providing the `projectKeyOrId`.
28
- * * an updated issue, by providing the `issueKey`.
29
- * * to an issue during a transition (workflow action), by providing the
30
- * `issueKey` and the transition id in `actionDescriptorId`. You can obtain the
31
- * IDs of an issue's valid transitions using the `transitions` option in the
32
- * `expand` parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).
33
- *
34
- * In all these cases, you can pass an account ID to determine if a user can be
35
- * assigned to an issue. The user is returned in the response if they can be
36
- * assigned to the issue or issue transition.
37
- *
38
- * This operation takes the users in the range defined by `startAt` and
39
- * `maxResults`, up to the thousandth user, and then returns only the users from
40
- * that range that can be assigned the issue. This means the operation usually
41
- * returns fewer users than specified in `maxResults`. To get all the users who
42
- * can be assigned the issue, use [Get all
43
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
44
- *
45
- * Privacy controls are applied to the response based on the users' preferences.
46
- * This could mean, for example, that the user's email address is hidden. See the
47
- * [Profile visibility
48
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
49
- * for more details.
50
- *
51
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
52
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Assign issues*
53
- * [project permission](https://confluence.atlassian.com/x/yodKLg)
54
- *
55
- * @returns Returned if the request is successful.
56
- *
57
- * example: {
58
- * "accountId": "5b10a2844c20165700ede21g",
59
- * "accountType": "atlassian",
60
- * "active": true,
61
- * "applicationRoles": {
62
- * "items": [],
63
- * "size": 1
64
- * },
65
- * "avatarUrls": {
66
- * "16x16":
67
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
68
- * "24x24":
69
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
70
- * "32x32":
71
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
72
- * "48x48":
73
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
74
- * },
75
- * "displayName": "Mia Krystof",
76
- * "emailAddress": "mia@example.com",
77
- * "groups": {
78
- * "items": [],
79
- * "size": 3
80
- * },
81
- * "key": "",
82
- * "name": "",
83
- * "self":
84
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
85
- * "timeZone": "Australia/Sydney"
86
- * }
87
- * @path {GET} /rest/api/3/user/assignable/search
88
- * @scopes-current read:jira-user
89
- * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
90
- * read:avatar:jira, read:group:jira
91
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-search-get
92
- */
93
- findAssignableUsers({ query, sessionId, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, recommend, } = {}) {
94
- return this.getClientInstance()
95
- .request({
96
- path: "/rest/api/3/user/assignable/search",
97
- method: "GET",
98
- query: {
99
- query,
100
- sessionId,
101
- username,
102
- accountId,
103
- project,
104
- issueKey,
105
- startAt,
106
- maxResults,
107
- actionDescriptorId,
108
- recommend,
109
- },
110
- })
111
- .then(this.getClientInstance().responseHandler({
112
- 200: {
113
- "application/json": "json",
114
- },
115
- }))
116
- .then(commonHttpClient.castResponse())
117
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findAssignableUsers.response"))
118
- .then(commonHttpClient.getBody);
119
- }
120
- /**
121
- * Returns a list of users who can be assigned issues in one or more projects. The
122
- * list may be restricted to users whose attributes match a string.
123
- *
124
- * This operation takes the users in the range defined by `startAt` and
125
- * `maxResults`, up to the thousandth user, and then returns only the users from
126
- * that range that can be assigned issues in the projects. This means the
127
- * operation usually returns fewer users than specified in `maxResults`. To get
128
- * all the users who can be assigned issues in the projects, use [Get all
129
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
130
- *
131
- * Privacy controls are applied to the response based on the users' preferences.
132
- * This could mean, for example, that the user's email address is hidden. See the
133
- * [Profile visibility
134
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
135
- * for more details.
136
- *
137
- * This operation can be accessed anonymously.
138
- *
139
- * **[Permissions](#permissions) required:** None.
140
- *
141
- * @returns Returned if the request is successful.
142
- *
143
- * example: [
144
- * {
145
- * "accountId": "5b10a2844c20165700ede21g",
146
- * "accountType": "atlassian",
147
- * "active": false,
148
- * "avatarUrls": {
149
- * "16x16":
150
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
151
- * "24x24":
152
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
153
- * "32x32":
154
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
155
- * "48x48":
156
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
157
- * },
158
- * "displayName": "Mia Krystof",
159
- * "key": "",
160
- * "name": "",
161
- * "self":
162
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
163
- * },
164
- * {
165
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
166
- * "accountType": "atlassian",
167
- * "active": false,
168
- * "avatarUrls": {
169
- * "16x16":
170
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
171
- * "24x24":
172
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
173
- * "32x32":
174
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
175
- * "48x48":
176
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
177
- * },
178
- * "displayName": "Emma Richards",
179
- * "key": "",
180
- * "name": "",
181
- * "self":
182
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
183
- * }
184
- * ]
185
- * @path {GET} /rest/api/3/user/assignable/multiProjectSearch
186
- * @scopes-current read:jira-user
187
- * @scopes-beta read:project:jira, read:user:jira, read:application-role:jira,
188
- * read:avatar:jira, read:group:jira
189
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-multiprojectsearch-get
190
- */
191
- findBulkAssignableUsers({ query, username, accountId, projectKeys, startAt, maxResults, }) {
192
- return this.getClientInstance()
193
- .request({
194
- path: "/rest/api/3/user/assignable/multiProjectSearch",
195
- method: "GET",
196
- query: {
197
- query,
198
- username,
199
- accountId,
200
- projectKeys,
201
- startAt,
202
- maxResults,
203
- },
204
- })
205
- .then(this.getClientInstance().responseHandler({
206
- 200: {
207
- "application/json": "json",
208
- },
209
- }))
210
- .then(commonHttpClient.castResponse())
211
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findBulkAssignableUsers.response"))
212
- .then(commonHttpClient.getBody);
213
- }
214
- /**
215
- * Finds users with a structured query and returns a [paginated](#pagination) list
216
- * of user keys.
217
- *
218
- * This operation takes the users in the range defined by `startAt` and
219
- * `maxResults`, up to the thousandth user, and then returns only the users from
220
- * that range that match the structured query. This means the operation usually
221
- * returns fewer users than specified in `maxResults`. To get all the users who
222
- * match the structured query, use [Get all
223
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
224
- *
225
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
226
- * permission](https://confluence.atlassian.com/x/x4dKLg).
227
- *
228
- * The query statements are:
229
- *
230
- * * `is assignee of PROJ` Returns the users that are assignees of at least one
231
- * issue in project *PROJ*.
232
- * * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the
233
- * issues *PROJ-1* or *PROJ-2*.
234
- * * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the
235
- * issues *PROJ-1* or *PROJ-2*.
236
- * * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the
237
- * issues *PROJ-1* or *PROJ-2*.
238
- * * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues
239
- * *PROJ-1* or *PROJ-2*.
240
- * * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment
241
- * on the issues *PROJ-1* or *PROJ-2*.
242
- * * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a
243
- * transition on issues *PROJ-1* or *PROJ-2*.
244
- * * `[propertyKey].entity.property.path is "property value"` Returns users with
245
- * the entity property value.
246
- *
247
- * The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ...
248
- * PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form
249
- * more complex queries. For example:
250
- *
251
- * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
252
- *
253
- * @returns Returned if the request is successful.
254
- * @path {GET} /rest/api/3/user/search/query/key
255
- * @scopes-current read:jira-user
256
- * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
257
- * read:issue.watcher:jira, read:project:jira, read:user.property:jira,
258
- * read:user:jira
259
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-key-get
260
- */
261
- findUserKeysByQuery({ query, startAt, maxResult, }) {
262
- return this.getClientInstance()
263
- .request({
264
- path: "/rest/api/3/user/search/query/key",
265
- method: "GET",
266
- query: {
267
- query,
268
- startAt,
269
- maxResult,
270
- },
271
- })
272
- .then(this.getClientInstance().responseHandler({
273
- 200: {
274
- "application/json": "json",
275
- },
276
- }))
277
- .then(commonHttpClient.castResponse())
278
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUserKeysByQuery.response"))
279
- .then(commonHttpClient.getBody);
280
- }
281
- /**
282
- * Returns a list of active users that match the search string and property.
283
- *
284
- * This operation first applies a filter to match the search string and property,
285
- * and then takes the filtered users in the range defined by `startAt` and
286
- * `maxResults`, up to the thousandth user. To get all the users who match the
287
- * search string and property, use [Get all
288
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
289
- *
290
- * This operation can be accessed anonymously.
291
- *
292
- * Privacy controls are applied to the response based on the users' preferences.
293
- * This could mean, for example, that the user's email address is hidden. See the
294
- * [Profile visibility
295
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
296
- * for more details.
297
- *
298
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
299
- * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or
300
- * calls by users without the required permission return empty search results.
301
- *
302
- * @returns Returned if the request is successful.
303
- *
304
- * example: [
305
- * {
306
- * "accountId": "5b10a2844c20165700ede21g",
307
- * "accountType": "atlassian",
308
- * "active": false,
309
- * "avatarUrls": {
310
- * "16x16":
311
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
312
- * "24x24":
313
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
314
- * "32x32":
315
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
316
- * "48x48":
317
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
318
- * },
319
- * "displayName": "Mia Krystof",
320
- * "key": "",
321
- * "name": "",
322
- * "self":
323
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
324
- * },
325
- * {
326
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
327
- * "accountType": "atlassian",
328
- * "active": false,
329
- * "avatarUrls": {
330
- * "16x16":
331
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
332
- * "24x24":
333
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
334
- * "32x32":
335
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
336
- * "48x48":
337
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
338
- * },
339
- * "displayName": "Emma Richards",
340
- * "key": "",
341
- * "name": "",
342
- * "self":
343
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
344
- * }
345
- * ]
346
- * @path {GET} /rest/api/3/user/search
347
- * @scopes-current read:jira-user
348
- * @scopes-beta read:user:jira, read:user.property:jira, read:application-role:jira,
349
- * read:avatar:jira, read:group:jira
350
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-get
351
- */
352
- findUsers({ query, username, accountId, startAt, maxResults, property, } = {}) {
353
- return this.getClientInstance()
354
- .request({
355
- path: "/rest/api/3/user/search",
356
- method: "GET",
357
- query: {
358
- query,
359
- username,
360
- accountId,
361
- startAt,
362
- maxResults,
363
- property,
364
- },
365
- })
366
- .then(this.getClientInstance().responseHandler({
367
- 200: {
368
- "application/json": "json",
369
- },
370
- }))
371
- .then(commonHttpClient.castResponse())
372
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsers.response"))
373
- .then(commonHttpClient.getBody);
374
- }
375
- /**
376
- * Finds users with a structured query and returns a [paginated](#pagination) list
377
- * of user details.
378
- *
379
- * This operation takes the users in the range defined by `startAt` and
380
- * `maxResults`, up to the thousandth user, and then returns only the users from
381
- * that range that match the structured query. This means the operation usually
382
- * returns fewer users than specified in `maxResults`. To get all the users who
383
- * match the structured query, use [Get all
384
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
385
- *
386
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
387
- * permission](https://confluence.atlassian.com/x/x4dKLg).
388
- *
389
- * The query statements are:
390
- *
391
- * * `is assignee of PROJ` Returns the users that are assignees of at least one
392
- * issue in project *PROJ*.
393
- * * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the
394
- * issues *PROJ-1* or *PROJ-2*.
395
- * * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the
396
- * issues *PROJ-1* or *PROJ-2*.
397
- * * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the
398
- * issues *PROJ-1* or *PROJ-2*.
399
- * * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues
400
- * *PROJ-1* or *PROJ-2*.
401
- * * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment
402
- * on the issues *PROJ-1* or *PROJ-2*.
403
- * * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a
404
- * transition on issues *PROJ-1* or *PROJ-2*.
405
- * * `[propertyKey].entity.property.path is "property value"` Returns users with
406
- * the entity property value.
407
- *
408
- * The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ...
409
- * PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form
410
- * more complex queries. For example:
411
- *
412
- * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
413
- *
414
- * @returns Returned if the request is successful.
415
- * @path {GET} /rest/api/3/user/search/query
416
- * @scopes-current read:jira-user
417
- * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
418
- * read:issue.watcher:jira, read:project:jira, read:user:jira,
419
- * read:user.property:jira, read:application-role:jira, read:avatar:jira,
420
- * read:group:jira
421
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-get
422
- */
423
- findUsersByQuery({ query, startAt, maxResults, }) {
424
- return this.getClientInstance()
425
- .request({
426
- path: "/rest/api/3/user/search/query",
427
- method: "GET",
428
- query: {
429
- query,
430
- startAt,
431
- maxResults,
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("UserSearchService.findUsersByQuery.response"))
441
- .then(commonHttpClient.getBody);
442
- }
443
- /**
444
- * Returns a list of users whose attributes match the query term. The returned
445
- * object includes the `html` field where the matched query term is highlighted
446
- * with the HTML strong tag. A list of account IDs can be provided to exclude
447
- * users from the results.
448
- *
449
- * This operation takes the users in the range defined by `maxResults`, up to the
450
- * thousandth user, and then returns only the users from that range that match the
451
- * query term. This means the operation usually returns fewer users than specified
452
- * in `maxResults`. To get all the users who match the query term, use [Get all
453
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
454
- *
455
- * Privacy controls are applied to the response based on the users' preferences.
456
- * This could mean, for example, that the user's email address is hidden. See the
457
- * [Profile visibility
458
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
459
- * for more details.
460
- *
461
- * This operation can be accessed anonymously.
462
- *
463
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
464
- * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and
465
- * calls by users without the required permission return search results for an
466
- * exact name match only.
467
- *
468
- * @returns Returned if the request is successful.
469
- *
470
- * example: {
471
- * "header": "Showing 20 of 25 matching groups",
472
- * "total": 25,
473
- * "users": [
474
- * {
475
- * "accountId": "5b10a2844c20165700ede21g",
476
- * "accountType": "atlassian",
477
- * "avatarUrl":
478
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
479
- * "displayName": "Mia Krystof",
480
- * "html": "<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com
481
- * (<strong>mi</strong>a)",
482
- * "key": "mia",
483
- * "name": "mia"
484
- * }
485
- * ]
486
- * }
487
- * @path {GET} /rest/api/3/user/picker
488
- * @scopes-current read:jira-user
489
- * @scopes-beta read:user:jira
490
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-picker-get
491
- */
492
- findUsersForPicker({ query, maxResults, showAvatar, exclude, excludeAccountIds, avatarSize, excludeConnectUsers, }) {
493
- return this.getClientInstance()
494
- .request({
495
- path: "/rest/api/3/user/picker",
496
- method: "GET",
497
- query: {
498
- query,
499
- maxResults,
500
- showAvatar,
501
- exclude,
502
- excludeAccountIds,
503
- avatarSize,
504
- excludeConnectUsers,
505
- },
506
- })
507
- .then(this.getClientInstance().responseHandler({
508
- 200: {
509
- "application/json": "json",
510
- },
511
- }))
512
- .then(commonHttpClient.castResponse())
513
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersForPicker.response"))
514
- .then(commonHttpClient.getBody);
515
- }
516
- /**
517
- * Returns a list of users who fulfill these criteria:
518
- *
519
- * * their user attributes match a search string.
520
- * * they have a set of permissions for a project or issue.
521
- *
522
- * If no search string is provided, a list of all users with the permissions is
523
- * returned.
524
- *
525
- * This operation takes the users in the range defined by `startAt` and
526
- * `maxResults`, up to the thousandth user, and then returns only the users from
527
- * that range that match the search string and have permission for the project or
528
- * issue. This means the operation usually returns fewer users than specified in
529
- * `maxResults`. To get all the users who match the search string and have
530
- * permission for the project or issue, use [Get all
531
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
532
- *
533
- * Privacy controls are applied to the response based on the users' preferences.
534
- * This could mean, for example, that the user's email address is hidden. See the
535
- * [Profile visibility
536
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
537
- * for more details.
538
- *
539
- * This operation can be accessed anonymously.
540
- *
541
- * **[Permissions](#permissions) required:**
542
- *
543
- * * *Administer Jira* [global
544
- * permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any
545
- * project.
546
- * * *Administer Projects* [project
547
- * permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get
548
- * users for that project.
549
- *
550
- * @returns Returned if the request is successful.
551
- *
552
- * example: [
553
- * {
554
- * "accountId": "5b10a2844c20165700ede21g",
555
- * "accountType": "atlassian",
556
- * "active": false,
557
- * "avatarUrls": {
558
- * "16x16":
559
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
560
- * "24x24":
561
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
562
- * "32x32":
563
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
564
- * "48x48":
565
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
566
- * },
567
- * "displayName": "Mia Krystof",
568
- * "key": "",
569
- * "name": "",
570
- * "self":
571
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
572
- * },
573
- * {
574
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
575
- * "accountType": "atlassian",
576
- * "active": false,
577
- * "avatarUrls": {
578
- * "16x16":
579
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
580
- * "24x24":
581
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
582
- * "32x32":
583
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
584
- * "48x48":
585
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
586
- * },
587
- * "displayName": "Emma Richards",
588
- * "key": "",
589
- * "name": "",
590
- * "self":
591
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
592
- * }
593
- * ]
594
- * @path {GET} /rest/api/3/user/permission/search
595
- * @scopes-current read:jira-user
596
- * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
597
- * read:avatar:jira, read:group:jira
598
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-permission-search-get
599
- */
600
- findUsersWithAllPermissions({ query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, }) {
601
- return this.getClientInstance()
602
- .request({
603
- path: "/rest/api/3/user/permission/search",
604
- method: "GET",
605
- query: {
606
- query,
607
- username,
608
- accountId,
609
- permissions,
610
- issueKey,
611
- projectKey,
612
- startAt,
613
- maxResults,
614
- },
615
- })
616
- .then(this.getClientInstance().responseHandler({
617
- 200: {
618
- "application/json": "json",
619
- },
620
- }))
621
- .then(commonHttpClient.castResponse())
622
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersWithAllPermissions.response"))
623
- .then(commonHttpClient.getBody);
624
- }
625
- /**
626
- * Returns a list of users who fulfill these criteria:
627
- *
628
- * * their user attributes match a search string.
629
- * * they have permission to browse issues.
630
- *
631
- * Use this resource to find users who can browse:
632
- *
633
- * * an issue, by providing the `issueKey`.
634
- * * any issue in a project, by providing the `projectKey`.
635
- *
636
- * This operation takes the users in the range defined by `startAt` and
637
- * `maxResults`, up to the thousandth user, and then returns only the users from
638
- * that range that match the search string and have permission to browse issues.
639
- * This means the operation usually returns fewer users than specified in
640
- * `maxResults`. To get all the users who match the search string and have
641
- * permission to browse issues, use [Get all
642
- * users](#api-rest-api-3-users-search-get) and filter the records in your code.
643
- *
644
- * Privacy controls are applied to the response based on the users' preferences.
645
- * This could mean, for example, that the user's email address is hidden. See the
646
- * [Profile visibility
647
- * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
648
- * for more details.
649
- *
650
- * This operation can be accessed anonymously.
651
- *
652
- * **[Permissions](#permissions) required:** *Browse users and groups* [global
653
- * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and
654
- * calls by users without the required permission return empty search results.
655
- *
656
- * @returns Returned if the request is successful.
657
- *
658
- * example: [
659
- * {
660
- * "accountId": "5b10a2844c20165700ede21g",
661
- * "accountType": "atlassian",
662
- * "active": false,
663
- * "avatarUrls": {
664
- * "16x16":
665
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
666
- * "24x24":
667
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
668
- * "32x32":
669
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
670
- * "48x48":
671
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
672
- * },
673
- * "displayName": "Mia Krystof",
674
- * "key": "",
675
- * "name": "",
676
- * "self":
677
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
678
- * },
679
- * {
680
- * "accountId": "5b10ac8d82e05b22cc7d4ef5",
681
- * "accountType": "atlassian",
682
- * "active": false,
683
- * "avatarUrls": {
684
- * "16x16":
685
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
686
- * "24x24":
687
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
688
- * "32x32":
689
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
690
- * "48x48":
691
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
692
- * },
693
- * "displayName": "Emma Richards",
694
- * "key": "",
695
- * "name": "",
696
- * "self":
697
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
698
- * }
699
- * ]
700
- * @path {GET} /rest/api/3/user/viewissue/search
701
- * @scopes-current read:jira-user
702
- * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
703
- * read:avatar:jira, read:group:jira
704
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-viewissue-search-get
705
- */
706
- findUsersWithBrowsePermission({ query, username, accountId, issueKey, projectKey, startAt, maxResults, } = {}) {
707
- return this.getClientInstance()
708
- .request({
709
- path: "/rest/api/3/user/viewissue/search",
710
- method: "GET",
711
- query: {
712
- query,
713
- username,
714
- accountId,
715
- issueKey,
716
- projectKey,
717
- startAt,
718
- maxResults,
719
- },
720
- })
721
- .then(this.getClientInstance().responseHandler({
722
- 200: {
723
- "application/json": "json",
724
- },
725
- }))
726
- .then(commonHttpClient.castResponse())
727
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersWithBrowsePermission.response"))
728
- .then(commonHttpClient.getBody);
23
+ constructor() {
24
+ super(...arguments);
25
+ /**
26
+ * Returns a list of users that can be assigned to an issue. Use this operation to
27
+ * find the list of users who can be assigned to:
28
+ *
29
+ * * a new issue, by providing the `projectKeyOrId`.
30
+ * * an updated issue, by providing the `issueKey`.
31
+ * * to an issue during a transition (workflow action), by providing the
32
+ * `issueKey` and the transition id in `actionDescriptorId`. You can obtain the
33
+ * IDs of an issue's valid transitions using the `transitions` option in the
34
+ * `expand` parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).
35
+ *
36
+ * In all these cases, you can pass an account ID to determine if a user can be
37
+ * assigned to an issue. The user is returned in the response if they can be
38
+ * assigned to the issue or issue transition.
39
+ *
40
+ * This operation takes the users in the range defined by `startAt` and
41
+ * `maxResults`, up to the thousandth user, and then returns only the users from
42
+ * that range that can be assigned the issue. This means the operation usually
43
+ * returns fewer users than specified in `maxResults`. To get all the users who
44
+ * can be assigned the issue, use [Get all
45
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
46
+ *
47
+ * Privacy controls are applied to the response based on the users' preferences.
48
+ * This could mean, for example, that the user's email address is hidden. See the
49
+ * [Profile visibility
50
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
51
+ * for more details.
52
+ *
53
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
54
+ * permission](https://confluence.atlassian.com/x/x4dKLg) or *Assign issues*
55
+ * [project permission](https://confluence.atlassian.com/x/yodKLg)
56
+ *
57
+ * @returns Returned if the request is successful.
58
+ *
59
+ * example: {
60
+ * "accountId": "5b10a2844c20165700ede21g",
61
+ * "accountType": "atlassian",
62
+ * "active": true,
63
+ * "applicationRoles": {
64
+ * "items": [],
65
+ * "size": 1
66
+ * },
67
+ * "avatarUrls": {
68
+ * "16x16":
69
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
70
+ * "24x24":
71
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
72
+ * "32x32":
73
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
74
+ * "48x48":
75
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
76
+ * },
77
+ * "displayName": "Mia Krystof",
78
+ * "emailAddress": "mia@example.com",
79
+ * "groups": {
80
+ * "items": [],
81
+ * "size": 3
82
+ * },
83
+ * "key": "",
84
+ * "name": "",
85
+ * "self":
86
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
87
+ * "timeZone": "Australia/Sydney"
88
+ * }
89
+ * @path {GET} /rest/api/3/user/assignable/search
90
+ * @scopes-current read:jira-user
91
+ * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
92
+ * read:avatar:jira, read:group:jira
93
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-search-get
94
+ */
95
+ this.findAssignableUsers = ({ query, sessionId, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, recommend, } = {}) => {
96
+ return this.getClientInstance()
97
+ .request({
98
+ path: "/rest/api/3/user/assignable/search",
99
+ method: "GET",
100
+ query: {
101
+ query,
102
+ sessionId,
103
+ username,
104
+ accountId,
105
+ project,
106
+ issueKey,
107
+ startAt,
108
+ maxResults,
109
+ actionDescriptorId,
110
+ recommend,
111
+ },
112
+ })
113
+ .then(this.getClientInstance().responseHandler({
114
+ 200: {
115
+ "application/json": "json",
116
+ },
117
+ }))
118
+ .then(commonHttpClient.castResponse())
119
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findAssignableUsers.response"))
120
+ .then(commonHttpClient.getBody);
121
+ };
122
+ /**
123
+ * Returns a list of users who can be assigned issues in one or more projects. The
124
+ * list may be restricted to users whose attributes match a string.
125
+ *
126
+ * This operation takes the users in the range defined by `startAt` and
127
+ * `maxResults`, up to the thousandth user, and then returns only the users from
128
+ * that range that can be assigned issues in the projects. This means the
129
+ * operation usually returns fewer users than specified in `maxResults`. To get
130
+ * all the users who can be assigned issues in the projects, use [Get all
131
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
132
+ *
133
+ * Privacy controls are applied to the response based on the users' preferences.
134
+ * This could mean, for example, that the user's email address is hidden. See the
135
+ * [Profile visibility
136
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
137
+ * for more details.
138
+ *
139
+ * This operation can be accessed anonymously.
140
+ *
141
+ * **[Permissions](#permissions) required:** None.
142
+ *
143
+ * @returns Returned if the request is successful.
144
+ *
145
+ * example: [
146
+ * {
147
+ * "accountId": "5b10a2844c20165700ede21g",
148
+ * "accountType": "atlassian",
149
+ * "active": false,
150
+ * "avatarUrls": {
151
+ * "16x16":
152
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
153
+ * "24x24":
154
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
155
+ * "32x32":
156
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
157
+ * "48x48":
158
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
159
+ * },
160
+ * "displayName": "Mia Krystof",
161
+ * "key": "",
162
+ * "name": "",
163
+ * "self":
164
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
165
+ * },
166
+ * {
167
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
168
+ * "accountType": "atlassian",
169
+ * "active": false,
170
+ * "avatarUrls": {
171
+ * "16x16":
172
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
173
+ * "24x24":
174
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
175
+ * "32x32":
176
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
177
+ * "48x48":
178
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
179
+ * },
180
+ * "displayName": "Emma Richards",
181
+ * "key": "",
182
+ * "name": "",
183
+ * "self":
184
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
185
+ * }
186
+ * ]
187
+ * @path {GET} /rest/api/3/user/assignable/multiProjectSearch
188
+ * @scopes-current read:jira-user
189
+ * @scopes-beta read:project:jira, read:user:jira, read:application-role:jira,
190
+ * read:avatar:jira, read:group:jira
191
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-assignable-multiprojectsearch-get
192
+ */
193
+ this.findBulkAssignableUsers = ({ query, username, accountId, projectKeys, startAt, maxResults, }) => {
194
+ return this.getClientInstance()
195
+ .request({
196
+ path: "/rest/api/3/user/assignable/multiProjectSearch",
197
+ method: "GET",
198
+ query: {
199
+ query,
200
+ username,
201
+ accountId,
202
+ projectKeys,
203
+ startAt,
204
+ maxResults,
205
+ },
206
+ })
207
+ .then(this.getClientInstance().responseHandler({
208
+ 200: {
209
+ "application/json": "json",
210
+ },
211
+ }))
212
+ .then(commonHttpClient.castResponse())
213
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findBulkAssignableUsers.response"))
214
+ .then(commonHttpClient.getBody);
215
+ };
216
+ /**
217
+ * Finds users with a structured query and returns a [paginated](#pagination) list
218
+ * of user keys.
219
+ *
220
+ * This operation takes the users in the range defined by `startAt` and
221
+ * `maxResults`, up to the thousandth user, and then returns only the users from
222
+ * that range that match the structured query. This means the operation usually
223
+ * returns fewer users than specified in `maxResults`. To get all the users who
224
+ * match the structured query, use [Get all
225
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
226
+ *
227
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
228
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
229
+ *
230
+ * The query statements are:
231
+ *
232
+ * * `is assignee of PROJ` Returns the users that are assignees of at least one
233
+ * issue in project *PROJ*.
234
+ * * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the
235
+ * issues *PROJ-1* or *PROJ-2*.
236
+ * * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the
237
+ * issues *PROJ-1* or *PROJ-2*.
238
+ * * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the
239
+ * issues *PROJ-1* or *PROJ-2*.
240
+ * * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues
241
+ * *PROJ-1* or *PROJ-2*.
242
+ * * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment
243
+ * on the issues *PROJ-1* or *PROJ-2*.
244
+ * * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a
245
+ * transition on issues *PROJ-1* or *PROJ-2*.
246
+ * * `[propertyKey].entity.property.path is "property value"` Returns users with
247
+ * the entity property value.
248
+ *
249
+ * The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ...
250
+ * PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form
251
+ * more complex queries. For example:
252
+ *
253
+ * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
254
+ *
255
+ * @returns Returned if the request is successful.
256
+ * @path {GET} /rest/api/3/user/search/query/key
257
+ * @scopes-current read:jira-user
258
+ * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
259
+ * read:issue.watcher:jira, read:project:jira, read:user.property:jira,
260
+ * read:user:jira
261
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-key-get
262
+ */
263
+ this.findUserKeysByQuery = ({ query, startAt, maxResult, }) => {
264
+ return this.getClientInstance()
265
+ .request({
266
+ path: "/rest/api/3/user/search/query/key",
267
+ method: "GET",
268
+ query: {
269
+ query,
270
+ startAt,
271
+ maxResult,
272
+ },
273
+ })
274
+ .then(this.getClientInstance().responseHandler({
275
+ 200: {
276
+ "application/json": "json",
277
+ },
278
+ }))
279
+ .then(commonHttpClient.castResponse())
280
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUserKeysByQuery.response"))
281
+ .then(commonHttpClient.getBody);
282
+ };
283
+ /**
284
+ * Returns a list of active users that match the search string and property.
285
+ *
286
+ * This operation first applies a filter to match the search string and property,
287
+ * and then takes the filtered users in the range defined by `startAt` and
288
+ * `maxResults`, up to the thousandth user. To get all the users who match the
289
+ * search string and property, use [Get all
290
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
291
+ *
292
+ * This operation can be accessed anonymously.
293
+ *
294
+ * Privacy controls are applied to the response based on the users' preferences.
295
+ * This could mean, for example, that the user's email address is hidden. See the
296
+ * [Profile visibility
297
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
298
+ * for more details.
299
+ *
300
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
301
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or
302
+ * calls by users without the required permission return empty search results.
303
+ *
304
+ * @returns Returned if the request is successful.
305
+ *
306
+ * example: [
307
+ * {
308
+ * "accountId": "5b10a2844c20165700ede21g",
309
+ * "accountType": "atlassian",
310
+ * "active": false,
311
+ * "avatarUrls": {
312
+ * "16x16":
313
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
314
+ * "24x24":
315
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
316
+ * "32x32":
317
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
318
+ * "48x48":
319
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
320
+ * },
321
+ * "displayName": "Mia Krystof",
322
+ * "key": "",
323
+ * "name": "",
324
+ * "self":
325
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
326
+ * },
327
+ * {
328
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
329
+ * "accountType": "atlassian",
330
+ * "active": false,
331
+ * "avatarUrls": {
332
+ * "16x16":
333
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
334
+ * "24x24":
335
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
336
+ * "32x32":
337
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
338
+ * "48x48":
339
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
340
+ * },
341
+ * "displayName": "Emma Richards",
342
+ * "key": "",
343
+ * "name": "",
344
+ * "self":
345
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
346
+ * }
347
+ * ]
348
+ * @path {GET} /rest/api/3/user/search
349
+ * @scopes-current read:jira-user
350
+ * @scopes-beta read:user:jira, read:user.property:jira, read:application-role:jira,
351
+ * read:avatar:jira, read:group:jira
352
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-get
353
+ */
354
+ this.findUsers = ({ query, username, accountId, startAt, maxResults, property, } = {}) => {
355
+ return this.getClientInstance()
356
+ .request({
357
+ path: "/rest/api/3/user/search",
358
+ method: "GET",
359
+ query: {
360
+ query,
361
+ username,
362
+ accountId,
363
+ startAt,
364
+ maxResults,
365
+ property,
366
+ },
367
+ })
368
+ .then(this.getClientInstance().responseHandler({
369
+ 200: {
370
+ "application/json": "json",
371
+ },
372
+ }))
373
+ .then(commonHttpClient.castResponse())
374
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsers.response"))
375
+ .then(commonHttpClient.getBody);
376
+ };
377
+ /**
378
+ * Finds users with a structured query and returns a [paginated](#pagination) list
379
+ * of user details.
380
+ *
381
+ * This operation takes the users in the range defined by `startAt` and
382
+ * `maxResults`, up to the thousandth user, and then returns only the users from
383
+ * that range that match the structured query. This means the operation usually
384
+ * returns fewer users than specified in `maxResults`. To get all the users who
385
+ * match the structured query, use [Get all
386
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
387
+ *
388
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
389
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
390
+ *
391
+ * The query statements are:
392
+ *
393
+ * * `is assignee of PROJ` Returns the users that are assignees of at least one
394
+ * issue in project *PROJ*.
395
+ * * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the
396
+ * issues *PROJ-1* or *PROJ-2*.
397
+ * * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the
398
+ * issues *PROJ-1* or *PROJ-2*.
399
+ * * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the
400
+ * issues *PROJ-1* or *PROJ-2*.
401
+ * * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues
402
+ * *PROJ-1* or *PROJ-2*.
403
+ * * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment
404
+ * on the issues *PROJ-1* or *PROJ-2*.
405
+ * * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a
406
+ * transition on issues *PROJ-1* or *PROJ-2*.
407
+ * * `[propertyKey].entity.property.path is "property value"` Returns users with
408
+ * the entity property value.
409
+ *
410
+ * The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ...
411
+ * PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form
412
+ * more complex queries. For example:
413
+ *
414
+ * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
415
+ *
416
+ * @returns Returned if the request is successful.
417
+ * @path {GET} /rest/api/3/user/search/query
418
+ * @scopes-current read:jira-user
419
+ * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
420
+ * read:issue.watcher:jira, read:project:jira, read:user:jira,
421
+ * read:user.property:jira, read:application-role:jira, read:avatar:jira,
422
+ * read:group:jira
423
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-get
424
+ */
425
+ this.findUsersByQuery = ({ query, startAt, maxResults, }) => {
426
+ return this.getClientInstance()
427
+ .request({
428
+ path: "/rest/api/3/user/search/query",
429
+ method: "GET",
430
+ query: {
431
+ query,
432
+ startAt,
433
+ maxResults,
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("UserSearchService.findUsersByQuery.response"))
443
+ .then(commonHttpClient.getBody);
444
+ };
445
+ /**
446
+ * Returns a list of users whose attributes match the query term. The returned
447
+ * object includes the `html` field where the matched query term is highlighted
448
+ * with the HTML strong tag. A list of account IDs can be provided to exclude
449
+ * users from the results.
450
+ *
451
+ * This operation takes the users in the range defined by `maxResults`, up to the
452
+ * thousandth user, and then returns only the users from that range that match the
453
+ * query term. This means the operation usually returns fewer users than specified
454
+ * in `maxResults`. To get all the users who match the query term, use [Get all
455
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
456
+ *
457
+ * Privacy controls are applied to the response based on the users' preferences.
458
+ * This could mean, for example, that the user's email address is hidden. See the
459
+ * [Profile visibility
460
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
461
+ * for more details.
462
+ *
463
+ * This operation can be accessed anonymously.
464
+ *
465
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
466
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and
467
+ * calls by users without the required permission return search results for an
468
+ * exact name match only.
469
+ *
470
+ * @returns Returned if the request is successful.
471
+ *
472
+ * example: {
473
+ * "header": "Showing 20 of 25 matching groups",
474
+ * "total": 25,
475
+ * "users": [
476
+ * {
477
+ * "accountId": "5b10a2844c20165700ede21g",
478
+ * "accountType": "atlassian",
479
+ * "avatarUrl":
480
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
481
+ * "displayName": "Mia Krystof",
482
+ * "html": "<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com
483
+ * (<strong>mi</strong>a)",
484
+ * "key": "mia",
485
+ * "name": "mia"
486
+ * }
487
+ * ]
488
+ * }
489
+ * @path {GET} /rest/api/3/user/picker
490
+ * @scopes-current read:jira-user
491
+ * @scopes-beta read:user:jira
492
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-picker-get
493
+ */
494
+ this.findUsersForPicker = ({ query, maxResults, showAvatar, exclude, excludeAccountIds, avatarSize, excludeConnectUsers, }) => {
495
+ return this.getClientInstance()
496
+ .request({
497
+ path: "/rest/api/3/user/picker",
498
+ method: "GET",
499
+ query: {
500
+ query,
501
+ maxResults,
502
+ showAvatar,
503
+ exclude,
504
+ excludeAccountIds,
505
+ avatarSize,
506
+ excludeConnectUsers,
507
+ },
508
+ })
509
+ .then(this.getClientInstance().responseHandler({
510
+ 200: {
511
+ "application/json": "json",
512
+ },
513
+ }))
514
+ .then(commonHttpClient.castResponse())
515
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersForPicker.response"))
516
+ .then(commonHttpClient.getBody);
517
+ };
518
+ /**
519
+ * Returns a list of users who fulfill these criteria:
520
+ *
521
+ * * their user attributes match a search string.
522
+ * * they have a set of permissions for a project or issue.
523
+ *
524
+ * If no search string is provided, a list of all users with the permissions is
525
+ * returned.
526
+ *
527
+ * This operation takes the users in the range defined by `startAt` and
528
+ * `maxResults`, up to the thousandth user, and then returns only the users from
529
+ * that range that match the search string and have permission for the project or
530
+ * issue. This means the operation usually returns fewer users than specified in
531
+ * `maxResults`. To get all the users who match the search string and have
532
+ * permission for the project or issue, use [Get all
533
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
534
+ *
535
+ * Privacy controls are applied to the response based on the users' preferences.
536
+ * This could mean, for example, that the user's email address is hidden. See the
537
+ * [Profile visibility
538
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
539
+ * for more details.
540
+ *
541
+ * This operation can be accessed anonymously.
542
+ *
543
+ * **[Permissions](#permissions) required:**
544
+ *
545
+ * * *Administer Jira* [global
546
+ * permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any
547
+ * project.
548
+ * * *Administer Projects* [project
549
+ * permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get
550
+ * users for that project.
551
+ *
552
+ * @returns Returned if the request is successful.
553
+ *
554
+ * example: [
555
+ * {
556
+ * "accountId": "5b10a2844c20165700ede21g",
557
+ * "accountType": "atlassian",
558
+ * "active": false,
559
+ * "avatarUrls": {
560
+ * "16x16":
561
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
562
+ * "24x24":
563
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
564
+ * "32x32":
565
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
566
+ * "48x48":
567
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
568
+ * },
569
+ * "displayName": "Mia Krystof",
570
+ * "key": "",
571
+ * "name": "",
572
+ * "self":
573
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
574
+ * },
575
+ * {
576
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
577
+ * "accountType": "atlassian",
578
+ * "active": false,
579
+ * "avatarUrls": {
580
+ * "16x16":
581
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
582
+ * "24x24":
583
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
584
+ * "32x32":
585
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
586
+ * "48x48":
587
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
588
+ * },
589
+ * "displayName": "Emma Richards",
590
+ * "key": "",
591
+ * "name": "",
592
+ * "self":
593
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
594
+ * }
595
+ * ]
596
+ * @path {GET} /rest/api/3/user/permission/search
597
+ * @scopes-current read:jira-user
598
+ * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
599
+ * read:avatar:jira, read:group:jira
600
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-permission-search-get
601
+ */
602
+ this.findUsersWithAllPermissions = ({ query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, }) => {
603
+ return this.getClientInstance()
604
+ .request({
605
+ path: "/rest/api/3/user/permission/search",
606
+ method: "GET",
607
+ query: {
608
+ query,
609
+ username,
610
+ accountId,
611
+ permissions,
612
+ issueKey,
613
+ projectKey,
614
+ startAt,
615
+ maxResults,
616
+ },
617
+ })
618
+ .then(this.getClientInstance().responseHandler({
619
+ 200: {
620
+ "application/json": "json",
621
+ },
622
+ }))
623
+ .then(commonHttpClient.castResponse())
624
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersWithAllPermissions.response"))
625
+ .then(commonHttpClient.getBody);
626
+ };
627
+ /**
628
+ * Returns a list of users who fulfill these criteria:
629
+ *
630
+ * * their user attributes match a search string.
631
+ * * they have permission to browse issues.
632
+ *
633
+ * Use this resource to find users who can browse:
634
+ *
635
+ * * an issue, by providing the `issueKey`.
636
+ * * any issue in a project, by providing the `projectKey`.
637
+ *
638
+ * This operation takes the users in the range defined by `startAt` and
639
+ * `maxResults`, up to the thousandth user, and then returns only the users from
640
+ * that range that match the search string and have permission to browse issues.
641
+ * This means the operation usually returns fewer users than specified in
642
+ * `maxResults`. To get all the users who match the search string and have
643
+ * permission to browse issues, use [Get all
644
+ * users](#api-rest-api-3-users-search-get) and filter the records in your code.
645
+ *
646
+ * Privacy controls are applied to the response based on the users' preferences.
647
+ * This could mean, for example, that the user's email address is hidden. See the
648
+ * [Profile visibility
649
+ * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
650
+ * for more details.
651
+ *
652
+ * This operation can be accessed anonymously.
653
+ *
654
+ * **[Permissions](#permissions) required:** *Browse users and groups* [global
655
+ * permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and
656
+ * calls by users without the required permission return empty search results.
657
+ *
658
+ * @returns Returned if the request is successful.
659
+ *
660
+ * example: [
661
+ * {
662
+ * "accountId": "5b10a2844c20165700ede21g",
663
+ * "accountType": "atlassian",
664
+ * "active": false,
665
+ * "avatarUrls": {
666
+ * "16x16":
667
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
668
+ * "24x24":
669
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
670
+ * "32x32":
671
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
672
+ * "48x48":
673
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
674
+ * },
675
+ * "displayName": "Mia Krystof",
676
+ * "key": "",
677
+ * "name": "",
678
+ * "self":
679
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
680
+ * },
681
+ * {
682
+ * "accountId": "5b10ac8d82e05b22cc7d4ef5",
683
+ * "accountType": "atlassian",
684
+ * "active": false,
685
+ * "avatarUrls": {
686
+ * "16x16":
687
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
688
+ * "24x24":
689
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
690
+ * "32x32":
691
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
692
+ * "48x48":
693
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
694
+ * },
695
+ * "displayName": "Emma Richards",
696
+ * "key": "",
697
+ * "name": "",
698
+ * "self":
699
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
700
+ * }
701
+ * ]
702
+ * @path {GET} /rest/api/3/user/viewissue/search
703
+ * @scopes-current read:jira-user
704
+ * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
705
+ * read:avatar:jira, read:group:jira
706
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-viewissue-search-get
707
+ */
708
+ this.findUsersWithBrowsePermission = ({ query, username, accountId, issueKey, projectKey, startAt, maxResults, } = {}) => {
709
+ return this.getClientInstance()
710
+ .request({
711
+ path: "/rest/api/3/user/viewissue/search",
712
+ method: "GET",
713
+ query: {
714
+ query,
715
+ username,
716
+ accountId,
717
+ issueKey,
718
+ projectKey,
719
+ startAt,
720
+ maxResults,
721
+ },
722
+ })
723
+ .then(this.getClientInstance().responseHandler({
724
+ 200: {
725
+ "application/json": "json",
726
+ },
727
+ }))
728
+ .then(commonHttpClient.castResponse())
729
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("UserSearchService.findUsersWithBrowsePermission.response"))
730
+ .then(commonHttpClient.getBody);
731
+ };
729
732
  }
730
733
  static initialize() {
731
734
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UserSearchService.findBulkAssignableUsers.response", zod_1.z