@resolution/jira-api-client 0.4.4 → 0.4.6

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 (336) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +60 -0
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +118 -95
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +1073 -869
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/core/CommonHttpService.d.ts +2 -0
  7. package/lib/openapi/platform/core/CommonHttpService.js +9 -0
  8. package/lib/openapi/platform/core/CommonHttpService.js.map +1 -1
  9. package/lib/openapi/platform/models/common.d.ts +6 -0
  10. package/lib/openapi/platform/models/common.js +12 -1
  11. package/lib/openapi/platform/models/common.js.map +1 -1
  12. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  13. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  14. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  15. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  16. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  17. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  18. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  19. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  20. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  21. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  22. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  23. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  24. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  25. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  26. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  27. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  28. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  29. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  30. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  31. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  32. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  33. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  34. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  35. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  36. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  37. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  38. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  39. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  40. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  41. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  42. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  43. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  44. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  45. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  46. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  47. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  48. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  49. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  50. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  51. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  52. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  53. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  54. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  55. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  56. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  57. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  58. package/lib/openapi/platform/services/GroupsService.js +385 -382
  59. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  61. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  62. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  63. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  64. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  65. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  66. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  67. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  68. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  70. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  71. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  73. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  74. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  76. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  77. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  80. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  82. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  83. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  85. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  86. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  88. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  89. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  91. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  92. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  94. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  95. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  97. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  98. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  100. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  101. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  103. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  104. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  106. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  107. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  109. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  110. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  112. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  113. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  115. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  116. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  118. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  119. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  121. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  122. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  124. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  125. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  127. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  128. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  130. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  131. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  133. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  134. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  136. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  137. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  138. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  139. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  140. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  141. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  142. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  143. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  144. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  145. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  146. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  147. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  148. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  149. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  150. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  151. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  152. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  153. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  154. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  155. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  156. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  157. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  158. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  159. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  160. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  161. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  162. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  163. package/lib/openapi/platform/services/JqlService.js +635 -632
  164. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  165. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  166. package/lib/openapi/platform/services/LabelsService.js +41 -38
  167. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  168. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  169. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  170. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  171. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  172. package/lib/openapi/platform/services/MyselfService.js +321 -318
  173. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  174. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  175. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  176. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  177. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  178. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  179. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  180. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  181. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  182. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  184. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  185. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  187. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  188. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  190. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  191. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  193. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  194. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  196. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  197. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  199. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  200. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  202. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  203. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  205. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  206. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  208. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  209. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  210. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  211. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  212. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  213. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  214. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  215. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  216. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  217. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  218. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  219. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  220. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  221. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  222. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  223. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  224. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  225. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  226. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  227. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  228. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  229. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  230. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  231. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  232. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  233. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  234. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  235. package/lib/openapi/platform/services/ScreensService.js +281 -278
  236. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  237. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  238. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  239. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  240. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  241. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  242. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  243. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  244. package/lib/openapi/platform/services/StatusService.js +271 -268
  245. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  246. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  247. package/lib/openapi/platform/services/TasksService.js +93 -90
  248. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  249. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  250. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  251. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  252. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  253. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  254. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  255. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  256. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  257. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  258. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  259. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  260. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  261. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  262. package/lib/openapi/platform/services/UsersService.js +637 -634
  263. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  264. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  265. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  266. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  268. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  269. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  271. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  272. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  274. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  275. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  276. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  277. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  278. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  279. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  280. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  281. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  282. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  283. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  284. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  285. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  286. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  287. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  288. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  289. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  290. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  291. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +13 -14
  292. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +454 -429
  293. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  294. package/lib/openapi/software/core/CommonHttpService.d.ts +2 -0
  295. package/lib/openapi/software/core/CommonHttpService.js +9 -0
  296. package/lib/openapi/software/core/CommonHttpService.js.map +1 -1
  297. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  298. package/lib/openapi/software/services/BacklogService.js +81 -78
  299. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  300. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  301. package/lib/openapi/software/services/BoardService.js +2048 -2045
  302. package/lib/openapi/software/services/BoardService.js.map +1 -1
  303. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  304. package/lib/openapi/software/services/BuildsService.js +164 -161
  305. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  306. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  307. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  308. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  309. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  310. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  311. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  312. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  313. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  314. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  315. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  316. package/lib/openapi/software/services/EpicService.js +597 -594
  317. package/lib/openapi/software/services/EpicService.js.map +1 -1
  318. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  319. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  320. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  321. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  322. package/lib/openapi/software/services/IssueService.js +359 -356
  323. package/lib/openapi/software/services/IssueService.js.map +1 -1
  324. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  325. package/lib/openapi/software/services/OperationsService.js +301 -298
  326. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  327. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  328. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  329. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  330. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  331. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  332. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  333. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  334. package/lib/openapi/software/services/SprintService.js +594 -591
  335. package/lib/openapi/software/services/SprintService.js.map +1 -1
  336. package/package.json +4 -3
@@ -18,1265 +18,1268 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
18
18
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters
19
19
  */
