@resolution/jira-api-client 0.4.2 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (327) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +4 -0
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +28 -4
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +24 -1
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/models/common.d.ts +6 -0
  7. package/lib/openapi/platform/models/common.js +12 -1
  8. package/lib/openapi/platform/models/common.js.map +1 -1
  9. package/lib/openapi/platform/models/dynamicModules.d.ts +0 -9
  10. package/lib/openapi/platform/models/dynamicModules.js +0 -6
  11. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  12. package/lib/openapi/platform/models/issueBulkOperations.d.ts +547 -0
  13. package/lib/openapi/platform/models/issueBulkOperations.js +437 -0
  14. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -0
  15. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +3 -3
  16. package/lib/openapi/platform/services/AnnouncementBannerService.js +65 -62
  17. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  18. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +4 -4
  19. package/lib/openapi/platform/services/AppDataPoliciesService.js +70 -67
  20. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  21. package/lib/openapi/platform/services/AppMigrationService.d.ts +6 -6
  22. package/lib/openapi/platform/services/AppMigrationService.js +139 -136
  23. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  24. package/lib/openapi/platform/services/AppPropertiesService.d.ts +12 -12
  25. package/lib/openapi/platform/services/AppPropertiesService.js +254 -251
  26. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  27. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +3 -3
  28. package/lib/openapi/platform/services/ApplicationRolesService.js +177 -174
  29. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  30. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -7
  31. package/lib/openapi/platform/services/AuditRecordsService.js +97 -94
  32. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  33. package/lib/openapi/platform/services/AvatarsService.d.ts +25 -31
  34. package/lib/openapi/platform/services/AvatarsService.js +412 -415
  35. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  36. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +4 -4
  37. package/lib/openapi/platform/services/ClassificationLevelsService.js +79 -76
  38. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  39. package/lib/openapi/platform/services/DashboardsService.d.ts +62 -50
  40. package/lib/openapi/platform/services/DashboardsService.js +983 -974
  41. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  42. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -6
  43. package/lib/openapi/platform/services/DynamicModulesService.js +68 -65
  44. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  45. package/lib/openapi/platform/services/FilterSharingService.d.ts +11 -11
  46. package/lib/openapi/platform/services/FilterSharingService.js +512 -509
  47. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  48. package/lib/openapi/platform/services/FiltersService.d.ts +50 -50
  49. package/lib/openapi/platform/services/FiltersService.js +1262 -1259
  50. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  51. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +10 -10
  52. package/lib/openapi/platform/services/GroupAndUserPickerService.js +112 -109
  53. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  54. package/lib/openapi/platform/services/GroupsService.d.ts +46 -46
  55. package/lib/openapi/platform/services/GroupsService.js +385 -382
  56. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  57. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +20 -20
  58. package/lib/openapi/platform/services/IssueAttachmentsService.js +644 -641
  59. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +325 -0
  61. package/lib/openapi/platform/services/IssueBulkOperationsService.js +353 -0
  62. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -0
  63. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +8 -8
  64. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +187 -184
  65. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  66. package/lib/openapi/platform/services/IssueCommentsService.d.ts +22 -22
  67. package/lib/openapi/platform/services/IssueCommentsService.js +507 -504
  68. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -11
  70. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +126 -123
  71. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +42 -42
  73. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +748 -745
  74. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +28 -28
  76. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +535 -532
  77. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +20 -20
  79. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +358 -355
  80. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +6 -6
  82. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +86 -83
  83. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +45 -45
  85. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +689 -686
  86. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueFieldsService.d.ts +32 -32
  88. package/lib/openapi/platform/services/IssueFieldsService.js +484 -481
  89. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +9 -9
  91. package/lib/openapi/platform/services/IssueLinkTypesService.js +212 -209
  92. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssueLinksService.d.ts +6 -6
  94. package/lib/openapi/platform/services/IssueLinksService.js +230 -227
  95. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +3 -3
  97. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +72 -69
  98. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +27 -27
  100. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +816 -813
  101. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +22 -22
  103. package/lib/openapi/platform/services/IssuePrioritiesService.js +307 -304
  104. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +16 -16
  106. package/lib/openapi/platform/services/IssuePropertiesService.js +390 -387
  107. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +13 -13
  109. package/lib/openapi/platform/services/IssueRemoteLinksService.js +368 -365
  110. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +19 -19
  112. package/lib/openapi/platform/services/IssueResolutionsService.js +283 -280
  113. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueSearchService.d.ts +24 -24
  115. package/lib/openapi/platform/services/IssueSearchService.js +826 -823
  116. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +8 -8
  118. package/lib/openapi/platform/services/IssueSecurityLevelService.js +137 -134
  119. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +51 -51
  121. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +610 -607
  122. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +8 -8
  124. package/lib/openapi/platform/services/IssueTypePropertiesService.js +175 -172
  125. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +31 -31
  127. package/lib/openapi/platform/services/IssueTypeSchemesService.js +527 -524
  128. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +36 -36
  130. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +508 -505
  131. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueTypesService.d.ts +22 -28
  133. package/lib/openapi/platform/services/IssueTypesService.js +424 -427
  134. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssueVotesService.d.ts +6 -6
  136. package/lib/openapi/platform/services/IssueVotesService.js +148 -145
  137. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  138. package/lib/openapi/platform/services/IssueWatchersService.d.ts +10 -10
  139. package/lib/openapi/platform/services/IssueWatchersService.js +197 -194
  140. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  141. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +8 -8
  142. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +199 -196
  143. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  144. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +44 -44
  145. package/lib/openapi/platform/services/IssueWorklogsService.js +636 -633
  146. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  147. package/lib/openapi/platform/services/IssuesService.d.ts +71 -71
  148. package/lib/openapi/platform/services/IssuesService.js +1856 -1853
  149. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  150. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +6 -6
  151. package/lib/openapi/platform/services/JiraExpressionsService.js +238 -235
  152. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  153. package/lib/openapi/platform/services/JiraSettingsService.d.ts +9 -9
  154. package/lib/openapi/platform/services/JiraSettingsService.js +279 -276
  155. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  156. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +8 -8
  157. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +107 -104
  158. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  159. package/lib/openapi/platform/services/JqlService.d.ts +15 -15
  160. package/lib/openapi/platform/services/JqlService.js +635 -632
  161. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  162. package/lib/openapi/platform/services/LabelsService.d.ts +4 -4
  163. package/lib/openapi/platform/services/LabelsService.js +41 -38
  164. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  165. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  166. package/lib/openapi/platform/services/LicenseMetricsService.js +120 -117
  167. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  168. package/lib/openapi/platform/services/MyselfService.d.ts +14 -14
  169. package/lib/openapi/platform/services/MyselfService.js +321 -318
  170. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  171. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +25 -25
  172. package/lib/openapi/platform/services/PermissionSchemesService.js +548 -545
  173. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  174. package/lib/openapi/platform/services/PermissionsService.d.ts +15 -15
  175. package/lib/openapi/platform/services/PermissionsService.js +235 -232
  176. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  177. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +34 -34
  178. package/lib/openapi/platform/services/PrioritySchemesService.js +571 -568
  179. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  180. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +11 -11
  181. package/lib/openapi/platform/services/ProjectAvatarsService.js +213 -210
  182. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +9 -9
  184. package/lib/openapi/platform/services/ProjectCategoriesService.js +180 -177
  185. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +6 -6
  187. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +125 -122
  188. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +28 -28
  190. package/lib/openapi/platform/services/ProjectComponentsService.js +1009 -1006
  191. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -4
  193. package/lib/openapi/platform/services/ProjectEmailService.js +78 -75
  194. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -4
  196. package/lib/openapi/platform/services/ProjectFeaturesService.js +119 -116
  197. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +8 -8
  199. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +100 -97
  200. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +10 -10
  202. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +199 -196
  203. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +8 -8
  205. package/lib/openapi/platform/services/ProjectPropertiesService.js +172 -169
  206. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +18 -18
  208. package/lib/openapi/platform/services/ProjectRoleActorsService.js +362 -359
  209. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  210. package/lib/openapi/platform/services/ProjectRolesService.d.ts +21 -21
  211. package/lib/openapi/platform/services/ProjectRolesService.js +576 -573
  212. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  213. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -6
  214. package/lib/openapi/platform/services/ProjectTypesService.js +173 -170
  215. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  216. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +40 -40
  217. package/lib/openapi/platform/services/ProjectVersionsService.js +751 -748
  218. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  219. package/lib/openapi/platform/services/ProjectsService.d.ts +49 -49
  220. package/lib/openapi/platform/services/ProjectsService.js +1597 -1594
  221. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  222. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +14 -14
  223. package/lib/openapi/platform/services/ScreenSchemesService.js +177 -174
  224. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  225. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +9 -9
  226. package/lib/openapi/platform/services/ScreenTabFieldsService.js +144 -141
  227. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  228. package/lib/openapi/platform/services/ScreenTabsService.d.ts +17 -17
  229. package/lib/openapi/platform/services/ScreenTabsService.js +229 -226
  230. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  231. package/lib/openapi/platform/services/ScreensService.d.ts +23 -23
  232. package/lib/openapi/platform/services/ScreensService.js +281 -278
  233. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  234. package/lib/openapi/platform/services/ServerInfoService.d.ts +1 -1
  235. package/lib/openapi/platform/services/ServerInfoService.js +51 -48
  236. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  237. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +2 -2
  238. package/lib/openapi/platform/services/ServiceRegistryService.js +30 -27
  239. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  240. package/lib/openapi/platform/services/StatusService.d.ts +17 -17
  241. package/lib/openapi/platform/services/StatusService.js +271 -268
  242. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  243. package/lib/openapi/platform/services/TasksService.d.ts +4 -4
  244. package/lib/openapi/platform/services/TasksService.js +93 -90
  245. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  246. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -7
  247. package/lib/openapi/platform/services/TimeTrackingService.js +190 -187
  248. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  249. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +11 -11
  250. package/lib/openapi/platform/services/UiModificationsAppsService.js +214 -211
  251. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  252. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -20
  253. package/lib/openapi/platform/services/UserPropertiesService.js +196 -193
  254. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  255. package/lib/openapi/platform/services/UserSearchService.d.ts +61 -61
  256. package/lib/openapi/platform/services/UserSearchService.js +709 -706
  257. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  258. package/lib/openapi/platform/services/UsersService.d.ts +51 -51
  259. package/lib/openapi/platform/services/UsersService.js +637 -634
  260. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  261. package/lib/openapi/platform/services/WebhooksService.d.ts +14 -14
  262. package/lib/openapi/platform/services/WebhooksService.js +262 -259
  263. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  264. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +30 -30
  265. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +861 -858
  266. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -4
  268. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +98 -95
  269. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +45 -45
  271. package/lib/openapi/platform/services/WorkflowSchemesService.js +899 -896
  272. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +3 -3
  274. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +82 -79
  275. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  276. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +3 -3
  277. package/lib/openapi/platform/services/WorkflowStatusesService.js +110 -107
  278. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  279. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +14 -14
  280. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +182 -179
  281. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  282. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +13 -13
  283. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +283 -280
  284. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  285. package/lib/openapi/platform/services/WorkflowsService.d.ts +33 -33
  286. package/lib/openapi/platform/services/WorkflowsService.js +2451 -2448
  287. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  288. package/lib/openapi/software/services/BacklogService.d.ts +4 -4
  289. package/lib/openapi/software/services/BacklogService.js +81 -78
  290. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  291. package/lib/openapi/software/services/BoardService.d.ts +124 -124
  292. package/lib/openapi/software/services/BoardService.js +2048 -2045
  293. package/lib/openapi/software/services/BoardService.js.map +1 -1
  294. package/lib/openapi/software/services/BuildsService.d.ts +10 -10
  295. package/lib/openapi/software/services/BuildsService.js +164 -161
  296. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  297. package/lib/openapi/software/services/DeploymentsService.d.ts +12 -12
  298. package/lib/openapi/software/services/DeploymentsService.js +192 -189
  299. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  300. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +8 -8
  301. package/lib/openapi/software/services/DevOpsComponentsService.js +145 -142
  302. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  303. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +16 -16
  304. package/lib/openapi/software/services/DevelopmentInformationService.js +178 -175
  305. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  306. package/lib/openapi/software/services/EpicService.d.ts +26 -26
  307. package/lib/openapi/software/services/EpicService.js +597 -594
  308. package/lib/openapi/software/services/EpicService.js.map +1 -1
  309. package/lib/openapi/software/services/FeatureFlagsService.d.ts +10 -10
  310. package/lib/openapi/software/services/FeatureFlagsService.js +151 -148
  311. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  312. package/lib/openapi/software/services/IssueService.d.ts +13 -13
  313. package/lib/openapi/software/services/IssueService.js +359 -356
  314. package/lib/openapi/software/services/IssueService.js.map +1 -1
  315. package/lib/openapi/software/services/OperationsService.d.ts +24 -24
  316. package/lib/openapi/software/services/OperationsService.js +301 -298
  317. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  318. package/lib/openapi/software/services/RemoteLinksService.d.ts +15 -15
  319. package/lib/openapi/software/services/RemoteLinksService.js +160 -157
  320. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  321. package/lib/openapi/software/services/SecurityInformationService.d.ts +16 -16
  322. package/lib/openapi/software/services/SecurityInformationService.js +262 -259
  323. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  324. package/lib/openapi/software/services/SprintService.d.ts +33 -33
  325. package/lib/openapi/software/services/SprintService.js +594 -591
  326. package/lib/openapi/software/services/SprintService.js.map +1 -1
  327. package/package.json +4 -3