20
20
  class FiltersService extends CommonHttpService_1.CommonHttpService {
21
- /**
22
- * Changes the owner of the filter.
23
- *
24
- * **[Permissions](#permissions) required:** Permission to access Jira. However,
25
- * the user must own the filter or have the *Administer Jira* [global
26
- * permission](https://confluence.atlassian.com/x/x4dKLg).
27
- *
28
- * @returns Returned if the request is successful.
29
- * @path {PUT} /rest/api/3/filter/{id}/owner
30
- * @scopes-beta read:filter:jira, write:filter:jira
31
- * @scopes-current write:jira-work
32
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-owner-put
33
- */
34
- changeFilterOwner({ id, changeFilterOwner, }) {
35
- return this.getClientInstance()
36
- .request({
37
- path: "/rest/api/3/filter/{id}/owner",
38
- method: "PUT",
39
- pathParams: {
40
- id,
41
- },
42
- headers: {
43
- "Content-Type": "application/json",
44
- },
45
- body: changeFilterOwner,
46
- })
47
- .then(this.getClientInstance().responseHandler({
48
- 204: {
49
- "application/json": "json",
50
- },
51
- }))
52
- .then(commonHttpClient.castResponse())
53
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.changeFilterOwner.response"))
54
- .then(commonHttpClient.getBody);
55
- }
56
- /**
57
- * Creates a filter. The filter is shared according to the [default share
58
- * scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.
59
- *
60
- * **[Permissions](#permissions) required:** Permission to access Jira.
61
- *
62
- * @returns Returned if the request is successful.
63
- *
64
- * example: {
65
- * "approximateLastUsed": null,
66
- * "description": "Lists all open bugs",
67
- * "favourite": true,
68
- * "favouritedCount": 0,
69
- * "id": "10000",
70
- * "jql": "type = Bug and resolution is empty",
71
- * "name": "All Open Bugs",
72
- * "owner": {
73
- * "accountId": "5b10a2844c20165700ede21g",
74
- * "accountType": "atlassian",
75
- * "active": false,
76
- * "avatarUrls": {
77
- * "16x16":
78
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
79
- * "24x24":
80
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
81
- * "32x32":
82
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
83
- * "48x48":
84
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
85
- * },
86
- * "displayName": "Mia Krystof",
87
- * "key": "",
88
- * "name": "",
89
- * "self":
90
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
91
- * },
92
- * "searchUrl":
93
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
94
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
95
- * "sharePermissions": [],
96
- * "subscriptions": {
97
- * "end-index": 0,
98
- * "items": [],
99
- * "max-results": 0,
100
- * "size": 0,
101
- * "start-index": 0
102
- * },
103
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
104
- * }
105
- * @path {POST} /rest/api/3/filter
106
- * @scopes-current write:jira-work
107
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
108
- * read:user:jira, write:filter:jira, read:application-role:jira,
109
- * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
110
- * read:project-category:jira, read:project-version:jira,
111
- * read:project.component:jira
112
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-post
113
- */
114
- createFilter({ expand, overrideSharePermissions, filter, }) {
115
- return this.getClientInstance()
116
- .request({
117
- path: "/rest/api/3/filter",
118
- method: "POST",
119
- query: {
120
- expand,
121
- overrideSharePermissions,
122
- },
123
- headers: {
124
- "Content-Type": "application/json",
125
- },
126
- body: filter,
127
- })
128
- .then(this.getClientInstance().responseHandler({
129
- 200: {
130
- "application/json": "json",
131
- },
132
- }))
133
- .then(commonHttpClient.castResponse())
134
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.createFilter.response"))
135
- .then(commonHttpClient.getBody);
136
- }
137
- /**
138
- * Removes a filter as a favorite for the user. Note that this operation only
139
- * removes filters visible to the user from the user's favorites list. For
140
- * example, if the user favorites a public filter that is subsequently made
141
- * private (and is therefore no longer visible on their favorites list) they
142
- * cannot remove it from their favorites list.
143
- *
144
- * **[Permissions](#permissions) required:** Permission to access Jira.
145
- *
146
- * @returns Returned if the request is successful.
147
- *
148
- * example: {
149
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
150
- * "description": "Lists all open bugs",
151
- * "favourite": true,
152
- * "favouritedCount": 0,
153
- * "id": "10000",
154
- * "jql": "type = Bug and resolution is empty",
155
- * "name": "All Open Bugs",
156
- * "owner": {
157
- * "accountId": "5b10a2844c20165700ede21g",
158
- * "accountType": "atlassian",
159
- * "active": false,
160
- * "avatarUrls": {
161
- * "16x16":
162
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
163
- * "24x24":
164
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
165
- * "32x32":
166
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
167
- * "48x48":
168
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
169
- * },
170
- * "displayName": "Mia Krystof",
171
- * "key": "",
172
- * "name": "",
173
- * "self":
174
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
175
- * },
176
- * "searchUrl":
177
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
178
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
179
- * "sharePermissions": [],
180
- * "subscriptions": {
181
- * "end-index": 0,
182
- * "items": [],
183
- * "max-results": 0,
184
- * "size": 0,
185
- * "start-index": 0
186
- * },
187
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
188
- * }
189
- * @path {DELETE} /rest/api/3/filter/{id}/favourite
190
- * @scopes-current write:jira-work
191
- * @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira,
192
- * read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira,
193
- * read:issue-type:jira, read:project-category:jira, read:project-role:jira,
194
- * read:project-version:jira, read:project.component:jira, read:project:jira,
195
- * read:user:jira
196
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-delete
197
- */
198
- deleteFavouriteForFilter({ id, expand, }) {
199
- return this.getClientInstance()
200
- .request({
201
- path: "/rest/api/3/filter/{id}/favourite",
202
- method: "DELETE",
203
- pathParams: {
204
- id,
205
- },
206
- query: {
207
- expand,
208
- },
209
- })
210
- .then(this.getClientInstance().responseHandler({
211
- 200: {
212
- "application/json": "json",
213
- },
214
- }))
215
- .then(commonHttpClient.castResponse())
216
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.deleteFavouriteForFilter.response"))
217
- .then(commonHttpClient.getBody);
218
- }
219
- /**
220
- * Delete a filter.
221
- *
222
- * **[Permissions](#permissions) required:** Permission to access Jira, however
223
- * filters can only be deleted by the creator of the filter or a user with
224
- * *Administer Jira* [global
225
- * permission](https://confluence.atlassian.com/x/x4dKLg).
226
- *
227
- * @path {DELETE} /rest/api/3/filter/{id}
228
- * @scopes-current write:jira-work
229
- * @scopes-beta delete:filter:jira
230
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-delete
231
- */
232
- deleteFilter({ id, }) {
233
- return this.getClientInstance()
234
- .request({
235
- path: "/rest/api/3/filter/{id}",
236
- method: "DELETE",
237
- pathParams: {
238
- id,
239
- },
240
- })
241
- .then(commonHttpClient.discardResult);
242
- }
243
- /**
244
- * Returns the columns configured for a filter. The column configuration is used
245
- * when the filter's results are viewed in *List View* with the *Columns* set to
246
- * *Filter*.
247
- *
248
- * This operation can be accessed anonymously.
249
- *
250
- * **[Permissions](#permissions) required:** None, however, column details are
251
- * only returned for:
252
- *
253
- * * filters owned by the user.
254
- * * filters shared with a group that the user is a member of.
255
- * * filters shared with a private project that the user has *Browse projects*
256
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
257
- * * filters shared with a public project.
258
- * * filters shared with the public.
259
- *
260
- * @returns Returned if the request is successful.
261
- *
262
- * example: [
263
- * {
264
- * "label": "Key",
265
- * "value": "issuekey"
266
- * },
267
- * {
268
- * "label": "Summary",
269
- * "value": "summary"
270
- * }
271
- * ]
272
- * @path {GET} /rest/api/3/filter/{id}/columns
273
- * @scopes-current read:jira-work
274
- * @scopes-beta read:filter.column:jira
275
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-get
276
- */
277
- getColumns({ id, }) {
278
- return this.getClientInstance()
279
- .request({
280
- path: "/rest/api/3/filter/{id}/columns",
281
- method: "GET",
282
- pathParams: {
283
- id,
284
- },
285
- })
286
- .then(this.getClientInstance().responseHandler({
287
- 200: {
288
- "application/json": "json",
289
- },
290
- }))
291
- .then(commonHttpClient.castResponse())
292
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getColumns.response"))
293
- .then(commonHttpClient.getBody);
294
- }
295
- /**
296
- * Returns the visible favorite filters of the user.
297
- *
298
- * This operation can be accessed anonymously.
299
- *
300
- * **[Permissions](#permissions) required:** A favorite filter is only visible to
301
- * the user where the filter is:
302
- *
303
- * * owned by the user.
304
- * * shared with a group that the user is a member of.
305
- * * shared with a private project that the user has *Browse projects* [project
306
- * permission](https://confluence.atlassian.com/x/yodKLg) for.
307
- * * shared with a public project.
308
- * * shared with the public.
309
- *
310
- * For example, if the user favorites a public filter that is subsequently made
311
- * private that filter is not returned by this operation.
312
- *
313
- * @returns Returned if the request is successful.
314
- *
315
- * example: [
316
- * {
317
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
318
- * "description": "Lists all open bugs",
319
- * "favourite": true,
320
- * "favouritedCount": 0,
321
- * "id": "10000",
322
- * "jql": "type = Bug and resolution is empty",
323
- * "name": "All Open Bugs",
324
- * "owner": {
325
- * "accountId": "5b10a2844c20165700ede21g",
326
- * "accountType": "atlassian",
327
- * "active": false,
328
- * "avatarUrls": {
329
- * "16x16":
330
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
331
- * "24x24":
332
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
333
- * "32x32":
334
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
335
- * "48x48":
336
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
337
- * },
338
- * "displayName": "Mia Krystof",
339
- * "key": "",
340
- * "name": "",
341
- * "self":
342
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
343
- * },
344
- * "searchUrl":
345
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
346
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
347
- * "sharePermissions": [],
348
- * "subscriptions": {
349
- * "end-index": 0,
350
- * "items": [],
351
- * "max-results": 0,
352
- * "size": 0,
353
- * "start-index": 0
354
- * },
355
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
356
- * },
357
- * {
358
- * "approximateLastUsed": null,
359
- * "description": "Issues assigned to me",
360
- * "favourite": true,
361
- * "favouritedCount": 0,
362
- * "id": "10010",
363
- * "jql": "assignee = currentUser() and resolution is empty",
364
- * "name": "My issues",
365
- * "owner": {
366
- * "accountId": "5b10a2844c20165700ede21g",
367
- * "accountType": "atlassian",
368
- * "active": false,
369
- * "avatarUrls": {
370
- * "16x16":
371
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
372
- * "24x24":
373
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
374
- * "32x32":
375
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
376
- * "48x48":
377
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
378
- * },
379
- * "displayName": "Mia Krystof",
380
- * "key": "",
381
- * "name": "",
382
- * "self":
383
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
384
- * },
385
- * "searchUrl":
386
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
387
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
388
- * "sharePermissions": [
389
- * {
390
- * "id": 10000,
391
- * "type": "global"
392
- * },
393
- * {
394
- * "id": 10010,
395
- * "project": {
396
- * "avatarUrls": {
397
- * "16x16":
398
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
399
- * "24x24":
400
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
401
- * "32x32":
402
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
403
- * "48x48":
404
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
405
- * },
406
- * "id": "10000",
407
- * "insight": {
408
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
409
- * "totalIssueCount": 100
410
- * },
411
- * "key": "EX",
412
- * "name": "Example",
413
- * "projectCategory": {
414
- * "description": "First Project Category",
415
- * "id": "10000",
416
- * "name": "FIRST",
417
- * "self":
418
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
419
- * },
420
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
421
- * "simplified": false,
422
- * "style": "classic"
423
- * },
424
- * "type": "project"
425
- * }
426
- * ],
427
- * "subscriptions": {
428
- * "end-index": 0,
429
- * "items": [],
430
- * "max-results": 0,
431
- * "size": 0,
432
- * "start-index": 0
433
- * },
434
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
435
- * }
436
- * ]
437
- * @path {GET} /rest/api/3/filter/favourite
438
- * @scopes-current read:jira-work
439
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
440
- * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
441
- * read:issue-type-hierarchy:jira
442
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-favourite-get
443
- */
444
- getFavouriteFilters({ expand, } = {}) {
445
- return this.getClientInstance()
446
- .request({
447
- path: "/rest/api/3/filter/favourite",
448
- method: "GET",
449
- query: {
450
- expand,
451
- },
452
- })
453
- .then(this.getClientInstance().responseHandler({
454
- 200: {
455
- "application/json": "json",
456
- },
457
- }))
458
- .then(commonHttpClient.castResponse())
459
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFavouriteFilters.response"))
460
- .then(commonHttpClient.getBody);
461
- }
462
- /**
463
- * Returns a filter.
464
- *
465
- * This operation can be accessed anonymously.
466
- *
467
- * **[Permissions](#permissions) required:** None, however, the filter is only
468
- * returned where it is:
469
- *
470
- * * owned by the user.
471
- * * shared with a group that the user is a member of.
472
- * * shared with a private project that the user has *Browse projects* [project
473
- * permission](https://confluence.atlassian.com/x/yodKLg) for.
474
- * * shared with a public project.
475
- * * shared with the public.
476
- *
477
- * @returns Returned if the request is successful.
478
- *
479
- * example: {
480
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
481
- * "description": "Lists all open bugs",
482
- * "favourite": true,
483
- * "favouritedCount": 0,
484
- * "id": "10000",
485
- * "jql": "type = Bug and resolution is empty",
486
- * "name": "All Open Bugs",
487
- * "owner": {
488
- * "accountId": "5b10a2844c20165700ede21g",
489
- * "accountType": "atlassian",
490
- * "active": false,
491
- * "avatarUrls": {
492
- * "16x16":
493
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
494
- * "24x24":
495
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
496
- * "32x32":
497
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
498
- * "48x48":
499
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
500
- * },
501
- * "displayName": "Mia Krystof",
502
- * "key": "",
503
- * "name": "",
504
- * "self":
505
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
506
- * },
507
- * "searchUrl":
508
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
509
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
510
- * "sharePermissions": [],
511
- * "subscriptions": {
512
- * "end-index": 0,
513
- * "items": [],
514
- * "max-results": 0,
515
- * "size": 0,
516
- * "start-index": 0
517
- * },
518
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
519
- * }
520
- * @path {GET} /rest/api/3/filter/{id}
521
- * @scopes-current read:jira-work
522
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
523
- * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
524
- * read:issue-type-hierarchy:jira
525
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-get
526
- */
527
- getFilter({ id, expand, overrideSharePermissions, }) {
528
- return this.getClientInstance()
529
- .request({
530
- path: "/rest/api/3/filter/{id}",
531
- method: "GET",
532
- pathParams: {
533
- id,
534
- },
535
- query: {
536
- expand,
537
- overrideSharePermissions,
538
- },
539
- })
540
- .then(this.getClientInstance().responseHandler({
541
- 200: {
542
- "application/json": "json",
543
- },
544
- }))
545
- .then(commonHttpClient.castResponse())
546
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFilter.response"))
547
- .then(commonHttpClient.getBody);
548
- }
549
- /**
550
- * Returns a [paginated](#pagination) list of filters. Use this operation to get:
551
- *
552
- * * specific filters, by defining `id` only.
553
- * * filters that match all of the specified attributes. For example, all
554
- * filters for a user with a particular word in their name. When multiple
555
- * attributes are specified only filters matching all attributes are returned.
556
- *
557
- * This operation can be accessed anonymously.
558
- *
559
- * **[Permissions](#permissions) required:** None, however, only the following
560
- * filters that match the query parameters are returned:
561
- *
562
- * * filters owned by the user.
563
- * * filters shared with a group that the user is a member of.
564
- * * filters shared with a private project that the user has *Browse projects*
565
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
566
- * * filters shared with a public project.
567
- * * filters shared with the public.
568
- *
569
- * @returns Returned if the request is successful.
570
- *
571
- * example: {
572
- * "isLast": true,
573
- * "maxResults": 100,
574
- * "self":
575
- * "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
576
- * "startAt": 0,
577
- * "total": 2,
578
- * "values": [
579
- * {
580
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
581
- * "description": "Lists all open bugs",
582
- * "editPermissions": [],
583
- * "expand":
584
- * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
585
- * "favourite": false,
586
- * "favouritedCount": 0,
587
- * "id": "10000",
588
- * "jql": "type = Bug and resolution is empty",
589
- * "name": "All Open Bugs",
590
- * "owner": {
591
- * "accountId": "5b10a2844c20165700ede21g",
592
- * "accountType": "atlassian",
593
- * "active": false,
594
- * "avatarUrls": {
595
- * "16x16":
596
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
597
- * "24x24":
598
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
599
- * "32x32":
600
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
601
- * "48x48":
602
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
603
- * },
604
- * "displayName": "Mia Krystof",
605
- * "key": "",
606
- * "name": "",
607
- * "self":
608
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
609
- * },
610
- * "searchUrl":
611
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
612
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
613
- * "sharePermissions": [],
614
- * "subscriptions": [],
615
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
616
- * },
617
- * {
618
- * "approximateLastUsed": null,
619
- * "description": "Issues assigned to me",
620
- * "editPermissions": [
621
- * {
622
- * "id": 10010,
623
- * "project": {
624
- * "avatarUrls": {
625
- * "16x16":
626
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
627
- * "24x24":
628
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
629
- * "32x32":
630
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
631
- * "48x48":
632
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
633
- * },
634
- * "deleted": true,
635
- * "deletedBy": {
636
- * "accountId": "5b10a2844c20165700ede21g",
637
- * "accountType": "atlassian",
638
- * "active": false,
639
- * "avatarUrls": {
640
- * "16x16":
641
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
642
- * "24x24":
643
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
644
- * "32x32":
645
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
646
- * "48x48":
647
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
648
- * },
649
- * "displayName": "Mia Krystof",
650
- * "key": "",
651
- * "name": "",
652
- * "self":
653
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
654
- * },
655
- * "deletedDate": "2022-11-11T13:35:29.000+0000",
656
- * "id": "10002",
657
- * "insight": {
658
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
659
- * "totalIssueCount": 100
660
- * },
661
- * "key": "MKY",
662
- * "name": "Example",
663
- * "projectCategory": {
664
- * "description": "First Project Category",
665
- * "id": "10000",
666
- * "name": "FIRST",
667
- * "self":
668
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
669
- * },
670
- * "retentionTillDate": "2023-01-10T13:35:29.000+0000",
671
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
672
- * "simplified": false,
673
- * "style": "classic"
674
- * },
675
- * "role": {
676
- * "self":
677
- * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
678
- * "name": "Developers",
679
- * "id": 10360,
680
- * "description": "A project role that represents developers in a
681
- * project",
682
- * "actors": [
683
- * {
684
- * "actorGroup": {
685
- * "name": "jira-developers",
686
- * "displayName": "jira-developers",
687
- * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
688
- * },
689
- * "displayName": "jira-developers",
690
- * "id": 10240,
691
- * "name": "jira-developers",
692
- * "type": "atlassian-group-role-actor"
693
- * },
694
- * {
695
- * "actorUser": {
696
- * "accountId": "5b10a2844c20165700ede21g"
697
- * },
698
- * "displayName": "Mia Krystof",
699
- * "id": 10241,
700
- * "type": "atlassian-user-role-actor"
701
- * }
702
- * ],
703
- * "scope": {
704
- * "project": {
705
- * "id": "10000",
706
- * "key": "KEY",
707
- * "name": "Next Gen Project"
708
- * },
709
- * "type": "PROJECT"
710
- * }
711
- * },
712
- * "type": "project"
713
- * },
714
- * {
715
- * "group": {
716
- * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
717
- * "name": "jira-administrators",
718
- * "self":
719
- * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
720
- * },
721
- * "id": 10010,
722
- * "type": "group"
723
- * }
724
- * ],
725
- * "expand":
726
- * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
727
- * "favourite": true,
728
- * "favouritedCount": 123,
729
- * "id": "10010",
730
- * "jql": "assignee = currentUser() and resolution is empty",
731
- * "name": "My issues",
732
- * "owner": {
733
- * "accountId": "5b10a2844c20165700ede21g",
734
- * "accountType": "atlassian",
735
- * "active": false,
736
- * "avatarUrls": {
737
- * "16x16":
738
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
739
- * "24x24":
740
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
741
- * "32x32":
742
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
743
- * "48x48":
744
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
745
- * },
746
- * "displayName": "Mia Krystof",
747
- * "key": "",
748
- * "name": "",
749
- * "self":
750
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
751
- * },
752
- * "searchUrl":
753
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
754
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
755
- * "sharePermissions": [
756
- * {
757
- * "id": 10000,
758
- * "type": "global"
759
- * },
760
- * {
761
- * "id": 10010,
762
- * "project": {
763
- * "avatarUrls": {
764
- * "16x16":
765
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
766
- * "24x24":
767
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
768
- * "32x32":
769
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
770
- * "48x48":
771
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
772
- * },
773
- * "id": "10000",
774
- * "insight": {
775
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
776
- * "totalIssueCount": 100
777
- * },
778
- * "key": "EX",
779
- * "name": "Example",
780
- * "projectCategory": {
781
- * "description": "First Project Category",
782
- * "id": "10000",
783
- * "name": "FIRST",
784
- * "self":
785
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
786
- * },
787
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
788
- * "simplified": false,
789
- * "style": "classic"
790
- * },
791
- * "type": "project"
792
- * }
793
- * ],
794
- * "subscriptions": [
795
- * {
796
- * "id": 1,
797
- * "user": {
798
- * "accountId": "5b10a2844c20165700ede21g",
799
- * "accountType": "atlassian",
800
- * "active": true,
801
- * "applicationRoles": {
802
- * "items": [],
803
- * "size": 1
804
- * },
805
- * "avatarUrls": {
806
- * "16x16":
807
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
808
- * "24x24":
809
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
810
- * "32x32":
811
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
812
- * "48x48":
813
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
814
- * },
815
- * "displayName": "Mia Krystof",
816
- * "emailAddress": "mia@example.com",
817
- * "groups": {
818
- * "items": [],
819
- * "size": 3
820
- * },
821
- * "key": "",
822
- * "name": "",
823
- * "self":
824
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
825
- * "timeZone": "Australia/Sydney"
826
- * }
827
- * }
828
- * ],
829
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
830
- * }
831
- * ]
832
- * }
833
- * @path {GET} /rest/api/3/filter/search
834
- * @scopes-current read:jira-work
835
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
836
- * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
837
- * read:issue-type-hierarchy:jira
838
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-search-get
839
- */
840
- getFiltersPaginated({ filterName, accountId, owner, groupname, groupId, projectId, id, orderBy, startAt, maxResults, expand, overrideSharePermissions, } = {}) {
841
- return this.getClientInstance()
842
- .request({
843
- path: "/rest/api/3/filter/search",
844
- method: "GET",
845
- query: {
846
- filterName,
847
- accountId,
848
- owner,
849
- groupname,
850
- groupId,
851
- projectId,
852
- id,
853
- orderBy,
854
- startAt,
855
- maxResults,
856
- expand,
857
- overrideSharePermissions,
858
- },
859
- })
860
- .then(this.getClientInstance().responseHandler({
861
- 200: {
862
- "application/json": "json",
863
- },
864
- }))
865
- .then(commonHttpClient.castResponse())
866
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFiltersPaginated.response"))
867
- .then(commonHttpClient.getBody);
868
- }
869
- /**
870
- * Returns the filters owned by the user. If `includeFavourites` is `true`, the
871
- * user's visible favorite filters are also returned.
872
- *
873
- * **[Permissions](#permissions) required:** Permission to access Jira, however, a
874
- * favorite filters is only visible to the user where the filter is:
875
- *
876
- * * owned by the user.
877
- * * shared with a group that the user is a member of.
878
- * * shared with a private project that the user has *Browse projects* [project
879
- * permission](https://confluence.atlassian.com/x/yodKLg) for.
880
- * * shared with a public project.
881
- * * shared with the public.
882
- *
883
- * For example, if the user favorites a public filter that is subsequently made
884
- * private that filter is not returned by this operation.
885
- *
886
- * @returns Returned if the request is successful.
887
- *
888
- * example: [
889
- * {
890
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
891
- * "description": "Lists all open bugs",
892
- * "favourite": true,
893
- * "favouritedCount": 0,
894
- * "id": "10000",
895
- * "jql": "type = Bug and resolution is empty",
896
- * "name": "All Open Bugs",
897
- * "owner": {
898
- * "accountId": "5b10a2844c20165700ede21g",
899
- * "accountType": "atlassian",
900
- * "active": false,
901
- * "avatarUrls": {
902
- * "16x16":
903
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
904
- * "24x24":
905
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
906
- * "32x32":
907
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
908
- * "48x48":
909
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
910
- * },
911
- * "displayName": "Mia Krystof",
912
- * "key": "",
913
- * "name": "",
914
- * "self":
915
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
916
- * },
917
- * "searchUrl":
918
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
919
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
920
- * "sharePermissions": [],
921
- * "subscriptions": {
922
- * "end-index": 0,
923
- * "items": [],
924
- * "max-results": 0,
925
- * "size": 0,
926
- * "start-index": 0
927
- * },
928
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
929
- * },
930
- * {
931
- * "approximateLastUsed": null,
932
- * "description": "Issues assigned to me",
933
- * "favourite": true,
934
- * "favouritedCount": 0,
935
- * "id": "10010",
936
- * "jql": "assignee = currentUser() and resolution is empty",
937
- * "name": "My issues",
938
- * "owner": {
939
- * "accountId": "5b10a2844c20165700ede21g",
940
- * "accountType": "atlassian",
941
- * "active": false,
942
- * "avatarUrls": {
943
- * "16x16":
944
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
945
- * "24x24":
946
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
947
- * "32x32":
948
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
949
- * "48x48":
950
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
951
- * },
952
- * "displayName": "Mia Krystof",
953
- * "key": "",
954
- * "name": "",
955
- * "self":
956
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
957
- * },
958
- * "searchUrl":
959
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
960
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
961
- * "sharePermissions": [
962
- * {
963
- * "id": 10000,
964
- * "type": "global"
965
- * },
966
- * {
967
- * "id": 10010,
968
- * "project": {
969
- * "avatarUrls": {
970
- * "16x16":
971
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
972
- * "24x24":
973
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
974
- * "32x32":
975
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
976
- * "48x48":
977
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
978
- * },
979
- * "id": "10000",
980
- * "insight": {
981
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
982
- * "totalIssueCount": 100
983
- * },
984
- * "key": "EX",
985
- * "name": "Example",
986
- * "projectCategory": {
987
- * "description": "First Project Category",
988
- * "id": "10000",
989
- * "name": "FIRST",
990
- * "self":
991
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
992
- * },
993
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
994
- * "simplified": false,
995
- * "style": "classic"
996
- * },
997
- * "type": "project"
998
- * }
999
- * ],
1000
- * "subscriptions": {
1001
- * "end-index": 0,
1002
- * "items": [],
1003
- * "max-results": 0,
1004
- * "size": 0,
1005
- * "start-index": 0
1006
- * },
1007
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
1008
- * }
1009
- * ]
1010
- * @path {GET} /rest/api/3/filter/my
1011
- * @scopes-current read:jira-work
1012
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
1013
- * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
1014
- * read:issue-type-hierarchy:jira
1015
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-my-get
1016
- */
1017
- getMyFilters({ expand, includeFavourites, } = {}) {
1018
- return this.getClientInstance()
1019
- .request({
1020
- path: "/rest/api/3/filter/my",
1021
- method: "GET",
1022
- query: {
1023
- expand,
1024
- includeFavourites,
1025
- },
1026
- })
1027
- .then(this.getClientInstance().responseHandler({
1028
- 200: {
1029
- "application/json": "json",
1030
- },
1031
- }))
1032
- .then(commonHttpClient.castResponse())
1033
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getMyFilters.response"))
1034
- .then(commonHttpClient.getBody);
1035
- }
1036
- /**
1037
- * Reset the user's column configuration for the filter to the default.
1038
- *
1039
- * **[Permissions](#permissions) required:** Permission to access Jira, however,
1040
- * columns are only reset for:
1041
- *
1042
- * * filters owned by the user.
1043
- * * filters shared with a group that the user is a member of.
1044
- * * filters shared with a private project that the user has *Browse projects*
1045
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1046
- * * filters shared with a public project.
1047
- * * filters shared with the public.
1048
- *
1049
- * @path {DELETE} /rest/api/3/filter/{id}/columns
1050
- * @scopes-beta delete:filter.column:jira
1051
- * @scopes-current write:jira-work
1052
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-delete
1053
- */
1054
- resetColumns({ id, }) {
1055
- return this.getClientInstance()
1056
- .request({
1057
- path: "/rest/api/3/filter/{id}/columns",
1058
- method: "DELETE",
1059
- pathParams: {
1060
- id,
1061
- },
1062
- })
1063
- .then(commonHttpClient.discardResult);
1064
- }
1065
- /**
1066
- * Sets the columns for a filter. Only navigable fields can be set as columns. Use
1067
- * [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A
1068
- * navigable field has `navigable` set to `true`.
1069
- *
1070
- * The parameters for this resource are expressed as HTML form data. For example,
1071
- * in curl:
1072
- *
1073
- * `curl -X PUT -d columns=summary -d columns=description
1074
- * https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`
1075
- *
1076
- * **[Permissions](#permissions) required:** Permission to access Jira, however,
1077
- * columns are only set for:
1078
- *
1079
- * * filters owned by the user.
1080
- * * filters shared with a group that the user is a member of.
1081
- * * filters shared with a private project that the user has *Browse projects*
1082
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1083
- * * filters shared with a public project.
1084
- * * filters shared with the public.
1085
- *
1086
- * @returns Returned if the request is successful.
1087
- * @path {PUT} /rest/api/3/filter/{id}/columns
1088
- * @scopes-current write:jira-work
1089
- * @scopes-beta write:filter.column:jira
1090
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-put
1091
- */
1092
- setColumns({ id, mediaType = "application/json", columnRequestBody, }) {
1093
- return this.getClientInstance()
1094
- .request({
1095
- path: "/rest/api/3/filter/{id}/columns",
1096
- method: "PUT",
1097
- pathParams: {
1098
- id,
1099
- },
1100
- headers: {
1101
- "Content-Type": mediaType,
1102
- },
1103
- body: columnRequestBody,
1104
- })
1105
- .then(this.getClientInstance().responseHandler({
1106
- 200: {
1107
- "application/json": "json",
1108
- },
1109
- }))
1110
- .then(commonHttpClient.castResponse())
1111
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.setColumns.response"))
1112
- .then(commonHttpClient.getBody);
1113
- }
1114
- /**
1115
- * Add a filter as a favorite for the user.
1116
- *
1117
- * **[Permissions](#permissions) required:** Permission to access Jira, however,
1118
- * the user can only favorite:
1119
- *
1120
- * * filters owned by the user.
1121
- * * filters shared with a group that the user is a member of.
1122
- * * filters shared with a private project that the user has *Browse projects*
1123
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1124
- * * filters shared with a public project.
1125
- * * filters shared with the public.
1126
- *
1127
- * @returns Returned if the request is successful.
1128
- *
1129
- * example: {
1130
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
1131
- * "description": "Lists all open bugs",
1132
- * "favourite": true,
1133
- * "favouritedCount": 0,
1134
- * "id": "10000",
1135
- * "jql": "type = Bug and resolution is empty",
1136
- * "name": "All Open Bugs",
1137
- * "owner": {
1138
- * "accountId": "5b10a2844c20165700ede21g",
1139
- * "accountType": "atlassian",
1140
- * "active": false,
1141
- * "avatarUrls": {
1142
- * "16x16":
1143
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1144
- * "24x24":
1145
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1146
- * "32x32":
1147
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1148
- * "48x48":
1149
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1150
- * },
1151
- * "displayName": "Mia Krystof",
1152
- * "key": "",
1153
- * "name": "",
1154
- * "self":
1155
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1156
- * },
1157
- * "searchUrl":
1158
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
1159
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
1160
- * "sharePermissions": [],
1161
- * "subscriptions": {
1162
- * "end-index": 0,
1163
- * "items": [],
1164
- * "max-results": 0,
1165
- * "size": 0,
1166
- * "start-index": 0
1167
- * },
1168
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
1169
- * }
1170
- * @path {PUT} /rest/api/3/filter/{id}/favourite
1171
- * @scopes-current write:jira-work
1172
- * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
1173
- * read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira,
1174
- * read:avatar:jira, read:issue-type-hierarchy:jira
1175
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-put
1176
- */
1177
- setFavouriteForFilter({ id, expand, }) {
1178
- return this.getClientInstance()
1179
- .request({
1180
- path: "/rest/api/3/filter/{id}/favourite",
1181
- method: "PUT",
1182
- pathParams: {
1183
- id,
1184
- },
1185
- query: {
1186
- expand,
1187
- },
1188
- })
1189
- .then(this.getClientInstance().responseHandler({
1190
- 200: {
1191
- "application/json": "json",
1192
- },
1193
- }))
1194
- .then(commonHttpClient.castResponse())
1195
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.setFavouriteForFilter.response"))
1196
- .then(commonHttpClient.getBody);
1197
- }
1198
- /**
1199
- * Updates a filter. Use this operation to update a filter's name, description,
1200
- * JQL, or sharing.
1201
- *
1202
- * **[Permissions](#permissions) required:** Permission to access Jira, however
1203
- * the user must own the filter.
1204
- *
1205
- * @returns Returned if the request is successful.
1206
- *
1207
- * example: {
1208
- * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
1209
- * "description": "Lists all open bugs",
1210
- * "favourite": true,
1211
- * "favouritedCount": 0,
1212
- * "id": "10000",
1213
- * "jql": "type = Bug and resolution is empty",
1214
- * "name": "All Open Bugs",
1215
- * "owner": {
1216
- * "accountId": "5b10a2844c20165700ede21g",
1217
- * "accountType": "atlassian",
1218
- * "active": false,
1219
- * "avatarUrls": {
1220
- * "16x16":
1221
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1222
- * "24x24":
1223
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1224
- * "32x32":
1225
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1226
- * "48x48":
1227
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1228
- * },
1229
- * "displayName": "Mia Krystof",
1230
- * "key": "",
1231
- * "name": "",
1232
- * "self":
1233
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1234
- * },
1235
- * "searchUrl":
1236
- * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
1237
- * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
1238
- * "sharePermissions": [],
1239
- * "subscriptions": {
1240
- * "end-index": 0,
1241
- * "items": [],
1242
- * "max-results": 0,
1243
- * "size": 0,
1244
- * "start-index": 0
1245
- * },
1246
- * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
1247
- * }
1248
- * @path {PUT} /rest/api/3/filter/{id}
1249
- * @scopes-current write:jira-work
1250
- * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira,
1251
- * read:project-role:jira, read:user:jira, read:jql:jira,
1252
- * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
1253
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-put
1254
- */
1255
- updateFilter({ id, expand, overrideSharePermissions, filter, }) {
1256
- return this.getClientInstance()
1257
- .request({
1258
- path: "/rest/api/3/filter/{id}",
1259
- method: "PUT",
1260
- pathParams: {
1261
- id,
1262
- },
1263
- query: {
1264
- expand,
1265
- overrideSharePermissions,
1266
- },
1267
- headers: {
1268
- "Content-Type": "application/json",
1269
- },
1270
- body: filter,
1271
- })
1272
- .then(this.getClientInstance().responseHandler({
1273
- 200: {
1274
- "application/json": "json",
1275
- },
1276
- }))
1277
- .then(commonHttpClient.castResponse())
1278
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.updateFilter.response"))
1279
- .then(commonHttpClient.getBody);
21
+ constructor() {
22
+ super(...arguments);
23
+ /**
24
+ * Changes the owner of the filter.
25
+ *
26
+ * **[Permissions](#permissions) required:** Permission to access Jira. However,
27
+ * the user must own the filter or have the *Administer Jira* [global
28
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
29
+ *
30
+ * @returns Returned if the request is successful.
31
+ * @path {PUT} /rest/api/3/filter/{id}/owner
32
+ * @scopes-beta read:filter:jira, write:filter:jira
33
+ * @scopes-current write:jira-work
34
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-owner-put
35
+ */
36
+ this.changeFilterOwner = ({ id, changeFilterOwner, }) => {
37
+ return this.getClientInstance()
38
+ .request({
39
+ path: "/rest/api/3/filter/{id}/owner",
40
+ method: "PUT",
41
+ pathParams: {
42
+ id,
43
+ },
44
+ headers: {
45
+ "Content-Type": "application/json",
46
+ },
47
+ body: changeFilterOwner,
48
+ })
49
+ .then(this.getClientInstance().responseHandler({
50
+ 204: {
51
+ "application/json": "json",
52
+ },
53
+ }))
54
+ .then(commonHttpClient.castResponse())
55
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.changeFilterOwner.response"))
56
+ .then(commonHttpClient.getBody);
57
+ };
58
+ /**
59
+ * Creates a filter. The filter is shared according to the [default share
60
+ * scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.
61
+ *
62
+ * **[Permissions](#permissions) required:** Permission to access Jira.
63
+ *
64
+ * @returns Returned if the request is successful.
65
+ *
66
+ * example: {
67
+ * "approximateLastUsed": null,
68
+ * "description": "Lists all open bugs",
69
+ * "favourite": true,
70
+ * "favouritedCount": 0,
71
+ * "id": "10000",
72
+ * "jql": "type = Bug and resolution is empty",
73
+ * "name": "All Open Bugs",
74
+ * "owner": {
75
+ * "accountId": "5b10a2844c20165700ede21g",
76
+ * "accountType": "atlassian",
77
+ * "active": false,
78
+ * "avatarUrls": {
79
+ * "16x16":
80
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
81
+ * "24x24":
82
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
83
+ * "32x32":
84
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
85
+ * "48x48":
86
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
87
+ * },
88
+ * "displayName": "Mia Krystof",
89
+ * "key": "",
90
+ * "name": "",
91
+ * "self":
92
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
93
+ * },
94
+ * "searchUrl":
95
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
96
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
97
+ * "sharePermissions": [],
98
+ * "subscriptions": {
99
+ * "end-index": 0,
100
+ * "items": [],
101
+ * "max-results": 0,
102
+ * "size": 0,
103
+ * "start-index": 0
104
+ * },
105
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
106
+ * }
107
+ * @path {POST} /rest/api/3/filter
108
+ * @scopes-current write:jira-work
109
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
110
+ * read:user:jira, write:filter:jira, read:application-role:jira,
111
+ * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
112
+ * read:project-category:jira, read:project-version:jira,
113
+ * read:project.component:jira
114
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-post
115
+ */
116
+ this.createFilter = ({ expand, overrideSharePermissions, filter, }) => {
117
+ return this.getClientInstance()
118
+ .request({
119
+ path: "/rest/api/3/filter",
120
+ method: "POST",
121
+ query: {
122
+ expand,
123
+ overrideSharePermissions,
124
+ },
125
+ headers: {
126
+ "Content-Type": "application/json",
127
+ },
128
+ body: filter,
129
+ })
130
+ .then(this.getClientInstance().responseHandler({
131
+ 200: {
132
+ "application/json": "json",
133
+ },
134
+ }))
135
+ .then(commonHttpClient.castResponse())
136
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.createFilter.response"))
137
+ .then(commonHttpClient.getBody);
138
+ };
139
+ /**
140
+ * Removes a filter as a favorite for the user. Note that this operation only
141
+ * removes filters visible to the user from the user's favorites list. For
142
+ * example, if the user favorites a public filter that is subsequently made
143
+ * private (and is therefore no longer visible on their favorites list) they
144
+ * cannot remove it from their favorites list.
145
+ *
146
+ * **[Permissions](#permissions) required:** Permission to access Jira.
147
+ *
148
+ * @returns Returned if the request is successful.
149
+ *
150
+ * example: {
151
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
152
+ * "description": "Lists all open bugs",
153
+ * "favourite": true,
154
+ * "favouritedCount": 0,
155
+ * "id": "10000",
156
+ * "jql": "type = Bug and resolution is empty",
157
+ * "name": "All Open Bugs",
158
+ * "owner": {
159
+ * "accountId": "5b10a2844c20165700ede21g",
160
+ * "accountType": "atlassian",
161
+ * "active": false,
162
+ * "avatarUrls": {
163
+ * "16x16":
164
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
165
+ * "24x24":
166
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
167
+ * "32x32":
168
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
169
+ * "48x48":
170
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
171
+ * },
172
+ * "displayName": "Mia Krystof",
173
+ * "key": "",
174
+ * "name": "",
175
+ * "self":
176
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
177
+ * },
178
+ * "searchUrl":
179
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
180
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
181
+ * "sharePermissions": [],
182
+ * "subscriptions": {
183
+ * "end-index": 0,
184
+ * "items": [],
185
+ * "max-results": 0,
186
+ * "size": 0,
187
+ * "start-index": 0
188
+ * },
189
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
190
+ * }
191
+ * @path {DELETE} /rest/api/3/filter/{id}/favourite
192
+ * @scopes-current write:jira-work
193
+ * @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira,
194
+ * read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira,
195
+ * read:issue-type:jira, read:project-category:jira, read:project-role:jira,
196
+ * read:project-version:jira, read:project.component:jira, read:project:jira,
197
+ * read:user:jira
198
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-delete
199
+ */
200
+ this.deleteFavouriteForFilter = ({ id, expand, }) => {
201
+ return this.getClientInstance()
202
+ .request({
203
+ path: "/rest/api/3/filter/{id}/favourite",
204
+ method: "DELETE",
205
+ pathParams: {
206
+ id,
207
+ },
208
+ query: {
209
+ expand,
210
+ },
211
+ })
212
+ .then(this.getClientInstance().responseHandler({
213
+ 200: {
214
+ "application/json": "json",
215
+ },
216
+ }))
217
+ .then(commonHttpClient.castResponse())
218
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.deleteFavouriteForFilter.response"))
219
+ .then(commonHttpClient.getBody);
220
+ };
221
+ /**
222
+ * Delete a filter.
223
+ *
224
+ * **[Permissions](#permissions) required:** Permission to access Jira, however
225
+ * filters can only be deleted by the creator of the filter or a user with
226
+ * *Administer Jira* [global
227
+ * permission](https://confluence.atlassian.com/x/x4dKLg).
228
+ *
229
+ * @path {DELETE} /rest/api/3/filter/{id}
230
+ * @scopes-current write:jira-work
231
+ * @scopes-beta delete:filter:jira
232
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-delete
233
+ */
234
+ this.deleteFilter = ({ id, }) => {
235
+ return this.getClientInstance()
236
+ .request({
237
+ path: "/rest/api/3/filter/{id}",
238
+ method: "DELETE",
239
+ pathParams: {
240
+ id,
241
+ },
242
+ })
243
+ .then(commonHttpClient.discardResult);
244
+ };
245
+ /**
246
+ * Returns the columns configured for a filter. The column configuration is used
247
+ * when the filter's results are viewed in *List View* with the *Columns* set to
248
+ * *Filter*.
249
+ *
250
+ * This operation can be accessed anonymously.
251
+ *
252
+ * **[Permissions](#permissions) required:** None, however, column details are
253
+ * only returned for:
254
+ *
255
+ * * filters owned by the user.
256
+ * * filters shared with a group that the user is a member of.
257
+ * * filters shared with a private project that the user has *Browse projects*
258
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
259
+ * * filters shared with a public project.
260
+ * * filters shared with the public.
261
+ *
262
+ * @returns Returned if the request is successful.
263
+ *
264
+ * example: [
265
+ * {
266
+ * "label": "Key",
267
+ * "value": "issuekey"
268
+ * },
269
+ * {
270
+ * "label": "Summary",
271
+ * "value": "summary"
272
+ * }
273
+ * ]
274
+ * @path {GET} /rest/api/3/filter/{id}/columns
275
+ * @scopes-current read:jira-work
276
+ * @scopes-beta read:filter.column:jira
277
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-get
278
+ */
279
+ this.getColumns = ({ id, }) => {
280
+ return this.getClientInstance()
281
+ .request({
282
+ path: "/rest/api/3/filter/{id}/columns",
283
+ method: "GET",
284
+ pathParams: {
285
+ id,
286
+ },
287
+ })
288
+ .then(this.getClientInstance().responseHandler({
289
+ 200: {
290
+ "application/json": "json",
291
+ },
292
+ }))
293
+ .then(commonHttpClient.castResponse())
294
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getColumns.response"))
295
+ .then(commonHttpClient.getBody);
296
+ };
297
+ /**
298
+ * Returns the visible favorite filters of the user.
299
+ *
300
+ * This operation can be accessed anonymously.
301
+ *
302
+ * **[Permissions](#permissions) required:** A favorite filter is only visible to
303
+ * the user where the filter is:
304
+ *
305
+ * * owned by the user.
306
+ * * shared with a group that the user is a member of.
307
+ * * shared with a private project that the user has *Browse projects* [project
308
+ * permission](https://confluence.atlassian.com/x/yodKLg) for.
309
+ * * shared with a public project.
310
+ * * shared with the public.
311
+ *
312
+ * For example, if the user favorites a public filter that is subsequently made
313
+ * private that filter is not returned by this operation.
314
+ *
315
+ * @returns Returned if the request is successful.
316
+ *
317
+ * example: [
318
+ * {
319
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
320
+ * "description": "Lists all open bugs",
321
+ * "favourite": true,
322
+ * "favouritedCount": 0,
323
+ * "id": "10000",
324
+ * "jql": "type = Bug and resolution is empty",
325
+ * "name": "All Open Bugs",
326
+ * "owner": {
327
+ * "accountId": "5b10a2844c20165700ede21g",
328
+ * "accountType": "atlassian",
329
+ * "active": false,
330
+ * "avatarUrls": {
331
+ * "16x16":
332
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
333
+ * "24x24":
334
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
335
+ * "32x32":
336
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
337
+ * "48x48":
338
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
339
+ * },
340
+ * "displayName": "Mia Krystof",
341
+ * "key": "",
342
+ * "name": "",
343
+ * "self":
344
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
345
+ * },
346
+ * "searchUrl":
347
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
348
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
349
+ * "sharePermissions": [],
350
+ * "subscriptions": {
351
+ * "end-index": 0,
352
+ * "items": [],
353
+ * "max-results": 0,
354
+ * "size": 0,
355
+ * "start-index": 0
356
+ * },
357
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
358
+ * },
359
+ * {
360
+ * "approximateLastUsed": null,
361
+ * "description": "Issues assigned to me",
362
+ * "favourite": true,
363
+ * "favouritedCount": 0,
364
+ * "id": "10010",
365
+ * "jql": "assignee = currentUser() and resolution is empty",
366
+ * "name": "My issues",
367
+ * "owner": {
368
+ * "accountId": "5b10a2844c20165700ede21g",
369
+ * "accountType": "atlassian",
370
+ * "active": false,
371
+ * "avatarUrls": {
372
+ * "16x16":
373
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
374
+ * "24x24":
375
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
376
+ * "32x32":
377
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
378
+ * "48x48":
379
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
380
+ * },
381
+ * "displayName": "Mia Krystof",
382
+ * "key": "",
383
+ * "name": "",
384
+ * "self":
385
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
386
+ * },
387
+ * "searchUrl":
388
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
389
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
390
+ * "sharePermissions": [
391
+ * {
392
+ * "id": 10000,
393
+ * "type": "global"
394
+ * },
395
+ * {
396
+ * "id": 10010,
397
+ * "project": {
398
+ * "avatarUrls": {
399
+ * "16x16":
400
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
401
+ * "24x24":
402
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
403
+ * "32x32":
404
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
405
+ * "48x48":
406
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
407
+ * },
408
+ * "id": "10000",
409
+ * "insight": {
410
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
411
+ * "totalIssueCount": 100
412
+ * },
413
+ * "key": "EX",
414
+ * "name": "Example",
415
+ * "projectCategory": {
416
+ * "description": "First Project Category",
417
+ * "id": "10000",
418
+ * "name": "FIRST",
419
+ * "self":
420
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
421
+ * },
422
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
423
+ * "simplified": false,
424
+ * "style": "classic"
425
+ * },
426
+ * "type": "project"
427
+ * }
428
+ * ],
429
+ * "subscriptions": {
430
+ * "end-index": 0,
431
+ * "items": [],
432
+ * "max-results": 0,
433
+ * "size": 0,
434
+ * "start-index": 0
435
+ * },
436
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
437
+ * }
438
+ * ]
439
+ * @path {GET} /rest/api/3/filter/favourite
440
+ * @scopes-current read:jira-work
441
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
442
+ * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
443
+ * read:issue-type-hierarchy:jira
444
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-favourite-get
445
+ */
446
+ this.getFavouriteFilters = ({ expand, } = {}) => {
447
+ return this.getClientInstance()
448
+ .request({
449
+ path: "/rest/api/3/filter/favourite",
450
+ method: "GET",
451
+ query: {
452
+ expand,
453
+ },
454
+ })
455
+ .then(this.getClientInstance().responseHandler({
456
+ 200: {
457
+ "application/json": "json",
458
+ },
459
+ }))
460
+ .then(commonHttpClient.castResponse())
461
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFavouriteFilters.response"))
462
+ .then(commonHttpClient.getBody);
463
+ };
464
+ /**
465
+ * Returns a filter.
466
+ *
467
+ * This operation can be accessed anonymously.
468
+ *
469
+ * **[Permissions](#permissions) required:** None, however, the filter is only
470
+ * returned where it is:
471
+ *
472
+ * * owned by the user.
473
+ * * shared with a group that the user is a member of.
474
+ * * shared with a private project that the user has *Browse projects* [project
475
+ * permission](https://confluence.atlassian.com/x/yodKLg) for.
476
+ * * shared with a public project.
477
+ * * shared with the public.
478
+ *
479
+ * @returns Returned if the request is successful.
480
+ *
481
+ * example: {
482
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
483
+ * "description": "Lists all open bugs",
484
+ * "favourite": true,
485
+ * "favouritedCount": 0,
486
+ * "id": "10000",
487
+ * "jql": "type = Bug and resolution is empty",
488
+ * "name": "All Open Bugs",
489
+ * "owner": {
490
+ * "accountId": "5b10a2844c20165700ede21g",
491
+ * "accountType": "atlassian",
492
+ * "active": false,
493
+ * "avatarUrls": {
494
+ * "16x16":
495
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
496
+ * "24x24":
497
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
498
+ * "32x32":
499
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
500
+ * "48x48":
501
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
502
+ * },
503
+ * "displayName": "Mia Krystof",
504
+ * "key": "",
505
+ * "name": "",
506
+ * "self":
507
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
508
+ * },
509
+ * "searchUrl":
510
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
511
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
512
+ * "sharePermissions": [],
513
+ * "subscriptions": {
514
+ * "end-index": 0,
515
+ * "items": [],
516
+ * "max-results": 0,
517
+ * "size": 0,
518
+ * "start-index": 0
519
+ * },
520
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
521
+ * }
522
+ * @path {GET} /rest/api/3/filter/{id}
523
+ * @scopes-current read:jira-work
524
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
525
+ * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
526
+ * read:issue-type-hierarchy:jira
527
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-get
528
+ */
529
+ this.getFilter = ({ id, expand, overrideSharePermissions, }) => {
530
+ return this.getClientInstance()
531
+ .request({
532
+ path: "/rest/api/3/filter/{id}",
533
+ method: "GET",
534
+ pathParams: {
535
+ id,
536
+ },
537
+ query: {
538
+ expand,
539
+ overrideSharePermissions,
540
+ },
541
+ })
542
+ .then(this.getClientInstance().responseHandler({
543
+ 200: {
544
+ "application/json": "json",
545
+ },
546
+ }))
547
+ .then(commonHttpClient.castResponse())
548
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFilter.response"))
549
+ .then(commonHttpClient.getBody);
550
+ };
551
+ /**
552
+ * Returns a [paginated](#pagination) list of filters. Use this operation to get:
553
+ *
554
+ * * specific filters, by defining `id` only.
555
+ * * filters that match all of the specified attributes. For example, all
556
+ * filters for a user with a particular word in their name. When multiple
557
+ * attributes are specified only filters matching all attributes are returned.
558
+ *
559
+ * This operation can be accessed anonymously.
560
+ *
561
+ * **[Permissions](#permissions) required:** None, however, only the following
562
+ * filters that match the query parameters are returned:
563
+ *
564
+ * * filters owned by the user.
565
+ * * filters shared with a group that the user is a member of.
566
+ * * filters shared with a private project that the user has *Browse projects*
567
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
568
+ * * filters shared with a public project.
569
+ * * filters shared with the public.
570
+ *
571
+ * @returns Returned if the request is successful.
572
+ *
573
+ * example: {
574
+ * "isLast": true,
575
+ * "maxResults": 100,
576
+ * "self":
577
+ * "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
578
+ * "startAt": 0,
579
+ * "total": 2,
580
+ * "values": [
581
+ * {
582
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
583
+ * "description": "Lists all open bugs",
584
+ * "editPermissions": [],
585
+ * "expand":
586
+ * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
587
+ * "favourite": false,
588
+ * "favouritedCount": 0,
589
+ * "id": "10000",
590
+ * "jql": "type = Bug and resolution is empty",
591
+ * "name": "All Open Bugs",
592
+ * "owner": {
593
+ * "accountId": "5b10a2844c20165700ede21g",
594
+ * "accountType": "atlassian",
595
+ * "active": false,
596
+ * "avatarUrls": {
597
+ * "16x16":
598
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
599
+ * "24x24":
600
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
601
+ * "32x32":
602
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
603
+ * "48x48":
604
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
605
+ * },
606
+ * "displayName": "Mia Krystof",
607
+ * "key": "",
608
+ * "name": "",
609
+ * "self":
610
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
611
+ * },
612
+ * "searchUrl":
613
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
614
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
615
+ * "sharePermissions": [],
616
+ * "subscriptions": [],
617
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
618
+ * },
619
+ * {
620
+ * "approximateLastUsed": null,
621
+ * "description": "Issues assigned to me",
622
+ * "editPermissions": [
623
+ * {
624
+ * "id": 10010,
625
+ * "project": {
626
+ * "avatarUrls": {
627
+ * "16x16":
628
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
629
+ * "24x24":
630
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
631
+ * "32x32":
632
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
633
+ * "48x48":
634
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
635
+ * },
636
+ * "deleted": true,
637
+ * "deletedBy": {
638
+ * "accountId": "5b10a2844c20165700ede21g",
639
+ * "accountType": "atlassian",
640
+ * "active": false,
641
+ * "avatarUrls": {
642
+ * "16x16":
643
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
644
+ * "24x24":
645
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
646
+ * "32x32":
647
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
648
+ * "48x48":
649
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
650
+ * },
651
+ * "displayName": "Mia Krystof",
652
+ * "key": "",
653
+ * "name": "",
654
+ * "self":
655
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
656
+ * },
657
+ * "deletedDate": "2022-11-11T13:35:29.000+0000",
658
+ * "id": "10002",
659
+ * "insight": {
660
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
661
+ * "totalIssueCount": 100
662
+ * },
663
+ * "key": "MKY",
664
+ * "name": "Example",
665
+ * "projectCategory": {
666
+ * "description": "First Project Category",
667
+ * "id": "10000",
668
+ * "name": "FIRST",
669
+ * "self":
670
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
671
+ * },
672
+ * "retentionTillDate": "2023-01-10T13:35:29.000+0000",
673
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
674
+ * "simplified": false,
675
+ * "style": "classic"
676
+ * },
677
+ * "role": {
678
+ * "self":
679
+ * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
680
+ * "name": "Developers",
681
+ * "id": 10360,
682
+ * "description": "A project role that represents developers in a
683
+ * project",
684
+ * "actors": [
685
+ * {
686
+ * "actorGroup": {
687
+ * "name": "jira-developers",
688
+ * "displayName": "jira-developers",
689
+ * "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
690
+ * },
691
+ * "displayName": "jira-developers",
692
+ * "id": 10240,
693
+ * "name": "jira-developers",
694
+ * "type": "atlassian-group-role-actor"
695
+ * },
696
+ * {
697
+ * "actorUser": {
698
+ * "accountId": "5b10a2844c20165700ede21g"
699
+ * },
700
+ * "displayName": "Mia Krystof",
701
+ * "id": 10241,
702
+ * "type": "atlassian-user-role-actor"
703
+ * }
704
+ * ],
705
+ * "scope": {
706
+ * "project": {
707
+ * "id": "10000",
708
+ * "key": "KEY",
709
+ * "name": "Next Gen Project"
710
+ * },
711
+ * "type": "PROJECT"
712
+ * }
713
+ * },
714
+ * "type": "project"
715
+ * },
716
+ * {
717
+ * "group": {
718
+ * "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
719
+ * "name": "jira-administrators",
720
+ * "self":
721
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
722
+ * },
723
+ * "id": 10010,
724
+ * "type": "group"
725
+ * }
726
+ * ],
727
+ * "expand":
728
+ * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
729
+ * "favourite": true,
730
+ * "favouritedCount": 123,
731
+ * "id": "10010",
732
+ * "jql": "assignee = currentUser() and resolution is empty",
733
+ * "name": "My issues",
734
+ * "owner": {
735
+ * "accountId": "5b10a2844c20165700ede21g",
736
+ * "accountType": "atlassian",
737
+ * "active": false,
738
+ * "avatarUrls": {
739
+ * "16x16":
740
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
741
+ * "24x24":
742
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
743
+ * "32x32":
744
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
745
+ * "48x48":
746
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
747
+ * },
748
+ * "displayName": "Mia Krystof",
749
+ * "key": "",
750
+ * "name": "",
751
+ * "self":
752
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
753
+ * },
754
+ * "searchUrl":
755
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
756
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
757
+ * "sharePermissions": [
758
+ * {
759
+ * "id": 10000,
760
+ * "type": "global"
761
+ * },
762
+ * {
763
+ * "id": 10010,
764
+ * "project": {
765
+ * "avatarUrls": {
766
+ * "16x16":
767
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
768
+ * "24x24":
769
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
770
+ * "32x32":
771
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
772
+ * "48x48":
773
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
774
+ * },
775
+ * "id": "10000",
776
+ * "insight": {
777
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
778
+ * "totalIssueCount": 100
779
+ * },
780
+ * "key": "EX",
781
+ * "name": "Example",
782
+ * "projectCategory": {
783
+ * "description": "First Project Category",
784
+ * "id": "10000",
785
+ * "name": "FIRST",
786
+ * "self":
787
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
788
+ * },
789
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
790
+ * "simplified": false,
791
+ * "style": "classic"
792
+ * },
793
+ * "type": "project"
794
+ * }
795
+ * ],
796
+ * "subscriptions": [
797
+ * {
798
+ * "id": 1,
799
+ * "user": {
800
+ * "accountId": "5b10a2844c20165700ede21g",
801
+ * "accountType": "atlassian",
802
+ * "active": true,
803
+ * "applicationRoles": {
804
+ * "items": [],
805
+ * "size": 1
806
+ * },
807
+ * "avatarUrls": {
808
+ * "16x16":
809
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
810
+ * "24x24":
811
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
812
+ * "32x32":
813
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
814
+ * "48x48":
815
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
816
+ * },
817
+ * "displayName": "Mia Krystof",
818
+ * "emailAddress": "mia@example.com",
819
+ * "groups": {
820
+ * "items": [],
821
+ * "size": 3
822
+ * },
823
+ * "key": "",
824
+ * "name": "",
825
+ * "self":
826
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
827
+ * "timeZone": "Australia/Sydney"
828
+ * }
829
+ * }
830
+ * ],
831
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
832
+ * }
833
+ * ]
834
+ * }
835
+ * @path {GET} /rest/api/3/filter/search
836
+ * @scopes-current read:jira-work
837
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
838
+ * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
839
+ * read:issue-type-hierarchy:jira
840
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-search-get
841
+ */
842
+ this.getFiltersPaginated = ({ filterName, accountId, owner, groupname, groupId, projectId, id, orderBy, startAt, maxResults, expand, overrideSharePermissions, } = {}) => {
843
+ return this.getClientInstance()
844
+ .request({
845
+ path: "/rest/api/3/filter/search",
846
+ method: "GET",
847
+ query: {
848
+ filterName,
849
+ accountId,
850
+ owner,
851
+ groupname,
852
+ groupId,
853
+ projectId,
854
+ id,
855
+ orderBy,
856
+ startAt,
857
+ maxResults,
858
+ expand,
859
+ overrideSharePermissions,
860
+ },
861
+ })
862
+ .then(this.getClientInstance().responseHandler({
863
+ 200: {
864
+ "application/json": "json",
865
+ },
866
+ }))
867
+ .then(commonHttpClient.castResponse())
868
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getFiltersPaginated.response"))
869
+ .then(commonHttpClient.getBody);
870
+ };
871
+ /**
872
+ * Returns the filters owned by the user. If `includeFavourites` is `true`, the
873
+ * user's visible favorite filters are also returned.
874
+ *
875
+ * **[Permissions](#permissions) required:** Permission to access Jira, however, a
876
+ * favorite filters is only visible to the user where the filter is:
877
+ *
878
+ * * owned by the user.
879
+ * * shared with a group that the user is a member of.
880
+ * * shared with a private project that the user has *Browse projects* [project
881
+ * permission](https://confluence.atlassian.com/x/yodKLg) for.
882
+ * * shared with a public project.
883
+ * * shared with the public.
884
+ *
885
+ * For example, if the user favorites a public filter that is subsequently made
886
+ * private that filter is not returned by this operation.
887
+ *
888
+ * @returns Returned if the request is successful.
889
+ *
890
+ * example: [
891
+ * {
892
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
893
+ * "description": "Lists all open bugs",
894
+ * "favourite": true,
895
+ * "favouritedCount": 0,
896
+ * "id": "10000",
897
+ * "jql": "type = Bug and resolution is empty",
898
+ * "name": "All Open Bugs",
899
+ * "owner": {
900
+ * "accountId": "5b10a2844c20165700ede21g",
901
+ * "accountType": "atlassian",
902
+ * "active": false,
903
+ * "avatarUrls": {
904
+ * "16x16":
905
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
906
+ * "24x24":
907
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
908
+ * "32x32":
909
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
910
+ * "48x48":
911
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
912
+ * },
913
+ * "displayName": "Mia Krystof",
914
+ * "key": "",
915
+ * "name": "",
916
+ * "self":
917
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
918
+ * },
919
+ * "searchUrl":
920
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
921
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
922
+ * "sharePermissions": [],
923
+ * "subscriptions": {
924
+ * "end-index": 0,
925
+ * "items": [],
926
+ * "max-results": 0,
927
+ * "size": 0,
928
+ * "start-index": 0
929
+ * },
930
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
931
+ * },
932
+ * {
933
+ * "approximateLastUsed": null,
934
+ * "description": "Issues assigned to me",
935
+ * "favourite": true,
936
+ * "favouritedCount": 0,
937
+ * "id": "10010",
938
+ * "jql": "assignee = currentUser() and resolution is empty",
939
+ * "name": "My issues",
940
+ * "owner": {
941
+ * "accountId": "5b10a2844c20165700ede21g",
942
+ * "accountType": "atlassian",
943
+ * "active": false,
944
+ * "avatarUrls": {
945
+ * "16x16":
946
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
947
+ * "24x24":
948
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
949
+ * "32x32":
950
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
951
+ * "48x48":
952
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
953
+ * },
954
+ * "displayName": "Mia Krystof",
955
+ * "key": "",
956
+ * "name": "",
957
+ * "self":
958
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
959
+ * },
960
+ * "searchUrl":
961
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
962
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
963
+ * "sharePermissions": [
964
+ * {
965
+ * "id": 10000,
966
+ * "type": "global"
967
+ * },
968
+ * {
969
+ * "id": 10010,
970
+ * "project": {
971
+ * "avatarUrls": {
972
+ * "16x16":
973
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
974
+ * "24x24":
975
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
976
+ * "32x32":
977
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
978
+ * "48x48":
979
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
980
+ * },
981
+ * "id": "10000",
982
+ * "insight": {
983
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
984
+ * "totalIssueCount": 100
985
+ * },
986
+ * "key": "EX",
987
+ * "name": "Example",
988
+ * "projectCategory": {
989
+ * "description": "First Project Category",
990
+ * "id": "10000",
991
+ * "name": "FIRST",
992
+ * "self":
993
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
994
+ * },
995
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
996
+ * "simplified": false,
997
+ * "style": "classic"
998
+ * },
999
+ * "type": "project"
1000
+ * }
1001
+ * ],
1002
+ * "subscriptions": {
1003
+ * "end-index": 0,
1004
+ * "items": [],
1005
+ * "max-results": 0,
1006
+ * "size": 0,
1007
+ * "start-index": 0
1008
+ * },
1009
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
1010
+ * }
1011
+ * ]
1012
+ * @path {GET} /rest/api/3/filter/my
1013
+ * @scopes-current read:jira-work
1014
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
1015
+ * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
1016
+ * read:issue-type-hierarchy:jira
1017
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-my-get
1018
+ */
1019
+ this.getMyFilters = ({ expand, includeFavourites, } = {}) => {
1020
+ return this.getClientInstance()
1021
+ .request({
1022
+ path: "/rest/api/3/filter/my",
1023
+ method: "GET",
1024
+ query: {
1025
+ expand,
1026
+ includeFavourites,
1027
+ },
1028
+ })
1029
+ .then(this.getClientInstance().responseHandler({
1030
+ 200: {
1031
+ "application/json": "json",
1032
+ },
1033
+ }))
1034
+ .then(commonHttpClient.castResponse())
1035
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.getMyFilters.response"))
1036
+ .then(commonHttpClient.getBody);
1037
+ };
1038
+ /**
1039
+ * Reset the user's column configuration for the filter to the default.
1040
+ *
1041
+ * **[Permissions](#permissions) required:** Permission to access Jira, however,
1042
+ * columns are only reset for:
1043
+ *
1044
+ * * filters owned by the user.
1045
+ * * filters shared with a group that the user is a member of.
1046
+ * * filters shared with a private project that the user has *Browse projects*
1047
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1048
+ * * filters shared with a public project.
1049
+ * * filters shared with the public.
1050
+ *
1051
+ * @path {DELETE} /rest/api/3/filter/{id}/columns
1052
+ * @scopes-beta delete:filter.column:jira
1053
+ * @scopes-current write:jira-work
1054
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-delete
1055
+ */
1056
+ this.resetColumns = ({ id, }) => {
1057
+ return this.getClientInstance()
1058
+ .request({
1059
+ path: "/rest/api/3/filter/{id}/columns",
1060
+ method: "DELETE",
1061
+ pathParams: {
1062
+ id,
1063
+ },
1064
+ })
1065
+ .then(commonHttpClient.discardResult);
1066
+ };
1067
+ /**
1068
+ * Sets the columns for a filter. Only navigable fields can be set as columns. Use
1069
+ * [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A
1070
+ * navigable field has `navigable` set to `true`.
1071
+ *
1072
+ * The parameters for this resource are expressed as HTML form data. For example,
1073
+ * in curl:
1074
+ *
1075
+ * `curl -X PUT -d columns=summary -d columns=description
1076
+ * https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`
1077
+ *
1078
+ * **[Permissions](#permissions) required:** Permission to access Jira, however,
1079
+ * columns are only set for:
1080
+ *
1081
+ * * filters owned by the user.
1082
+ * * filters shared with a group that the user is a member of.
1083
+ * * filters shared with a private project that the user has *Browse projects*
1084
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1085
+ * * filters shared with a public project.
1086
+ * * filters shared with the public.
1087
+ *
1088
+ * @returns Returned if the request is successful.
1089
+ * @path {PUT} /rest/api/3/filter/{id}/columns
1090
+ * @scopes-current write:jira-work
1091
+ * @scopes-beta write:filter.column:jira
1092
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-put
1093
+ */
1094
+ this.setColumns = ({ id, mediaType = "application/json", columnRequestBody, }) => {
1095
+ return this.getClientInstance()
1096
+ .request({
1097
+ path: "/rest/api/3/filter/{id}/columns",
1098
+ method: "PUT",
1099
+ pathParams: {
1100
+ id,
1101
+ },
1102
+ headers: {
1103
+ "Content-Type": mediaType,
1104
+ },
1105
+ body: columnRequestBody,
1106
+ })
1107
+ .then(this.getClientInstance().responseHandler({
1108
+ 200: {
1109
+ "application/json": "json",
1110
+ },
1111
+ }))
1112
+ .then(commonHttpClient.castResponse())
1113
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.setColumns.response"))
1114
+ .then(commonHttpClient.getBody);
1115
+ };
1116
+ /**
1117
+ * Add a filter as a favorite for the user.
1118
+ *
1119
+ * **[Permissions](#permissions) required:** Permission to access Jira, however,
1120
+ * the user can only favorite:
1121
+ *
1122
+ * * filters owned by the user.
1123
+ * * filters shared with a group that the user is a member of.
1124
+ * * filters shared with a private project that the user has *Browse projects*
1125
+ * [project permission](https://confluence.atlassian.com/x/yodKLg) for.
1126
+ * * filters shared with a public project.
1127
+ * * filters shared with the public.
1128
+ *
1129
+ * @returns Returned if the request is successful.
1130
+ *
1131
+ * example: {
1132
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
1133
+ * "description": "Lists all open bugs",
1134
+ * "favourite": true,
1135
+ * "favouritedCount": 0,
1136
+ * "id": "10000",
1137
+ * "jql": "type = Bug and resolution is empty",
1138
+ * "name": "All Open Bugs",
1139
+ * "owner": {
1140
+ * "accountId": "5b10a2844c20165700ede21g",
1141
+ * "accountType": "atlassian",
1142
+ * "active": false,
1143
+ * "avatarUrls": {
1144
+ * "16x16":
1145
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1146
+ * "24x24":
1147
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1148
+ * "32x32":
1149
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1150
+ * "48x48":
1151
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1152
+ * },
1153
+ * "displayName": "Mia Krystof",
1154
+ * "key": "",
1155
+ * "name": "",
1156
+ * "self":
1157
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1158
+ * },
1159
+ * "searchUrl":
1160
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
1161
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
1162
+ * "sharePermissions": [],
1163
+ * "subscriptions": {
1164
+ * "end-index": 0,
1165
+ * "items": [],
1166
+ * "max-results": 0,
1167
+ * "size": 0,
1168
+ * "start-index": 0
1169
+ * },
1170
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
1171
+ * }
1172
+ * @path {PUT} /rest/api/3/filter/{id}/favourite
1173
+ * @scopes-current write:jira-work
1174
+ * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
1175
+ * read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira,
1176
+ * read:avatar:jira, read:issue-type-hierarchy:jira
1177
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-put
1178
+ */
1179
+ this.setFavouriteForFilter = ({ id, expand, }) => {
1180
+ return this.getClientInstance()
1181
+ .request({
1182
+ path: "/rest/api/3/filter/{id}/favourite",
1183
+ method: "PUT",
1184
+ pathParams: {
1185
+ id,
1186
+ },
1187
+ query: {
1188
+ expand,
1189
+ },
1190
+ })
1191
+ .then(this.getClientInstance().responseHandler({
1192
+ 200: {
1193
+ "application/json": "json",
1194
+ },
1195
+ }))
1196
+ .then(commonHttpClient.castResponse())
1197
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.setFavouriteForFilter.response"))
1198
+ .then(commonHttpClient.getBody);
1199
+ };
1200
+ /**
1201
+ * Updates a filter. Use this operation to update a filter's name, description,
1202
+ * JQL, or sharing.
1203
+ *
1204
+ * **[Permissions](#permissions) required:** Permission to access Jira, however
1205
+ * the user must own the filter.
1206
+ *
1207
+ * @returns Returned if the request is successful.
1208
+ *
1209
+ * example: {
1210
+ * "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
1211
+ * "description": "Lists all open bugs",
1212
+ * "favourite": true,
1213
+ * "favouritedCount": 0,
1214
+ * "id": "10000",
1215
+ * "jql": "type = Bug and resolution is empty",
1216
+ * "name": "All Open Bugs",
1217
+ * "owner": {
1218
+ * "accountId": "5b10a2844c20165700ede21g",
1219
+ * "accountType": "atlassian",
1220
+ * "active": false,
1221
+ * "avatarUrls": {
1222
+ * "16x16":
1223
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
1224
+ * "24x24":
1225
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
1226
+ * "32x32":
1227
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
1228
+ * "48x48":
1229
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
1230
+ * },
1231
+ * "displayName": "Mia Krystof",
1232
+ * "key": "",
1233
+ * "name": "",
1234
+ * "self":
1235
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1236
+ * },
1237
+ * "searchUrl":
1238
+ * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
1239
+ * "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
1240
+ * "sharePermissions": [],
1241
+ * "subscriptions": {
1242
+ * "end-index": 0,
1243
+ * "items": [],
1244
+ * "max-results": 0,
1245
+ * "size": 0,
1246
+ * "start-index": 0
1247
+ * },
1248
+ * "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
1249
+ * }
1250
+ * @path {PUT} /rest/api/3/filter/{id}
1251
+ * @scopes-current write:jira-work
1252
+ * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira,
1253
+ * read:project-role:jira, read:user:jira, read:jql:jira,
1254
+ * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
1255
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-put
1256
+ */
1257
+ this.updateFilter = ({ id, expand, overrideSharePermissions, filter, }) => {
1258
+ return this.getClientInstance()
1259
+ .request({
1260
+ path: "/rest/api/3/filter/{id}",
1261
+ method: "PUT",
1262
+ pathParams: {
1263
+ id,
1264
+ },
1265
+ query: {
1266
+ expand,
1267
+ overrideSharePermissions,
1268
+ },
1269
+ headers: {
1270
+ "Content-Type": "application/json",
1271
+ },
1272
+ body: filter,
1273
+ })
1274
+ .then(this.getClientInstance().responseHandler({
1275
+ 200: {
1276
+ "application/json": "json",
1277
+ },
1278
+ }))
1279
+ .then(commonHttpClient.castResponse())
1280
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("FiltersService.updateFilter.response"))
1281
+ .then(commonHttpClient.getBody);
1282
+ };
1280
1283
  }
1281
1284
  static initialize() {
1282
1285
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("FiltersService.createFilter.response", zod_1.z