@@ -18,980 +18,989 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
18
18
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards
19
19
  */
20
20
  class DashboardsService extends CommonHttpService_1.CommonHttpService {
21
- /**
22
- * Adds a gadget to a dashboard.
23
- *
24
- * **[Permissions](#permissions) required:** None.
25
- *
26
- * @returns Returned if the request is successful.
27
- *
28
- * example: {
29
- * "id": 10001,
30
- * "moduleKey":
31
- * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
32
- * "color": "blue",
33
- * "position": {
34
- * "row": 0,
35
- * "column": 1
36
- * },
37
- * "title": "Issue statistics"
38
- * }
39
- * @path {POST} /rest/api/3/dashboard/{dashboardId}/gadget
40
- * @scopes-current write:jira-work, read:jira-work
41
- * @scopes-beta write:dashboard:jira, read:dashboard:jira
42
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-post
43
- */
44
- addGadget({ dashboardId, dashboardGadgetSettings, }) {
45
- return this.getClientInstance()
46
- .request({
47
- path: "/rest/api/3/dashboard/{dashboardId}/gadget",
48
- method: "POST",
49
- pathParams: {
50
- dashboardId,
51
- },
52
- headers: {
53
- "Content-Type": "application/json",
54
- },
55
- body: dashboardGadgetSettings,
56
- })
57
- .then(this.getClientInstance().responseHandler({
58
- 200: {
59
- "application/json": "json",
60
- },
61
- }))
62
- .then(commonHttpClient.castResponse())
63
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.addGadget.response"))
64
- .then(commonHttpClient.getBody);
65
- }
66
- /**
67
- * Bulk edit dashboards. Maximum number of dashboards to be edited at the same
68
- * time is 100.
69
- *
70
- * **[Permissions](#permissions) required:** None
71
- *
72
- * The dashboards to be updated must be owned by the user, or the user must be an
73
- * administrator.
74
- *
75
- * @returns Returned if the request is successful.
76
- *
77
- * example: {
78
- * "action": "changePermission",
79
- * "entityErrors": {
80
- * "10002": {
81
- * "errorMessages": [
82
- * "Only owner or editors of the dashboard can change permissions."
83
- * ],
84
- * "errors": {}
85
- * }
86
- * }
87
- * }
88
- * @path {PUT} /rest/api/3/dashboard/bulk/edit
89
- * @scopes-current write:jira-work
90
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
91
- * read:project-role:jira, read:user:jira, write:dashboard:jira,
92
- * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
93
- * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
94
- * read:project.component:jira
95
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-bulk-edit-put
96
- */
97
- bulkEditDashboards({ bulkEditShareableEntityRequest, }) {
98
- return this.getClientInstance()
99
- .request({
100
- path: "/rest/api/3/dashboard/bulk/edit",
101
- method: "PUT",
102
- headers: {
103
- "Content-Type": "application/json",
104
- },
105
- body: bulkEditShareableEntityRequest,
106
- })
107
- .then(this.getClientInstance().responseHandler({
108
- 200: {
109
- "application/json": "json",
110
- },
111
- }))
112
- .then(commonHttpClient.castResponse())
113
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.bulkEditDashboards.response"))
114
- .then(commonHttpClient.getBody);
115
- }
116
- /**
117
- * Copies a dashboard. Any values provided in the `dashboard` parameter replace
118
- * those in the copied dashboard.
119
- *
120
- * **[Permissions](#permissions) required:** None
121
- *
122
- * The dashboard to be copied must be owned by or shared with the user.
123
- *
124
- * @returns Returned if the request is successful.
125
- *
126
- * example: {
127
- * "id": "10000",
128
- * "isFavourite": false,
129
- * "name": "System Dashboard",
130
- * "popularity": 1,
131
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
132
- * "sharePermissions": [
133
- * {
134
- * "type": "global"
135
- * }
136
- * ],
137
- * "view":
138
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
139
- * }
140
- * @path {POST} /rest/api/3/dashboard/{id}/copy
141
- * @scopes-current write:jira-work
142
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
143
- * read:project-role:jira, read:user:jira, write:dashboard:jira,
144
- * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
145
- * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
146
- * read:project.component:jira
147
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-copy-post
148
- */
149
- copyDashboard({ id, dashboardDetails, }) {
150
- return this.getClientInstance()
151
- .request({
152
- path: "/rest/api/3/dashboard/{id}/copy",
153
- method: "POST",
154
- pathParams: {
155
- id,
156
- },
157
- headers: {
158
- "Content-Type": "application/json",
159
- },
160
- body: dashboardDetails,
161
- })
162
- .then(this.getClientInstance().responseHandler({
163
- 200: {
164
- "application/json": "json",
165
- },
166
- }))
167
- .then(commonHttpClient.castResponse())
168
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.copyDashboard.response"))
169
- .then(commonHttpClient.getBody);
170
- }
171
- /**
172
- * Creates a dashboard.
173
- *
174
- * **[Permissions](#permissions) required:** None.
175
- *
176
- * @returns Returned if the request is successful.
177
- *
178
- * example: {
179
- * "id": "10000",
180
- * "isFavourite": false,
181
- * "name": "System Dashboard",
182
- * "popularity": 1,
183
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
184
- * "sharePermissions": [
185
- * {
186
- * "type": "global"
187
- * }
188
- * ],
189
- * "view":
190
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
191
- * }
192
- * @path {POST} /rest/api/3/dashboard
193
- * @scopes-current write:jira-work
194
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
195
- * read:project-role:jira, read:user:jira, write:dashboard:jira,
196
- * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
197
- * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
198
- * read:project.component:jira
199
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-post
200
- */
201
- createDashboard({ dashboardDetails, }) {
202
- return this.getClientInstance()
203
- .request({
204
- path: "/rest/api/3/dashboard",
205
- method: "POST",
206
- headers: {
207
- "Content-Type": "application/json",
208
- },
209
- body: dashboardDetails,
210
- })
211
- .then(this.getClientInstance().responseHandler({
212
- 200: {
213
- "application/json": "json",
214
- },
215
- }))
216
- .then(commonHttpClient.castResponse())
217
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.createDashboard.response"))
218
- .then(commonHttpClient.getBody);
219
- }
220
- /**
221
- * Deletes a dashboard.
222
- *
223
- * **[Permissions](#permissions) required:** None
224
- *
225
- * The dashboard to be deleted must be owned by the user.
226
- *
227
- * @path {DELETE} /rest/api/3/dashboard/{id}
228
- * @scopes-current write:jira-work
229
- * @scopes-beta delete:dashboard:jira
230
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-delete
231
- */
232
- deleteDashboard({ id, }) {
233
- return this.getClientInstance()
234
- .request({
235
- path: "/rest/api/3/dashboard/{id}",
236
- method: "DELETE",
237
- pathParams: {
238
- id,
239
- },
240
- })
241
- .then(commonHttpClient.discardResult);
242
- }
243
- /**
244
- * Deletes a dashboard item property.
245
- *
246
- * This operation can be accessed anonymously.
247
- *
248
- * **[Permissions](#permissions) required:** The user must be the owner of the
249
- * dashboard. Note, users with the *Administer Jira* [global
250
- * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
251
- * the System dashboard.
252
- *
253
- * @returns Returned if the dashboard item property is deleted.
254
- * @path {DELETE}
255
- * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
256
- * @scopes-current write:jira-work
257
- * @scopes-beta delete:dashboard.property:jira
258
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-delete
259
- */
260
- deleteDashboardItemProperty({ dashboardId, itemId, propertyKey, }) {
261
- return this.getClientInstance()
262
- .request({
263
- path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
264
- method: "DELETE",
265
- pathParams: {
266
- dashboardId,
267
- itemId,
268
- propertyKey,
269
- },
270
- })
271
- .then(this.getClientInstance().responseHandler({
272
- 204: {
273
- "application/json": "json",
274
- },
275
- }))
276
- .then(commonHttpClient.castResponse())
277
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.deleteDashboardItemProperty.response"))
278
- .then(commonHttpClient.getBody);
279
- }
280
- /**
281
- * Gets a list of all available gadgets that can be added to all dashboards.
282
- *
283
- * **[Permissions](#permissions) required:** None.
284
- *
285
- * @returns Returned if the request is successful.
286
- *
287
- * example: {
288
- * "gadgets": [
289
- * {
290
- * "moduleKey":
291
- * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
292
- * "title": "Issue statistics"
293
- * },
294
- * {
295
- * "uri":
296
- * "rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml",
297
- * "title": "Activity Stream"
298
- * }
299
- * ]
300
- * }
301
- * @path {GET} /rest/api/3/dashboard/gadgets
302
- * @scopes-current read:jira-work
303
- * @scopes-beta read:dashboard:jira
304
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-gadgets-get
305
- */
306
- getAllAvailableDashboardGadgets() {
307
- return this.getClientInstance()
308
- .request({
309
- path: "/rest/api/3/dashboard/gadgets",
310
- method: "GET",
311
- })
312
- .then(this.getClientInstance().responseHandler({
313
- 200: {
314
- "application/json": "json",
315
- },
316
- }))
317
- .then(commonHttpClient.castResponse())
318
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllAvailableDashboardGadgets.response"))
319
- .then(commonHttpClient.getBody);
320
- }
321
- /**
322
- * Returns a list of dashboards owned by or shared with the user. The list may be
323
- * filtered to include only favorite or owned dashboards.
324
- *
325
- * This operation can be accessed anonymously.
326
- *
327
- * **[Permissions](#permissions) required:** None.
328
- *
329
- * @returns Returned if the request is successful.
330
- *
331
- * example: {
332
- * "dashboards": [
333
- * {
334
- * "id": "10000",
335
- * "isFavourite": false,
336
- * "name": "System Dashboard",
337
- * "popularity": 1,
338
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
339
- * "sharePermissions": [
340
- * {
341
- * "type": "global"
342
- * }
343
- * ],
344
- * "view":
345
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
346
- * },
347
- * {
348
- * "id": "20000",
349
- * "isFavourite": true,
350
- * "name": "Build Engineering",
351
- * "owner": {
352
- * "key": "Mia",
353
- * "self":
354
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
355
- * "name": "mia",
356
- * "displayName": "Mia Krystof",
357
- * "avatarUrls": {
358
- * "16x16":
359
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
360
- * "24x24":
361
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
362
- * "32x32":
363
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
364
- * "48x48":
365
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
366
- * }
367
- * },
368
- * "popularity": 1,
369
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/20000",
370
- * "sharePermissions": [
371
- * {
372
- * "group": {
373
- * "name": "administrators",
374
- * "self":
375
- * "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators"
376
- * },
377
- * "id": 10105,
378
- * "type": "group"
379
- * }
380
- * ],
381
- * "view":
382
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000"
383
- * }
384
- * ],
385
- * "maxResults": 10,
386
- * "next": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10",
387
- * "prev": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0",
388
- * "startAt": 10,
389
- * "total": 143
390
- * }
391
- * @path {GET} /rest/api/3/dashboard
392
- * @scopes-current read:jira-work
393
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
394
- * read:project-role:jira, read:user:jira, read:application-role:jira,
395
- * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
396
- * read:project-category:jira, read:project-version:jira,
397
- * read:project.component:jira
398
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-get
399
- */
400
- getAllDashboards({ filter, startAt, maxResults, } = {}) {
401
- return this.getClientInstance()
402
- .request({
403
- path: "/rest/api/3/dashboard",
404
- method: "GET",
405
- query: {
406
- filter,
407
- startAt,
408
- maxResults,
409
- },
410
- })
411
- .then(this.getClientInstance().responseHandler({
412
- 200: {
413
- "application/json": "json",
414
- },
415
- }))
416
- .then(commonHttpClient.castResponse())
417
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllDashboards.response"))
418
- .then(commonHttpClient.getBody);
419
- }
420
- /**
421
- * Returns a list of dashboard gadgets on a dashboard.
422
- *
423
- * This operation returns:
424
- *
425
- * * Gadgets from a list of IDs, when `id` is set.
426
- * * Gadgets with a module key, when `moduleKey` is set.
427
- * * Gadgets from a list of URIs, when `uri` is set.
428
- * * All gadgets, when no other parameters are set.
429
- *
430
- * This operation can be accessed anonymously.
431
- *
432
- * **[Permissions](#permissions) required:** None.
433
- *
434
- * @returns Returned if the request is successful.
435
- *
436
- * example: {
437
- * "gadgets": [
438
- * {
439
- * "id": 10001,
440
- * "moduleKey":
441
- * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
442
- * "color": "blue",
443
- * "position": {
444
- * "row": 0,
445
- * "column": 0
446
- * },
447
- * "title": "Issue statistics"
448
- * },
449
- * {
450
- * "id": 10002,
451
- * "moduleKey":
452
- * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph",
453
- * "color": "red",
454
- * "position": {
455
- * "row": 1,
456
- * "column": 0
457
- * },
458
- * "title": "Activity stream"
459
- * },
460
- * {
461
- * "id": 10003,
462
- * "moduleKey":
463
- * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
464
- * "color": "yellow",
465
- * "position": {
466
- * "row": 0,
467
- * "column": 1
468
- * },
469
- * "title": "Bubble chart"
470
- * }
471
- * ]
472
- * }
473
- * @path {GET} /rest/api/3/dashboard/{dashboardId}/gadget
474
- * @scopes-current read:jira-work
475
- * @scopes-beta read:dashboard:jira
476
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-get
477
- */
478
- getAllGadgets({ dashboardId, moduleKey, uri, gadgetId, }) {
479
- return this.getClientInstance()
480
- .request({
481
- path: "/rest/api/3/dashboard/{dashboardId}/gadget",
482
- method: "GET",
483
- pathParams: {
484
- dashboardId,
485
- },
486
- query: {
487
- moduleKey,
488
- uri,
489
- gadgetId,
490
- },
491
- })
492
- .then(this.getClientInstance().responseHandler({
493
- 200: {
494
- "application/json": "json",
495
- },
496
- }))
497
- .then(commonHttpClient.castResponse())
498
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllGadgets.response"))
499
- .then(commonHttpClient.getBody);
500
- }
501
- /**
502
- * Returns a dashboard.
503
- *
504
- * This operation can be accessed anonymously.
505
- *
506
- * **[Permissions](#permissions) required:** None.
507
- *
508
- * However, to get a dashboard, the dashboard must be shared with the user or the
509
- * user must own it. Note, users with the *Administer Jira* [global
510
- * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
511
- * the System dashboard. The System dashboard is considered to be shared with all
512
- * other users.
513
- *
514
- * @returns Returned if the request is successful.
515
- *
516
- * example: {
517
- * "id": "10000",
518
- * "isFavourite": false,
519
- * "name": "System Dashboard",
520
- * "popularity": 1,
521
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
522
- * "sharePermissions": [
523
- * {
524
- * "type": "global"
525
- * }
526
- * ],
527
- * "view":
528
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
529
- * }
530
- * @path {GET} /rest/api/3/dashboard/{id}
531
- * @scopes-current read:jira-work
532
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
533
- * read:project-role:jira, read:user:jira, read:application-role:jira,
534
- * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
535
- * read:project-category:jira, read:project-version:jira,
536
- * read:project.component:jira
537
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-get
538
- */
539
- getDashboard({ id, }) {
540
- return this.getClientInstance()
541
- .request({
542
- path: "/rest/api/3/dashboard/{id}",
543
- method: "GET",
544
- pathParams: {
545
- id,
546
- },
547
- })
548
- .then(this.getClientInstance().responseHandler({
549
- 200: {
550
- "application/json": "json",
551
- },
552
- }))
553
- .then(commonHttpClient.castResponse())
554
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboard.response"))
555
- .then(commonHttpClient.getBody);
556
- }
557
- /**
558
- * Returns the key and value of a dashboard item property.
559
- *
560
- * A dashboard item enables an app to add user-specific information to a user
561
- * dashboard. Dashboard items are exposed to users as gadgets that users can add
562
- * to their dashboards. For more information on how users do this, see [Adding and
563
- * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
564
- *
565
- * When an app creates a dashboard item it registers a callback to receive the
566
- * dashboard item ID. The callback fires whenever the item is rendered or, where
567
- * the item is configurable, the user edits the item. The app then uses this
568
- * resource to store the item's content or configuration details. For more
569
- * information on working with dashboard items, see [ Building a dashboard item
570
- * for a JIRA Connect
571
- * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
572
- * and the [Dashboard
573
- * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
574
- * documentation.
575
- *
576
- * There is no resource to set or get dashboard items.
577
- *
578
- * This operation can be accessed anonymously.
579
- *
580
- * **[Permissions](#permissions) required:** The user must be the owner of the
581
- * dashboard or have the dashboard shared with them. Note, users with the
582
- * *Administer Jira* [global
583
- * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
584
- * the System dashboard. The System dashboard is considered to be shared with all
585
- * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
586
- * access is permitted.
587
- *
588
- * @returns Returned if the request is successful.
589
- *
590
- * example: {
591
- * "key": "issue.support",
592
- * "value": {
593
- * "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
594
- * "system.support.time": "1m"
595
- * }
596
- * }
597
- * @path {GET}
598
- * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
599
- * @scopes-current read:jira-work
600
- * @scopes-beta read:dashboard.property:jira
601
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-get
602
- */
603
- getDashboardItemProperty({ dashboardId, itemId, propertyKey, }) {
604
- return this.getClientInstance()
605
- .request({
606
- path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
607
- method: "GET",
608
- pathParams: {
609
- dashboardId,
610
- itemId,
611
- propertyKey,
612
- },
613
- })
614
- .then(this.getClientInstance().responseHandler({
615
- 200: {
616
- "application/json": "json",
617
- },
618
- }))
619
- .then(commonHttpClient.castResponse())
620
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemProperty.response"))
621
- .then(commonHttpClient.getBody);
622
- }
623
- /**
624
- * Returns the keys of all properties for a dashboard item.
625
- *
626
- * This operation can be accessed anonymously.
627
- *
628
- * **[Permissions](#permissions) required:** The user must be the owner of the
629
- * dashboard or have the dashboard shared with them. Note, users with the
630
- * *Administer Jira* [global
631
- * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
632
- * the System dashboard. The System dashboard is considered to be shared with all
633
- * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
634
- * access is permitted.
635
- *
636
- * @returns Returned if the request is successful.
637
- *
638
- * example: {
639
- * "keys": [
640
- * {
641
- * "key": "issue.support",
642
- * "self":
643
- * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
644
- * }
645
- * ]
646
- * }
647
- * @path {GET} /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
648
- * @scopes-current read:jira-work
649
- * @scopes-beta read:dashboard.property:jira
650
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-get
651
- */
652
- getDashboardItemPropertyKeys({ dashboardId, itemId, }) {
653
- return this.getClientInstance()
654
- .request({
655
- path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties",
656
- method: "GET",
657
- pathParams: {
658
- dashboardId,
659
- itemId,
660
- },
661
- })
662
- .then(this.getClientInstance().responseHandler({
663
- 200: {
664
- "application/json": "json",
665
- },
666
- }))
667
- .then(commonHttpClient.castResponse())
668
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemPropertyKeys.response"))
669
- .then(commonHttpClient.getBody);
670
- }
671
- /**
672
- * Returns a [paginated](#pagination) list of dashboards. This operation is
673
- * similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the
674
- * results can be refined to include dashboards that have specific attributes. For
675
- * example, dashboards with a particular name. When multiple attributes are
676
- * specified only filters matching all attributes are returned.
677
- *
678
- * This operation can be accessed anonymously.
679
- *
680
- * **[Permissions](#permissions) required:** The following dashboards that match
681
- * the query parameters are returned:
682
- *
683
- * * Dashboards owned by the user. Not returned for anonymous users.
684
- * * Dashboards shared with a group that the user is a member of. Not returned
685
- * for anonymous users.
686
- * * Dashboards shared with a private project that the user can browse. Not
687
- * returned for anonymous users.
688
- * * Dashboards shared with a public project.
689
- * * Dashboards shared with the public.
690
- *
691
- * @returns Returned if the request is successful.
692
- *
693
- * example: {
694
- * "isLast": true,
695
- * "maxResults": 100,
696
- * "self":
697
- * "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0",
698
- * "startAt": 0,
699
- * "total": 2,
700
- * "values": [
701
- * {
702
- * "description": "Testing program",
703
- * "id": "1",
704
- * "isFavourite": true,
705
- * "name": "Testing",
706
- * "owner": {
707
- * "self":
708
- * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
709
- * "displayName": "Mia",
710
- * "active": true,
711
- * "accountId": "5b10a2844c20165700ede21g",
712
- * "avatarUrls": {
713
- * "16x16":
714
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
715
- * "24x24":
716
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
717
- * "32x32":
718
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
719
- * "48x48":
720
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
721
- * }
722
- * },
723
- * "popularity": 1,
724
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/1",
725
- * "sharePermissions": [
726
- * {
727
- * "type": "global"
728
- * }
729
- * ],
730
- * "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1"
731
- * },
732
- * {
733
- * "description": "Quantum initiative",
734
- * "id": "2",
735
- * "isFavourite": false,
736
- * "name": "Quantum ",
737
- * "owner": {
738
- * "self":
739
- * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
740
- * "displayName": "Mia",
741
- * "active": true,
742
- * "accountId": "5b10a2844c20165700ede21g",
743
- * "avatarUrls": {
744
- * "16x16":
745
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
746
- * "24x24":
747
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
748
- * "32x32":
749
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
750
- * "48x48":
751
- * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
752
- * }
753
- * },
754
- * "popularity": 0,
755
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/2",
756
- * "sharePermissions": [
757
- * {
758
- * "type": "loggedin"
759
- * }
760
- * ],
761
- * "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2"
762
- * }
763
- * ]
764
- * }
765
- * @path {GET} /rest/api/3/dashboard/search
766
- * @scopes-current read:jira-work
767
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
768
- * read:project-role:jira, read:user:jira, read:application-role:jira,
769
- * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
770
- * read:project-category:jira, read:project-version:jira,
771
- * read:project.component:jira
772
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-search-get
773
- */
774
- getDashboardsPaginated({ dashboardName, accountId, owner, groupname, groupId, projectId, orderBy, startAt, maxResults, status, expand, } = {}) {
775
- return this.getClientInstance()
776
- .request({
777
- path: "/rest/api/3/dashboard/search",
778
- method: "GET",
779
- query: {
780
- dashboardName,
781
- accountId,
782
- owner,
783
- groupname,
784
- groupId,
785
- projectId,
786
- orderBy,
787
- startAt,
788
- maxResults,
789
- status,
790
- expand,
791
- },
792
- })
793
- .then(this.getClientInstance().responseHandler({
794
- 200: {
795
- "application/json": "json",
796
- },
797
- }))
798
- .then(commonHttpClient.castResponse())
799
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardsPaginated.response"))
800
- .then(commonHttpClient.getBody);
801
- }
802
- /**
803
- * Removes a dashboard gadget from a dashboard.
804
- *
805
- * When a gadget is removed from a dashboard, other gadgets in the same column are
806
- * moved up to fill the emptied position.
807
- *
808
- * **[Permissions](#permissions) required:** None.
809
- *
810
- * @returns Returned if the request is successful.
811
- * @path {DELETE} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
812
- * @scopes-current write:jira-work
813
- * @scopes-beta write:dashboard:jira
814
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-delete
815
- */
816
- removeGadget({ dashboardId, gadgetId, }) {
817
- return this.getClientInstance()
818
- .request({
819
- path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
820
- method: "DELETE",
821
- pathParams: {
822
- dashboardId,
823
- gadgetId,
824
- },
825
- })
826
- .then(this.getClientInstance().responseHandler({
827
- 204: {
828
- "application/json": "json",
829
- },
830
- }))
831
- .then(commonHttpClient.castResponse())
832
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.removeGadget.response"))
833
- .then(commonHttpClient.getBody);
834
- }
835
- /**
836
- * Sets the value of a dashboard item property. Use this resource in apps to store
837
- * custom data against a dashboard item.
838
- *
839
- * A dashboard item enables an app to add user-specific information to a user
840
- * dashboard. Dashboard items are exposed to users as gadgets that users can add
841
- * to their dashboards. For more information on how users do this, see [Adding and
842
- * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
843
- *
844
- * When an app creates a dashboard item it registers a callback to receive the
845
- * dashboard item ID. The callback fires whenever the item is rendered or, where
846
- * the item is configurable, the user edits the item. The app then uses this
847
- * resource to store the item's content or configuration details. For more
848
- * information on working with dashboard items, see [ Building a dashboard item
849
- * for a JIRA Connect
850
- * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
851
- * and the [Dashboard
852
- * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
853
- * documentation.
854
- *
855
- * There is no resource to set or get dashboard items.
856
- *
857
- * The value of the request body must be a
858
- * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
859
- * length is 32768 characters.
860
- *
861
- * This operation can be accessed anonymously.
862
- *
863
- * **[Permissions](#permissions) required:** The user must be the owner of the
864
- * dashboard. Note, users with the *Administer Jira* [global
865
- * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
866
- * the System dashboard.
867
- *
868
- * @returns * status: 200, mediaType: application/json
869
- *
870
- * Returned if the dashboard item property is updated.
871
- *
872
- * * status: 201, mediaType: application/json
873
- *
874
- * Returned if the dashboard item property is created.
875
- * @path {PUT}
876
- * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
877
- * @scopes-current write:jira-work
878
- * @scopes-beta write:dashboard.property:jira
879
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put
880
- */
881
- setDashboardItemProperty({ dashboardId, itemId, propertyKey, requestBody, }) {
882
- return this.getClientInstance()
883
- .request({
884
- path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
885
- method: "PUT",
886
- pathParams: {
887
- dashboardId,
888
- itemId,
889
- propertyKey,
890
- },
891
- headers: {
892
- "Content-Type": "application/json",
893
- },
894
- body: requestBody,
895
- })
896
- .then(this.getClientInstance().responseHandler({
897
- 200: {
898
- "application/json": "json",
899
- },
900
- 201: {
901
- "application/json": "json",
902
- },
903
- }))
904
- .then(commonHttpClient.castResponse())
905
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.setDashboardItemProperty.response"))
906
- .then(commonHttpClient.asCreatedResponse("body"));
907
- }
908
- /**
909
- * Updates a dashboard, replacing all the dashboard details with those provided.
910
- *
911
- * **[Permissions](#permissions) required:** None
912
- *
913
- * The dashboard to be updated must be owned by the user.
914
- *
915
- * @returns Returned if the request is successful.
916
- *
917
- * example: {
918
- * "id": "10000",
919
- * "isFavourite": false,
920
- * "name": "System Dashboard",
921
- * "popularity": 1,
922
- * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
923
- * "sharePermissions": [
924
- * {
925
- * "type": "global"
926
- * }
927
- * ],
928
- * "view":
929
- * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
930
- * }
931
- * @path {PUT} /rest/api/3/dashboard/{id}
932
- * @scopes-current write:jira-work
933
- * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
934
- * read:project-role:jira, read:user:jira, write:dashboard:jira,
935
- * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
936
- * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
937
- * read:project.component:jira
938
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-put
939
- */
940
- updateDashboard({ id, dashboardDetails, }) {
941
- return this.getClientInstance()
942
- .request({
943
- path: "/rest/api/3/dashboard/{id}",
944
- method: "PUT",
945
- pathParams: {
946
- id,
947
- },
948
- headers: {
949
- "Content-Type": "application/json",
950
- },
951
- body: dashboardDetails,
952
- })
953
- .then(this.getClientInstance().responseHandler({
954
- 200: {
955
- "application/json": "json",
956
- },
957
- }))
958
- .then(commonHttpClient.castResponse())
959
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.updateDashboard.response"))
960
- .then(commonHttpClient.getBody);
961
- }
962
- /**
963
- * Changes the title, position, and color of the gadget on a dashboard.
964
- *
965
- * **[Permissions](#permissions) required:** None.
966
- *
967
- * @returns Returned if the request is successful.
968
- * @path {PUT} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
969
- * @scopes-current write:jira-work
970
- * @scopes-beta write:dashboard:jira
971
- * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-put
972
- */
973
- updateGadget({ dashboardId, gadgetId, dashboardGadgetUpdateRequest, }) {
974
- return this.getClientInstance()
975
- .request({
976
- path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
977
- method: "PUT",
978
- pathParams: {
979
- dashboardId,
980
- gadgetId,
981
- },
982
- headers: {
983
- "Content-Type": "application/json",
984
- },
985
- body: dashboardGadgetUpdateRequest,
986
- })
987
- .then(this.getClientInstance().responseHandler({
988
- 204: {
989
- "application/json": "json",
990
- },
991
- }))
992
- .then(commonHttpClient.castResponse())
993
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.updateGadget.response"))
994
- .then(commonHttpClient.getBody);
21
+ constructor() {
22
+ super(...arguments);
23
+ /**
24
+ * Adds a gadget to a dashboard.
25
+ *
26
+ * **[Permissions](#permissions) required:** None.
27
+ *
28
+ * @returns Returned if the request is successful.
29
+ *
30
+ * example: {
31
+ * "id": 10001,
32
+ * "moduleKey":
33
+ * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
34
+ * "color": "blue",
35
+ * "position": {
36
+ * "row": 0,
37
+ * "column": 1
38
+ * },
39
+ * "title": "Issue statistics"
40
+ * }
41
+ * @path {POST} /rest/api/3/dashboard/{dashboardId}/gadget
42
+ * @scopes-current write:jira-work, read:jira-work
43
+ * @scopes-beta write:dashboard:jira, read:dashboard:jira
44
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-post
45
+ */
46
+ this.addGadget = ({ dashboardId, dashboardGadgetSettings, }) => {
47
+ return this.getClientInstance()
48
+ .request({
49
+ path: "/rest/api/3/dashboard/{dashboardId}/gadget",
50
+ method: "POST",
51
+ pathParams: {
52
+ dashboardId,
53
+ },
54
+ headers: {
55
+ "Content-Type": "application/json",
56
+ },
57
+ body: dashboardGadgetSettings,
58
+ })
59
+ .then(this.getClientInstance().responseHandler({
60
+ 200: {
61
+ "application/json": "json",
62
+ },
63
+ }))
64
+ .then(commonHttpClient.castResponse())
65
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.addGadget.response"))
66
+ .then(commonHttpClient.getBody);
67
+ };
68
+ /**
69
+ * Bulk edit dashboards. Maximum number of dashboards to be edited at the same
70
+ * time is 100.
71
+ *
72
+ * **[Permissions](#permissions) required:** None
73
+ *
74
+ * The dashboards to be updated must be owned by the user, or the user must be an
75
+ * administrator.
76
+ *
77
+ * @returns Returned if the request is successful.
78
+ *
79
+ * example: {
80
+ * "action": "changePermission",
81
+ * "entityErrors": {
82
+ * "10002": {
83
+ * "errorMessages": [
84
+ * "Only owner or editors of the dashboard can change permissions."
85
+ * ],
86
+ * "errors": {}
87
+ * }
88
+ * }
89
+ * }
90
+ * @path {PUT} /rest/api/3/dashboard/bulk/edit
91
+ * @scopes-current write:jira-work
92
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
93
+ * read:project-role:jira, read:user:jira, write:dashboard:jira,
94
+ * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
95
+ * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
96
+ * read:project.component:jira
97
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-bulk-edit-put
98
+ */
99
+ this.bulkEditDashboards = ({ bulkEditShareableEntityRequest, }) => {
100
+ return this.getClientInstance()
101
+ .request({
102
+ path: "/rest/api/3/dashboard/bulk/edit",
103
+ method: "PUT",
104
+ headers: {
105
+ "Content-Type": "application/json",
106
+ },
107
+ body: bulkEditShareableEntityRequest,
108
+ })
109
+ .then(this.getClientInstance().responseHandler({
110
+ 200: {
111
+ "application/json": "json",
112
+ },
113
+ }))
114
+ .then(commonHttpClient.castResponse())
115
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.bulkEditDashboards.response"))
116
+ .then(commonHttpClient.getBody);
117
+ };
118
+ /**
119
+ * Copies a dashboard. Any values provided in the `dashboard` parameter replace
120
+ * those in the copied dashboard.
121
+ *
122
+ * **[Permissions](#permissions) required:** None
123
+ *
124
+ * The dashboard to be copied must be owned by or shared with the user.
125
+ *
126
+ * @returns Returned if the request is successful.
127
+ *
128
+ * example: {
129
+ * "id": "10000",
130
+ * "isFavourite": false,
131
+ * "name": "System Dashboard",
132
+ * "popularity": 1,
133
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
134
+ * "sharePermissions": [
135
+ * {
136
+ * "type": "global"
137
+ * }
138
+ * ],
139
+ * "view":
140
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
141
+ * }
142
+ * @path {POST} /rest/api/3/dashboard/{id}/copy
143
+ * @scopes-current write:jira-work
144
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
145
+ * read:project-role:jira, read:user:jira, write:dashboard:jira,
146
+ * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
147
+ * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
148
+ * read:project.component:jira
149
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-copy-post
150
+ */
151
+ this.copyDashboard = ({ id, dashboardDetails, }) => {
152
+ return this.getClientInstance()
153
+ .request({
154
+ path: "/rest/api/3/dashboard/{id}/copy",
155
+ method: "POST",
156
+ pathParams: {
157
+ id,
158
+ },
159
+ headers: {
160
+ "Content-Type": "application/json",
161
+ },
162
+ body: dashboardDetails,
163
+ })
164
+ .then(this.getClientInstance().responseHandler({
165
+ 200: {
166
+ "application/json": "json",
167
+ },
168
+ }))
169
+ .then(commonHttpClient.castResponse())
170
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.copyDashboard.response"))
171
+ .then(commonHttpClient.getBody);
172
+ };
173
+ /**
174
+ * Creates a dashboard.
175
+ *
176
+ * **[Permissions](#permissions) required:** None.
177
+ *
178
+ * @returns Returned if the request is successful.
179
+ *
180
+ * example: {
181
+ * "id": "10000",
182
+ * "isFavourite": false,
183
+ * "name": "System Dashboard",
184
+ * "popularity": 1,
185
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
186
+ * "sharePermissions": [
187
+ * {
188
+ * "type": "global"
189
+ * }
190
+ * ],
191
+ * "view":
192
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
193
+ * }
194
+ * @path {POST} /rest/api/3/dashboard
195
+ * @scopes-current write:jira-work
196
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
197
+ * read:project-role:jira, read:user:jira, write:dashboard:jira,
198
+ * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
199
+ * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
200
+ * read:project.component:jira
201
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-post
202
+ */
203
+ this.createDashboard = ({ extendAdminPermissions, dashboardDetails, }) => {
204
+ return this.getClientInstance()
205
+ .request({
206
+ path: "/rest/api/3/dashboard",
207
+ method: "POST",
208
+ query: {
209
+ extendAdminPermissions,
210
+ },
211
+ headers: {
212
+ "Content-Type": "application/json",
213
+ },
214
+ body: dashboardDetails,
215
+ })
216
+ .then(this.getClientInstance().responseHandler({
217
+ 200: {
218
+ "application/json": "json",
219
+ },
220
+ }))
221
+ .then(commonHttpClient.castResponse())
222
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.createDashboard.response"))
223
+ .then(commonHttpClient.getBody);
224
+ };
225
+ /**
226
+ * Deletes a dashboard.
227
+ *
228
+ * **[Permissions](#permissions) required:** None
229
+ *
230
+ * The dashboard to be deleted must be owned by the user.
231
+ *
232
+ * @path {DELETE} /rest/api/3/dashboard/{id}
233
+ * @scopes-current write:jira-work
234
+ * @scopes-beta delete:dashboard:jira
235
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-delete
236
+ */
237
+ this.deleteDashboard = ({ id, }) => {
238
+ return this.getClientInstance()
239
+ .request({
240
+ path: "/rest/api/3/dashboard/{id}",
241
+ method: "DELETE",
242
+ pathParams: {
243
+ id,
244
+ },
245
+ })
246
+ .then(commonHttpClient.discardResult);
247
+ };
248
+ /**
249
+ * Deletes a dashboard item property.
250
+ *
251
+ * This operation can be accessed anonymously.
252
+ *
253
+ * **[Permissions](#permissions) required:** The user must be the owner of the
254
+ * dashboard. Note, users with the *Administer Jira* [global
255
+ * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
256
+ * the System dashboard.
257
+ *
258
+ * @returns Returned if the dashboard item property is deleted.
259
+ * @path {DELETE}
260
+ * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
261
+ * @scopes-current write:jira-work
262
+ * @scopes-beta delete:dashboard.property:jira
263
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-delete
264
+ */
265
+ this.deleteDashboardItemProperty = ({ dashboardId, itemId, propertyKey, }) => {
266
+ return this.getClientInstance()
267
+ .request({
268
+ path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
269
+ method: "DELETE",
270
+ pathParams: {
271
+ dashboardId,
272
+ itemId,
273
+ propertyKey,
274
+ },
275
+ })
276
+ .then(this.getClientInstance().responseHandler({
277
+ 204: {
278
+ "application/json": "json",
279
+ },
280
+ }))
281
+ .then(commonHttpClient.castResponse())
282
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.deleteDashboardItemProperty.response"))
283
+ .then(commonHttpClient.getBody);
284
+ };
285
+ /**
286
+ * Gets a list of all available gadgets that can be added to all dashboards.
287
+ *
288
+ * **[Permissions](#permissions) required:** None.
289
+ *
290
+ * @returns Returned if the request is successful.
291
+ *
292
+ * example: {
293
+ * "gadgets": [
294
+ * {
295
+ * "moduleKey":
296
+ * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
297
+ * "title": "Issue statistics"
298
+ * },
299
+ * {
300
+ * "uri":
301
+ * "rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml",
302
+ * "title": "Activity Stream"
303
+ * }
304
+ * ]
305
+ * }
306
+ * @path {GET} /rest/api/3/dashboard/gadgets
307
+ * @scopes-current read:jira-work
308
+ * @scopes-beta read:dashboard:jira
309
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-gadgets-get
310
+ */
311
+ this.getAllAvailableDashboardGadgets = () => {
312
+ return this.getClientInstance()
313
+ .request({
314
+ path: "/rest/api/3/dashboard/gadgets",
315
+ method: "GET",
316
+ })
317
+ .then(this.getClientInstance().responseHandler({
318
+ 200: {
319
+ "application/json": "json",
320
+ },
321
+ }))
322
+ .then(commonHttpClient.castResponse())
323
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllAvailableDashboardGadgets.response"))
324
+ .then(commonHttpClient.getBody);
325
+ };
326
+ /**
327
+ * Returns a list of dashboards owned by or shared with the user. The list may be
328
+ * filtered to include only favorite or owned dashboards.
329
+ *
330
+ * This operation can be accessed anonymously.
331
+ *
332
+ * **[Permissions](#permissions) required:** None.
333
+ *
334
+ * @returns Returned if the request is successful.
335
+ *
336
+ * example: {
337
+ * "dashboards": [
338
+ * {
339
+ * "id": "10000",
340
+ * "isFavourite": false,
341
+ * "name": "System Dashboard",
342
+ * "popularity": 1,
343
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
344
+ * "sharePermissions": [
345
+ * {
346
+ * "type": "global"
347
+ * }
348
+ * ],
349
+ * "view":
350
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
351
+ * },
352
+ * {
353
+ * "id": "20000",
354
+ * "isFavourite": true,
355
+ * "name": "Build Engineering",
356
+ * "owner": {
357
+ * "key": "Mia",
358
+ * "self":
359
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
360
+ * "name": "mia",
361
+ * "displayName": "Mia Krystof",
362
+ * "avatarUrls": {
363
+ * "16x16":
364
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
365
+ * "24x24":
366
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
367
+ * "32x32":
368
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
369
+ * "48x48":
370
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
371
+ * }
372
+ * },
373
+ * "popularity": 1,
374
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/20000",
375
+ * "sharePermissions": [
376
+ * {
377
+ * "group": {
378
+ * "name": "administrators",
379
+ * "self":
380
+ * "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators"
381
+ * },
382
+ * "id": 10105,
383
+ * "type": "group"
384
+ * }
385
+ * ],
386
+ * "view":
387
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000"
388
+ * }
389
+ * ],
390
+ * "maxResults": 10,
391
+ * "next": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10",
392
+ * "prev": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0",
393
+ * "startAt": 10,
394
+ * "total": 143
395
+ * }
396
+ * @path {GET} /rest/api/3/dashboard
397
+ * @scopes-current read:jira-work
398
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
399
+ * read:project-role:jira, read:user:jira, read:application-role:jira,
400
+ * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
401
+ * read:project-category:jira, read:project-version:jira,
402
+ * read:project.component:jira
403
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-get
404
+ */
405
+ this.getAllDashboards = ({ filter, startAt, maxResults, } = {}) => {
406
+ return this.getClientInstance()
407
+ .request({
408
+ path: "/rest/api/3/dashboard",
409
+ method: "GET",
410
+ query: {
411
+ filter,
412
+ startAt,
413
+ maxResults,
414
+ },
415
+ })
416
+ .then(this.getClientInstance().responseHandler({
417
+ 200: {
418
+ "application/json": "json",
419
+ },
420
+ }))
421
+ .then(commonHttpClient.castResponse())
422
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllDashboards.response"))
423
+ .then(commonHttpClient.getBody);
424
+ };
425
+ /**
426
+ * Returns a list of dashboard gadgets on a dashboard.
427
+ *
428
+ * This operation returns:
429
+ *
430
+ * * Gadgets from a list of IDs, when `id` is set.
431
+ * * Gadgets with a module key, when `moduleKey` is set.
432
+ * * Gadgets from a list of URIs, when `uri` is set.
433
+ * * All gadgets, when no other parameters are set.
434
+ *
435
+ * This operation can be accessed anonymously.
436
+ *
437
+ * **[Permissions](#permissions) required:** None.
438
+ *
439
+ * @returns Returned if the request is successful.
440
+ *
441
+ * example: {
442
+ * "gadgets": [
443
+ * {
444
+ * "id": 10001,
445
+ * "moduleKey":
446
+ * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
447
+ * "color": "blue",
448
+ * "position": {
449
+ * "row": 0,
450
+ * "column": 0
451
+ * },
452
+ * "title": "Issue statistics"
453
+ * },
454
+ * {
455
+ * "id": 10002,
456
+ * "moduleKey":
457
+ * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph",
458
+ * "color": "red",
459
+ * "position": {
460
+ * "row": 1,
461
+ * "column": 0
462
+ * },
463
+ * "title": "Activity stream"
464
+ * },
465
+ * {
466
+ * "id": 10003,
467
+ * "moduleKey":
468
+ * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
469
+ * "color": "yellow",
470
+ * "position": {
471
+ * "row": 0,
472
+ * "column": 1
473
+ * },
474
+ * "title": "Bubble chart"
475
+ * }
476
+ * ]
477
+ * }
478
+ * @path {GET} /rest/api/3/dashboard/{dashboardId}/gadget
479
+ * @scopes-current read:jira-work
480
+ * @scopes-beta read:dashboard:jira
481
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-get
482
+ */
483
+ this.getAllGadgets = ({ dashboardId, moduleKey, uri, gadgetId, }) => {
484
+ return this.getClientInstance()
485
+ .request({
486
+ path: "/rest/api/3/dashboard/{dashboardId}/gadget",
487
+ method: "GET",
488
+ pathParams: {
489
+ dashboardId,
490
+ },
491
+ query: {
492
+ moduleKey,
493
+ uri,
494
+ gadgetId,
495
+ },
496
+ })
497
+ .then(this.getClientInstance().responseHandler({
498
+ 200: {
499
+ "application/json": "json",
500
+ },
501
+ }))
502
+ .then(commonHttpClient.castResponse())
503
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getAllGadgets.response"))
504
+ .then(commonHttpClient.getBody);
505
+ };
506
+ /**
507
+ * Returns a dashboard.
508
+ *
509
+ * This operation can be accessed anonymously.
510
+ *
511
+ * **[Permissions](#permissions) required:** None.
512
+ *
513
+ * However, to get a dashboard, the dashboard must be shared with the user or the
514
+ * user must own it. Note, users with the *Administer Jira* [global
515
+ * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
516
+ * the System dashboard. The System dashboard is considered to be shared with all
517
+ * other users.
518
+ *
519
+ * @returns Returned if the request is successful.
520
+ *
521
+ * example: {
522
+ * "id": "10000",
523
+ * "isFavourite": false,
524
+ * "name": "System Dashboard",
525
+ * "popularity": 1,
526
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
527
+ * "sharePermissions": [
528
+ * {
529
+ * "type": "global"
530
+ * }
531
+ * ],
532
+ * "view":
533
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
534
+ * }
535
+ * @path {GET} /rest/api/3/dashboard/{id}
536
+ * @scopes-current read:jira-work
537
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
538
+ * read:project-role:jira, read:user:jira, read:application-role:jira,
539
+ * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
540
+ * read:project-category:jira, read:project-version:jira,
541
+ * read:project.component:jira
542
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-get
543
+ */
544
+ this.getDashboard = ({ id, }) => {
545
+ return this.getClientInstance()
546
+ .request({
547
+ path: "/rest/api/3/dashboard/{id}",
548
+ method: "GET",
549
+ pathParams: {
550
+ id,
551
+ },
552
+ })
553
+ .then(this.getClientInstance().responseHandler({
554
+ 200: {
555
+ "application/json": "json",
556
+ },
557
+ }))
558
+ .then(commonHttpClient.castResponse())
559
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboard.response"))
560
+ .then(commonHttpClient.getBody);
561
+ };
562
+ /**
563
+ * Returns the key and value of a dashboard item property.
564
+ *
565
+ * A dashboard item enables an app to add user-specific information to a user
566
+ * dashboard. Dashboard items are exposed to users as gadgets that users can add
567
+ * to their dashboards. For more information on how users do this, see [Adding and
568
+ * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
569
+ *
570
+ * When an app creates a dashboard item it registers a callback to receive the
571
+ * dashboard item ID. The callback fires whenever the item is rendered or, where
572
+ * the item is configurable, the user edits the item. The app then uses this
573
+ * resource to store the item's content or configuration details. For more
574
+ * information on working with dashboard items, see [ Building a dashboard item
575
+ * for a JIRA Connect
576
+ * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
577
+ * and the [Dashboard
578
+ * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
579
+ * documentation.
580
+ *
581
+ * There is no resource to set or get dashboard items.
582
+ *
583
+ * This operation can be accessed anonymously.
584
+ *
585
+ * **[Permissions](#permissions) required:** The user must be the owner of the
586
+ * dashboard or have the dashboard shared with them. Note, users with the
587
+ * *Administer Jira* [global
588
+ * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
589
+ * the System dashboard. The System dashboard is considered to be shared with all
590
+ * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
591
+ * access is permitted.
592
+ *
593
+ * @returns Returned if the request is successful.
594
+ *
595
+ * example: {
596
+ * "key": "issue.support",
597
+ * "value": {
598
+ * "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
599
+ * "system.support.time": "1m"
600
+ * }
601
+ * }
602
+ * @path {GET}
603
+ * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
604
+ * @scopes-current read:jira-work
605
+ * @scopes-beta read:dashboard.property:jira
606
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-get
607
+ */
608
+ this.getDashboardItemProperty = ({ dashboardId, itemId, propertyKey, }) => {
609
+ return this.getClientInstance()
610
+ .request({
611
+ path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
612
+ method: "GET",
613
+ pathParams: {
614
+ dashboardId,
615
+ itemId,
616
+ propertyKey,
617
+ },
618
+ })
619
+ .then(this.getClientInstance().responseHandler({
620
+ 200: {
621
+ "application/json": "json",
622
+ },
623
+ }))
624
+ .then(commonHttpClient.castResponse())
625
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemProperty.response"))
626
+ .then(commonHttpClient.getBody);
627
+ };
628
+ /**
629
+ * Returns the keys of all properties for a dashboard item.
630
+ *
631
+ * This operation can be accessed anonymously.
632
+ *
633
+ * **[Permissions](#permissions) required:** The user must be the owner of the
634
+ * dashboard or have the dashboard shared with them. Note, users with the
635
+ * *Administer Jira* [global
636
+ * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
637
+ * the System dashboard. The System dashboard is considered to be shared with all
638
+ * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
639
+ * access is permitted.
640
+ *
641
+ * @returns Returned if the request is successful.
642
+ *
643
+ * example: {
644
+ * "keys": [
645
+ * {
646
+ * "key": "issue.support",
647
+ * "self":
648
+ * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
649
+ * }
650
+ * ]
651
+ * }
652
+ * @path {GET} /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
653
+ * @scopes-current read:jira-work
654
+ * @scopes-beta read:dashboard.property:jira
655
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-get
656
+ */
657
+ this.getDashboardItemPropertyKeys = ({ dashboardId, itemId, }) => {
658
+ return this.getClientInstance()
659
+ .request({
660
+ path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties",
661
+ method: "GET",
662
+ pathParams: {
663
+ dashboardId,
664
+ itemId,
665
+ },
666
+ })
667
+ .then(this.getClientInstance().responseHandler({
668
+ 200: {
669
+ "application/json": "json",
670
+ },
671
+ }))
672
+ .then(commonHttpClient.castResponse())
673
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemPropertyKeys.response"))
674
+ .then(commonHttpClient.getBody);
675
+ };
676
+ /**
677
+ * Returns a [paginated](#pagination) list of dashboards. This operation is
678
+ * similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the
679
+ * results can be refined to include dashboards that have specific attributes. For
680
+ * example, dashboards with a particular name. When multiple attributes are
681
+ * specified only filters matching all attributes are returned.
682
+ *
683
+ * This operation can be accessed anonymously.
684
+ *
685
+ * **[Permissions](#permissions) required:** The following dashboards that match
686
+ * the query parameters are returned:
687
+ *
688
+ * * Dashboards owned by the user. Not returned for anonymous users.
689
+ * * Dashboards shared with a group that the user is a member of. Not returned
690
+ * for anonymous users.
691
+ * * Dashboards shared with a private project that the user can browse. Not
692
+ * returned for anonymous users.
693
+ * * Dashboards shared with a public project.
694
+ * * Dashboards shared with the public.
695
+ *
696
+ * @returns Returned if the request is successful.
697
+ *
698
+ * example: {
699
+ * "isLast": true,
700
+ * "maxResults": 100,
701
+ * "self":
702
+ * "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0",
703
+ * "startAt": 0,
704
+ * "total": 2,
705
+ * "values": [
706
+ * {
707
+ * "description": "Testing program",
708
+ * "id": "1",
709
+ * "isFavourite": true,
710
+ * "name": "Testing",
711
+ * "owner": {
712
+ * "self":
713
+ * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
714
+ * "displayName": "Mia",
715
+ * "active": true,
716
+ * "accountId": "5b10a2844c20165700ede21g",
717
+ * "avatarUrls": {
718
+ * "16x16":
719
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
720
+ * "24x24":
721
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
722
+ * "32x32":
723
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
724
+ * "48x48":
725
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
726
+ * }
727
+ * },
728
+ * "popularity": 1,
729
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/1",
730
+ * "sharePermissions": [
731
+ * {
732
+ * "type": "global"
733
+ * }
734
+ * ],
735
+ * "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1"
736
+ * },
737
+ * {
738
+ * "description": "Quantum initiative",
739
+ * "id": "2",
740
+ * "isFavourite": false,
741
+ * "name": "Quantum ",
742
+ * "owner": {
743
+ * "self":
744
+ * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
745
+ * "displayName": "Mia",
746
+ * "active": true,
747
+ * "accountId": "5b10a2844c20165700ede21g",
748
+ * "avatarUrls": {
749
+ * "16x16":
750
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
751
+ * "24x24":
752
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
753
+ * "32x32":
754
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
755
+ * "48x48":
756
+ * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
757
+ * }
758
+ * },
759
+ * "popularity": 0,
760
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/2",
761
+ * "sharePermissions": [
762
+ * {
763
+ * "type": "loggedin"
764
+ * }
765
+ * ],
766
+ * "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2"
767
+ * }
768
+ * ]
769
+ * }
770
+ * @path {GET} /rest/api/3/dashboard/search
771
+ * @scopes-current read:jira-work
772
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
773
+ * read:project-role:jira, read:user:jira, read:application-role:jira,
774
+ * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
775
+ * read:project-category:jira, read:project-version:jira,
776
+ * read:project.component:jira
777
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-search-get
778
+ */
779
+ this.getDashboardsPaginated = ({ dashboardName, accountId, owner, groupname, groupId, projectId, orderBy, startAt, maxResults, status, expand, } = {}) => {
780
+ return this.getClientInstance()
781
+ .request({
782
+ path: "/rest/api/3/dashboard/search",
783
+ method: "GET",
784
+ query: {
785
+ dashboardName,
786
+ accountId,
787
+ owner,
788
+ groupname,
789
+ groupId,
790
+ projectId,
791
+ orderBy,
792
+ startAt,
793
+ maxResults,
794
+ status,
795
+ expand,
796
+ },
797
+ })
798
+ .then(this.getClientInstance().responseHandler({
799
+ 200: {
800
+ "application/json": "json",
801
+ },
802
+ }))
803
+ .then(commonHttpClient.castResponse())
804
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.getDashboardsPaginated.response"))
805
+ .then(commonHttpClient.getBody);
806
+ };
807
+ /**
808
+ * Removes a dashboard gadget from a dashboard.
809
+ *
810
+ * When a gadget is removed from a dashboard, other gadgets in the same column are
811
+ * moved up to fill the emptied position.
812
+ *
813
+ * **[Permissions](#permissions) required:** None.
814
+ *
815
+ * @returns Returned if the request is successful.
816
+ * @path {DELETE} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
817
+ * @scopes-current write:jira-work
818
+ * @scopes-beta write:dashboard:jira
819
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-delete
820
+ */
821
+ this.removeGadget = ({ dashboardId, gadgetId, }) => {
822
+ return this.getClientInstance()
823
+ .request({
824
+ path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
825
+ method: "DELETE",
826
+ pathParams: {
827
+ dashboardId,
828
+ gadgetId,
829
+ },
830
+ })
831
+ .then(this.getClientInstance().responseHandler({
832
+ 204: {
833
+ "application/json": "json",
834
+ },
835
+ }))
836
+ .then(commonHttpClient.castResponse())
837
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.removeGadget.response"))
838
+ .then(commonHttpClient.getBody);
839
+ };
840
+ /**
841
+ * Sets the value of a dashboard item property. Use this resource in apps to store
842
+ * custom data against a dashboard item.
843
+ *
844
+ * A dashboard item enables an app to add user-specific information to a user
845
+ * dashboard. Dashboard items are exposed to users as gadgets that users can add
846
+ * to their dashboards. For more information on how users do this, see [Adding and
847
+ * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
848
+ *
849
+ * When an app creates a dashboard item it registers a callback to receive the
850
+ * dashboard item ID. The callback fires whenever the item is rendered or, where
851
+ * the item is configurable, the user edits the item. The app then uses this
852
+ * resource to store the item's content or configuration details. For more
853
+ * information on working with dashboard items, see [ Building a dashboard item
854
+ * for a JIRA Connect
855
+ * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
856
+ * and the [Dashboard
857
+ * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
858
+ * documentation.
859
+ *
860
+ * There is no resource to set or get dashboard items.
861
+ *
862
+ * The value of the request body must be a
863
+ * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
864
+ * length is 32768 characters.
865
+ *
866
+ * This operation can be accessed anonymously.
867
+ *
868
+ * **[Permissions](#permissions) required:** The user must be the owner of the
869
+ * dashboard. Note, users with the *Administer Jira* [global
870
+ * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
871
+ * the System dashboard.
872
+ *
873
+ * @returns * status: 200, mediaType: application/json
874
+ *
875
+ * Returned if the dashboard item property is updated.
876
+ *
877
+ * * status: 201, mediaType: application/json
878
+ *
879
+ * Returned if the dashboard item property is created.
880
+ * @path {PUT}
881
+ * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
882
+ * @scopes-current write:jira-work
883
+ * @scopes-beta write:dashboard.property:jira
884
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put
885
+ */
886
+ this.setDashboardItemProperty = ({ dashboardId, itemId, propertyKey, requestBody, }) => {
887
+ return this.getClientInstance()
888
+ .request({
889
+ path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
890
+ method: "PUT",
891
+ pathParams: {
892
+ dashboardId,
893
+ itemId,
894
+ propertyKey,
895
+ },
896
+ headers: {
897
+ "Content-Type": "application/json",
898
+ },
899
+ body: requestBody,
900
+ })
901
+ .then(this.getClientInstance().responseHandler({
902
+ 200: {
903
+ "application/json": "json",
904
+ },
905
+ 201: {
906
+ "application/json": "json",
907
+ },
908
+ }))
909
+ .then(commonHttpClient.castResponse())
910
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.setDashboardItemProperty.response"))
911
+ .then(commonHttpClient.asCreatedResponse("body"));
912
+ };
913
+ /**
914
+ * Updates a dashboard, replacing all the dashboard details with those provided.
915
+ *
916
+ * **[Permissions](#permissions) required:** None
917
+ *
918
+ * The dashboard to be updated must be owned by the user.
919
+ *
920
+ * @returns Returned if the request is successful.
921
+ *
922
+ * example: {
923
+ * "id": "10000",
924
+ * "isFavourite": false,
925
+ * "name": "System Dashboard",
926
+ * "popularity": 1,
927
+ * "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
928
+ * "sharePermissions": [
929
+ * {
930
+ * "type": "global"
931
+ * }
932
+ * ],
933
+ * "view":
934
+ * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
935
+ * }
936
+ * @path {PUT} /rest/api/3/dashboard/{id}
937
+ * @scopes-current write:jira-work
938
+ * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
939
+ * read:project-role:jira, read:user:jira, write:dashboard:jira,
940
+ * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
941
+ * read:issue-type:jira, read:project-category:jira, read:project-version:jira,
942
+ * read:project.component:jira
943
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-put
944
+ */
945
+ this.updateDashboard = ({ id, extendAdminPermissions, dashboardDetails, }) => {
946
+ return this.getClientInstance()
947
+ .request({
948
+ path: "/rest/api/3/dashboard/{id}",
949
+ method: "PUT",
950
+ pathParams: {
951
+ id,
952
+ },
953
+ query: {
954
+ extendAdminPermissions,
955
+ },
956
+ headers: {
957
+ "Content-Type": "application/json",
958
+ },
959
+ body: dashboardDetails,
960
+ })
961
+ .then(this.getClientInstance().responseHandler({
962
+ 200: {
963
+ "application/json": "json",
964
+ },
965
+ }))
966
+ .then(commonHttpClient.castResponse())
967
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.updateDashboard.response"))
968
+ .then(commonHttpClient.getBody);
969
+ };
970
+ /**
971
+ * Changes the title, position, and color of the gadget on a dashboard.
972
+ *
973
+ * **[Permissions](#permissions) required:** None.
974
+ *
975
+ * @returns Returned if the request is successful.
976
+ * @path {PUT} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
977
+ * @scopes-current write:jira-work
978
+ * @scopes-beta write:dashboard:jira
979
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-put
980
+ */
981
+ this.updateGadget = ({ dashboardId, gadgetId, dashboardGadgetUpdateRequest, }) => {
982
+ return this.getClientInstance()
983
+ .request({
984
+ path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
985
+ method: "PUT",
986
+ pathParams: {
987
+ dashboardId,
988
+ gadgetId,
989
+ },
990
+ headers: {
991
+ "Content-Type": "application/json",
992
+ },
993
+ body: dashboardGadgetUpdateRequest,
994
+ })
995
+ .then(this.getClientInstance().responseHandler({
996
+ 204: {
997
+ "application/json": "json",
998
+ },
999
+ }))
1000
+ .then(commonHttpClient.castResponse())
1001
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("DashboardsService.updateGadget.response"))
1002
+ .then(commonHttpClient.getBody);
1003
+ };
995
1004
  }
996
1005
  static initialize() {
997
1006
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DashboardsService.getAllDashboards.response", zod_1.z