@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
@@ -16,2051 +16,2054 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
16
16
  * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board
17
17
  */
18
18
  class BoardService extends CommonHttpService_1.CommonHttpService {
19
- /**
20
- * Creates a new board. Board name, type and filter ID is required.
21
- *
22
- * * `name` \- Must be less than 255 characters.
23
- * * `type` \- Valid values: scrum, kanban
24
- * * `filterId` \- ID of a filter that the user has permissions to view. Note,
25
- * if the user does not have the 'Create shared objects' permission and tries to
26
- * create a shared board, a private board will be created instead (remember that
27
- * board sharing depends on the filter sharing).
28
- * * `location` \- The container that the board will be located in. `location`
29
- * must include the `type` property (Valid values: project, user). If choosing
30
- * 'project', then a project must be specified by a `projectKeyOrId` property in
31
- * `location`. If choosing 'user', the current user is chosen by default. The
32
- * `projectKeyOrId` property should not be provided.
33
- *
34
- * Note:
35
- *
36
- * * If you want to create a new project with an associated board, use the [Jira
37
- * platform REST API](https://docs.atlassian.com/jira/REST/latest). For more
38
- * information, see the [Create project](#api-rest-api-3-project-post) method. The
39
- * `projectTypeKey` for software boards must be 'software' and the
40
- * `projectTemplateKey` must be either
41
- * `com.pyxis.greenhopper.jira:gh-kanban-template` or
42
- * `com.pyxis.greenhopper.jira:gh-scrum-template`.
43
- * * You can create a filter using the [Jira REST
44
- * API](https://docs.atlassian.com/jira/REST/latest). For more information, see
45
- * the [Create filter](#api-rest-api-3-filter-post) method.
46
- * * If you do not ORDER BY the Rank field for the filter of your board, you
47
- * will not be able to reorder issues on the board.
48
- *
49
- * @returns Returns the created board.
50
- *
51
- * example: {
52
- * "id": 84,
53
- * "name": "scrum board",
54
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
55
- * "type": "scrum"
56
- * }
57
- * @path {POST} /rest/agile/1.0/board
58
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-post
59
- */
60
- createBoard({ boardCreateBean, }) {
61
- return this.getClientInstance()
62
- .request({
63
- path: "/rest/agile/1.0/board",
64
- method: "POST",
65
- headers: {
66
- "Content-Type": "application/json",
67
- },
68
- body: boardCreateBean,
69
- })
70
- .then(this.getClientInstance().responseHandler({
71
- 201: {
72
- "application/json": "json",
73
- },
74
- }))
75
- .then(commonHttpClient.castResponse())
76
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.createBoard.response"))
77
- .then(commonHttpClient.getBody);
78
- }
79
- /**
80
- * Deletes the board. Admin without the view permission can still remove the board.
81
- *
82
- * @path {DELETE} /rest/agile/1.0/board/{boardId}
83
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-delete
84
- */
85
- deleteBoard({ boardId, }) {
86
- return this.getClientInstance()
87
- .request({
88
- path: "/rest/agile/1.0/board/{boardId}",
89
- method: "DELETE",
90
- pathParams: {
91
- boardId,
92
- },
93
- })
94
- .then(commonHttpClient.discardResult);
95
- }
96
- /**
97
- * Removes the property from the board identified by the id. Ths user removing the
98
- * property is required to have permissions to modify the board.
99
- *
100
- * @path {DELETE} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
101
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-delete
102
- */
103
- deleteBoardProperty({ boardId, propertyKey, }) {
104
- return this.getClientInstance()
105
- .request({
106
- path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
107
- method: "DELETE",
108
- pathParams: {
109
- boardId,
110
- propertyKey,
111
- },
112
- })
113
- .then(commonHttpClient.discardResult);
114
- }
115
- /**
116
- * Returns all boards. This only includes boards that the user has permission to
117
- * view.
118
- *
119
- * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on
120
- * February 15, 2024.
121
- *
122
- * * `read:board-scope:jira-software`, `read:project:jira`
123
- *
124
- * @returns Returns the requested boards, at the specified page of the results.
125
- *
126
- * example: {
127
- * "isLast": false,
128
- * "maxResults": 2,
129
- * "startAt": 1,
130
- * "total": 5,
131
- * "values": [
132
- * {
133
- * "id": 84,
134
- * "name": "scrum board",
135
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
136
- * "type": "scrum"
137
- * },
138
- * {
139
- * "id": 92,
140
- * "name": "kanban board",
141
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
142
- * "type": "kanban"
143
- * }
144
- * ]
145
- * }
146
- * @path {GET} /rest/agile/1.0/board
147
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-get
148
- */
149
- getAllBoards({ startAt, maxResults, type, name, projectKeyOrId, accountIdLocation, projectLocation, includePrivate, negateLocationFiltering, orderBy, expand, projectTypeLocation, filterId, } = {}) {
150
- return this.getClientInstance()
151
- .request({
152
- path: "/rest/agile/1.0/board",
153
- method: "GET",
154
- query: {
155
- startAt,
156
- maxResults,
157
- type,
158
- name,
159
- projectKeyOrId,
160
- accountIdLocation,
161
- projectLocation,
162
- includePrivate,
163
- negateLocationFiltering,
164
- orderBy,
165
- expand,
166
- projectTypeLocation,
167
- filterId,
168
- },
169
- })
170
- .then(this.getClientInstance().responseHandler({
171
- 200: {
172
- "application/json": "json",
173
- },
174
- }))
175
- .then(commonHttpClient.castResponse())
176
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllBoards.response"))
177
- .then(commonHttpClient.getBody);
178
- }
179
- /**
180
- * Returns all quick filters from a board, for a given board ID.
181
- *
182
- * @returns Returns the requested quick filters, at the specified page of the results.
183
- * Quick filters will be ordered first by position.
184
- *
185
- * example: {
186
- * "isLast": false,
187
- * "maxResults": 2,
188
- * "startAt": 1,
189
- * "total": 5,
190
- * "values": [
191
- * {
192
- * "boardId": 1,
193
- * "description": "Issues of type bug",
194
- * "id": 1,
195
- * "jql": "issueType = bug",
196
- * "name": "Bugs",
197
- * "position": 0
198
- * },
199
- * {
200
- * "boardId": 1,
201
- * "description": "Issues of type task",
202
- * "id": 2,
203
- * "jql": "issueType = task",
204
- * "name": "Tasks",
205
- * "position": 0
206
- * }
207
- * ]
208
- * }
209
- * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter
210
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-get
211
- */
212
- getAllQuickFilters({ boardId, startAt, maxResults, }) {
213
- return this.getClientInstance()
214
- .request({
215
- path: "/rest/agile/1.0/board/{boardId}/quickfilter",
216
- method: "GET",
217
- pathParams: {
218
- boardId,
219
- },
220
- query: {
221
- startAt,
222
- maxResults,
223
- },
224
- })
225
- .then(this.getClientInstance().responseHandler({
226
- 200: {
227
- "application/json": "json",
228
- },
229
- }))
230
- .then(commonHttpClient.castResponse())
231
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllQuickFilters.response"))
232
- .then(commonHttpClient.getBody);
233
- }
234
- /**
235
- * Returns all sprints from a board, for a given board ID. This only includes
236
- * sprints that the user has permission to view.
237
- *
238
- * @returns Returns the requested sprints, at the specified page of the results. Sprints
239
- * will be ordered first by state (i.e. closed, active, future) then by their
240
- * position in the backlog.
241
- *
242
- * example: {
243
- * "isLast": false,
244
- * "maxResults": 2,
245
- * "startAt": 1,
246
- * "total": 5,
247
- * "values": [
248
- * {
249
- * "id": 37,
250
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
251
- * "state": "closed",
252
- * "name": "sprint 1",
253
- * "startDate": "2015-04-11T15:22:00.000+10:00",
254
- * "endDate": "2015-04-20T01:22:00.000+10:00",
255
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
256
- * "originBoardId": 5,
257
- * "goal": "sprint 1 goal"
258
- * },
259
- * {
260
- * "id": 72,
261
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
262
- * "state": "future",
263
- * "name": "sprint 2",
264
- * "goal": "sprint 2 goal"
265
- * }
266
- * ]
267
- * }
268
- * @path {GET} /rest/agile/1.0/board/{boardId}/sprint
269
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-get
270
- */
271
- getAllSprints({ boardId, startAt, maxResults, state, }) {
272
- return this.getClientInstance()
273
- .request({
274
- path: "/rest/agile/1.0/board/{boardId}/sprint",
275
- method: "GET",
276
- pathParams: {
277
- boardId,
278
- },
279
- query: {
280
- startAt,
281
- maxResults,
282
- state,
283
- },
284
- })
285
- .then(this.getClientInstance().responseHandler({
286
- 200: {
287
- "application/json": "json",
288
- },
289
- }))
290
- .then(commonHttpClient.castResponse())
291
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllSprints.response"))
292
- .then(commonHttpClient.getBody);
293
- }
294
- /**
295
- * Returns all versions from a board, for a given board ID. This only includes
296
- * versions that the user has permission to view. Note, if the user does not have
297
- * permission to view the board, no versions will be returned at all. Returned
298
- * versions are ordered by the name of the project from which they belong and then
299
- * by sequence defined by user.
300
- *
301
- * @returns Returns the requested versions, at the specified page of the results.
302
- *
303
- * example: {
304
- * "isLast": false,
305
- * "maxResults": 2,
306
- * "startAt": 1,
307
- * "total": 5,
308
- * "values": [
309
- * {
310
- * "archived": false,
311
- * "description": "A first version",
312
- * "id": 10000,
313
- * "name": "Version 1",
314
- * "projectId": 10000,
315
- * "releaseDate": "2015-04-20T01:02:00.000+10:00",
316
- * "released": true,
317
- * "self": "https://your-domain.atlassian.net/version/10000"
318
- * },
319
- * {
320
- * "archived": false,
321
- * "description": "Minor Bugfix version",
322
- * "id": 10010,
323
- * "name": "Next Version",
324
- * "projectId": 10000,
325
- * "released": false,
326
- * "self": "https://your-domain.atlassian.net/version/10010"
327
- * }
328
- * ]
329
- * }
330
- * @path {GET} /rest/agile/1.0/board/{boardId}/version
331
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-version-get
332
- */
333
- getAllVersions({ boardId, startAt, maxResults, released, }) {
334
- return this.getClientInstance()
335
- .request({
336
- path: "/rest/agile/1.0/board/{boardId}/version",
337
- method: "GET",
338
- pathParams: {
339
- boardId,
340
- },
341
- query: {
342
- startAt,
343
- maxResults,
344
- released,
345
- },
346
- })
347
- .then(this.getClientInstance().responseHandler({
348
- 200: {
349
- "application/json": "json",
350
- },
351
- }))
352
- .then(commonHttpClient.castResponse())
353
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllVersions.response"))
354
- .then(commonHttpClient.getBody);
355
- }
356
- /**
357
- * Returns the board for the given board ID. This board will only be returned if
358
- * the user has permission to view it. Admins without the view permission will see
359
- * the board as a private one, so will see only a subset of the board's data
360
- * (board location for instance).
361
- *
362
- * @returns Returns the requested board.
363
- *
364
- * example: {
365
- * "id": 84,
366
- * "location": {
367
- * "displayName": "Example Project",
368
- * "name": "Example Project",
369
- * "projectId": 10040,
370
- * "projectKey": "Example Project Key",
371
- * "projectName": "Example Project",
372
- * "projectTypeKey": "KEY",
373
- * "userAccountId": "5b10a2844c20165700ede21g",
374
- * "userId": 10040
375
- * },
376
- * "name": "scrum board",
377
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
378
- * "type": "scrum"
379
- * }
380
- * @path {GET} /rest/agile/1.0/board/{boardId}
381
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-get
382
- */
383
- getBoard({ boardId, }) {
384
- return this.getClientInstance()
385
- .request({
386
- path: "/rest/agile/1.0/board/{boardId}",
387
- method: "GET",
388
- pathParams: {
389
- boardId,
390
- },
391
- })
392
- .then(this.getClientInstance().responseHandler({
393
- 200: {
394
- "application/json": "json",
395
- },
396
- }))
397
- .then(commonHttpClient.castResponse())
398
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoard.response"))
399
- .then(commonHttpClient.getBody);
400
- }
401
- /**
402
- * Returns any boards which use the provided filter id. This method can be
403
- * executed by users without a valid software license in order to find which
404
- * boards are using a particular filter.
405
- *
406
- * @returns Returns the requested boards, at the specified page of the results.
407
- *
408
- * example: {
409
- * "id": 84,
410
- * "name": "scrum board",
411
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
412
- * }
413
- * @path {GET} /rest/agile/1.0/board/filter/{filterId}
414
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-filter-filterid-get
415
- */
416
- getBoardByFilterId({ filterId, startAt, maxResults, }) {
417
- return this.getClientInstance()
418
- .request({
419
- path: "/rest/agile/1.0/board/filter/{filterId}",
420
- method: "GET",
421
- pathParams: {
422
- filterId,
423
- },
424
- query: {
425
- startAt,
426
- maxResults,
427
- },
428
- })
429
- .then(this.getClientInstance().responseHandler({
430
- 200: {
431
- "application/json": "json",
432
- },
433
- }))
434
- .then(commonHttpClient.castResponse())
435
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardByFilterId.response"))
436
- .then(commonHttpClient.getBody);
437
- }
438
- /**
439
- * Returns all issues that belong to an epic on the board, for the given epic ID
440
- * and the board ID. This only includes issues that the user has permission to
441
- * view. Issues returned from this resource include Agile fields, like sprint,
442
- * closedSprints, flagged, and epic. By default, the returned issues are ordered
443
- * by rank.
444
- *
445
- * @returns Returns the requested issues, at the specified page of the results.
446
- *
447
- * example: {
448
- * "expand": "names,schema",
449
- * "issues": [
450
- * {
451
- * "expand": "",
452
- * "fields": {
453
- * "flagged": true,
454
- * "sprint": {
455
- * "id": 37,
456
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
457
- * "state": "future",
458
- * "name": "sprint 2",
459
- * "goal": "sprint 2 goal"
460
- * },
461
- * "closedSprints": [
462
- * {
463
- * "id": 37,
464
- * "self":
465
- * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
466
- * "state": "closed",
467
- * "name": "sprint 1",
468
- * "startDate": "2015-04-11T15:22:00.000+10:00",
469
- * "endDate": "2015-04-20T01:22:00.000+10:00",
470
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
471
- * "goal": "sprint 1 goal"
472
- * }
473
- * ],
474
- * "description": "example bug report",
475
- * "project": {
476
- * "avatarUrls": {
477
- * "16x16":
478
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
479
- * "24x24":
480
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
481
- * "32x32":
482
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
483
- * "48x48":
484
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
485
- * },
486
- * "id": "10000",
487
- * "insight": {
488
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
489
- * "totalIssueCount": 100
490
- * },
491
- * "key": "EX",
492
- * "name": "Example",
493
- * "projectCategory": {
494
- * "description": "First Project Category",
495
- * "id": "10000",
496
- * "name": "FIRST",
497
- * "self":
498
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
499
- * },
500
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
501
- * "simplified": false,
502
- * "style": "classic"
503
- * },
504
- * "comment": [
505
- * {
506
- * "author": {
507
- * "accountId": "5b10a2844c20165700ede21g",
508
- * "active": false,
509
- * "displayName": "Mia Krystof",
510
- * "self":
511
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
512
- * },
513
- * "body": {
514
- * "type": "doc",
515
- * "version": 1,
516
- * "content": [
517
- * {
518
- * "type": "paragraph",
519
- * "content": [
520
- * {
521
- * "type": "text",
522
- * "text": "Lorem ipsum dolor sit amet, consectetur
523
- * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
524
- * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
525
- * semper."
526
- * }
527
- * ]
528
- * }
529
- * ]
530
- * },
531
- * "created": "2021-01-17T12:34:00.000+0000",
532
- * "id": "10000",
533
- * "self":
534
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
535
- * "updateAuthor": {
536
- * "accountId": "5b10a2844c20165700ede21g",
537
- * "active": false,
538
- * "displayName": "Mia Krystof",
539
- * "self":
540
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
541
- * },
542
- * "updated": "2021-01-18T23:45:00.000+0000",
543
- * "visibility": {
544
- * "identifier": "Administrators",
545
- * "type": "role",
546
- * "value": "Administrators"
547
- * }
548
- * }
549
- * ],
550
- * "epic": {
551
- * "id": 37,
552
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
553
- * "name": "epic 1",
554
- * "summary": "epic 1 summary",
555
- * "color": {
556
- * "key": "color_4"
557
- * },
558
- * "done": true
559
- * },
560
- * "worklog": [
561
- * {
562
- * "author": {
563
- * "accountId": "5b10a2844c20165700ede21g",
564
- * "active": false,
565
- * "displayName": "Mia Krystof",
566
- * "self":
567
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
568
- * },
569
- * "comment": {
570
- * "type": "doc",
571
- * "version": 1,
572
- * "content": [
573
- * {
574
- * "type": "paragraph",
575
- * "content": [
576
- * {
577
- * "type": "text",
578
- * "text": "I did some work here."
579
- * }
580
- * ]
581
- * }
582
- * ]
583
- * },
584
- * "id": "100028",
585
- * "issueId": "10002",
586
- * "self":
587
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
588
- * "started": "2021-01-17T12:34:00.000+0000",
589
- * "timeSpent": "3h 20m",
590
- * "timeSpentSeconds": 12000,
591
- * "updateAuthor": {
592
- * "accountId": "5b10a2844c20165700ede21g",
593
- * "active": false,
594
- * "displayName": "Mia Krystof",
595
- * "self":
596
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
597
- * },
598
- * "updated": "2021-01-18T23:45:00.000+0000",
599
- * "visibility": {
600
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
601
- * "type": "group",
602
- * "value": "jira-developers"
603
- * }
604
- * }
605
- * ],
606
- * "updated": 1,
607
- * "timetracking": {
608
- * "originalEstimate": "10m",
609
- * "originalEstimateSeconds": 600,
610
- * "remainingEstimate": "3m",
611
- * "remainingEstimateSeconds": 200,
612
- * "timeSpent": "6m",
613
- * "timeSpentSeconds": 400
614
- * }
615
- * },
616
- * "id": "10001",
617
- * "key": "HSP-1",
618
- * "self":
619
- * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
620
- * }
621
- * ],
622
- * "maxResults": 50,
623
- * "startAt": 0,
624
- * "total": 1
625
- * }
626
- * @path {GET} /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
627
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-epicid-issue-get
628
- */
629
- getBoardIssuesForEpic({ boardId, epicId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
630
- return this.getClientInstance()
631
- .request({
632
- path: "/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue",
633
- method: "GET",
634
- pathParams: {
635
- boardId,
636
- epicId,
637
- },
638
- query: {
639
- startAt,
640
- maxResults,
641
- jql,
642
- validateQuery,
643
- fields,
644
- expand,
645
- },
646
- })
647
- .then(this.getClientInstance().responseHandler({
648
- 200: {
649
- "application/json": "json",
650
- },
651
- }))
652
- .then(commonHttpClient.castResponse())
653
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardIssuesForEpic.response"))
654
- .then(commonHttpClient.getBody);
655
- }
656
- /**
657
- * Get all issues you have access to that belong to the sprint from the board.
658
- * Issue returned from this resource contains additional fields like: sprint,
659
- * closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order
660
- * has higher priority than default rank.
661
- *
662
- * @returns Returns the requested issues, at the specified page of the results.
663
- *
664
- * example: {
665
- * "expand": "names,schema",
666
- * "issues": [
667
- * {
668
- * "expand": "",
669
- * "fields": {
670
- * "flagged": true,
671
- * "sprint": {
672
- * "id": 37,
673
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
674
- * "state": "future",
675
- * "name": "sprint 2",
676
- * "goal": "sprint 2 goal"
677
- * },
678
- * "closedSprints": [
679
- * {
680
- * "id": 37,
681
- * "self":
682
- * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
683
- * "state": "closed",
684
- * "name": "sprint 1",
685
- * "startDate": "2015-04-11T15:22:00.000+10:00",
686
- * "endDate": "2015-04-20T01:22:00.000+10:00",
687
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
688
- * "goal": "sprint 1 goal"
689
- * }
690
- * ],
691
- * "description": "example bug report",
692
- * "project": {
693
- * "avatarUrls": {
694
- * "16x16":
695
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
696
- * "24x24":
697
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
698
- * "32x32":
699
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
700
- * "48x48":
701
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
702
- * },
703
- * "id": "10000",
704
- * "insight": {
705
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
706
- * "totalIssueCount": 100
707
- * },
708
- * "key": "EX",
709
- * "name": "Example",
710
- * "projectCategory": {
711
- * "description": "First Project Category",
712
- * "id": "10000",
713
- * "name": "FIRST",
714
- * "self":
715
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
716
- * },
717
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
718
- * "simplified": false,
719
- * "style": "classic"
720
- * },
721
- * "comment": [
722
- * {
723
- * "author": {
724
- * "accountId": "5b10a2844c20165700ede21g",
725
- * "active": false,
726
- * "displayName": "Mia Krystof",
727
- * "self":
728
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
729
- * },
730
- * "body": {
731
- * "type": "doc",
732
- * "version": 1,
733
- * "content": [
734
- * {
735
- * "type": "paragraph",
736
- * "content": [
737
- * {
738
- * "type": "text",
739
- * "text": "Lorem ipsum dolor sit amet, consectetur
740
- * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
741
- * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
742
- * semper."
743
- * }
744
- * ]
745
- * }
746
- * ]
747
- * },
748
- * "created": "2021-01-17T12:34:00.000+0000",
749
- * "id": "10000",
750
- * "self":
751
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
752
- * "updateAuthor": {
753
- * "accountId": "5b10a2844c20165700ede21g",
754
- * "active": false,
755
- * "displayName": "Mia Krystof",
756
- * "self":
757
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
758
- * },
759
- * "updated": "2021-01-18T23:45:00.000+0000",
760
- * "visibility": {
761
- * "identifier": "Administrators",
762
- * "type": "role",
763
- * "value": "Administrators"
764
- * }
765
- * }
766
- * ],
767
- * "epic": {
768
- * "id": 37,
769
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
770
- * "name": "epic 1",
771
- * "summary": "epic 1 summary",
772
- * "color": {
773
- * "key": "color_4"
774
- * },
775
- * "done": true
776
- * },
777
- * "worklog": [
778
- * {
779
- * "author": {
780
- * "accountId": "5b10a2844c20165700ede21g",
781
- * "active": false,
782
- * "displayName": "Mia Krystof",
783
- * "self":
784
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
785
- * },
786
- * "comment": {
787
- * "type": "doc",
788
- * "version": 1,
789
- * "content": [
790
- * {
791
- * "type": "paragraph",
792
- * "content": [
793
- * {
794
- * "type": "text",
795
- * "text": "I did some work here."
796
- * }
797
- * ]
798
- * }
799
- * ]
800
- * },
801
- * "id": "100028",
802
- * "issueId": "10002",
803
- * "self":
804
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
805
- * "started": "2021-01-17T12:34:00.000+0000",
806
- * "timeSpent": "3h 20m",
807
- * "timeSpentSeconds": 12000,
808
- * "updateAuthor": {
809
- * "accountId": "5b10a2844c20165700ede21g",
810
- * "active": false,
811
- * "displayName": "Mia Krystof",
812
- * "self":
813
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
814
- * },
815
- * "updated": "2021-01-18T23:45:00.000+0000",
816
- * "visibility": {
817
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
818
- * "type": "group",
819
- * "value": "jira-developers"
820
- * }
821
- * }
822
- * ],
823
- * "updated": 1,
824
- * "timetracking": {
825
- * "originalEstimate": "10m",
826
- * "originalEstimateSeconds": 600,
827
- * "remainingEstimate": "3m",
828
- * "remainingEstimateSeconds": 200,
829
- * "timeSpent": "6m",
830
- * "timeSpentSeconds": 400
831
- * }
832
- * },
833
- * "id": "10001",
834
- * "key": "HSP-1",
835
- * "self":
836
- * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
837
- * }
838
- * ],
839
- * "maxResults": 50,
840
- * "startAt": 0,
841
- * "total": 1
842
- * }
843
- * @path {GET} /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
844
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-sprintid-issue-get
845
- */
846
- getBoardIssuesForSprint({ boardId, sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
847
- return this.getClientInstance()
848
- .request({
849
- path: "/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue",
850
- method: "GET",
851
- pathParams: {
852
- boardId,
853
- sprintId,
854
- },
855
- query: {
856
- startAt,
857
- maxResults,
858
- jql,
859
- validateQuery,
860
- fields,
861
- expand,
862
- },
863
- })
864
- .then(this.getClientInstance().responseHandler({
865
- 200: {
866
- "application/json": "json",
867
- },
868
- }))
869
- .then(commonHttpClient.castResponse())
870
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardIssuesForSprint.response"))
871
- .then(commonHttpClient.getBody);
872
- }
873
- /**
874
- * Returns the value of the property with a given key from the board identified by
875
- * the provided id. The user who retrieves the property is required to have
876
- * permissions to view the board.
877
- *
878
- * @returns Returned if the board exists and the property was found.
879
- * @path {GET} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
880
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get
881
- */
882
- getBoardProperty({ boardId, propertyKey, }) {
883
- return this.getClientInstance()
884
- .request({
885
- path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
886
- method: "GET",
887
- pathParams: {
888
- boardId,
889
- propertyKey,
890
- },
891
- })
892
- .then(this.getClientInstance().responseHandler({
893
- 200: {
894
- "application/json": "json",
895
- },
896
- }))
897
- .then(commonHttpClient.castResponse())
898
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardProperty.response"))
899
- .then(commonHttpClient.getBody);
900
- }
901
- /**
902
- * Returns the keys of all properties for the board identified by the id. The user
903
- * who retrieves the property keys is required to have permissions to view the
904
- * board.
905
- *
906
- * @returns Returned if the board with given id exists.
907
- * @path {GET} /rest/agile/1.0/board/{boardId}/properties
908
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
909
- */
910
- getBoardPropertyKeys({ boardId, }) {
911
- return this.getClientInstance()
912
- .request({
913
- path: "/rest/agile/1.0/board/{boardId}/properties",
914
- method: "GET",
915
- pathParams: {
916
- boardId,
917
- },
918
- })
919
- .then(this.getClientInstance().responseHandler({
920
- 200: {
921
- "application/json": "json",
922
- },
923
- }))
924
- .then(commonHttpClient.castResponse())
925
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardPropertyKeys.response"))
926
- .then(commonHttpClient.getBody);
927
- }
928
- /**
929
- * Get the board configuration. The response contains the following fields:
930
- *
931
- * * `id` \- ID of the board.
932
- * * `name` \- Name of the board.
933
- * * `filter` \- Reference to the filter used by the given board.
934
- * * `location` \- Reference to the container that the board is located in.
935
- * Includes the container type (Valid values: project, user).
936
- * * `subQuery` (Kanban only) - JQL subquery used by the given board.
937
- * * `columnConfig` \- The column configuration lists the columns for the board,
938
- * in the order defined in the column configuration. For each column, it shows the
939
- * issue status mapping as well as the constraint type (Valid values: none,
940
- * issueCount, issueCountExclSubs) for the min/max number of issues. Note, the
941
- * last column with statuses mapped to it is treated as the "Done" column, which
942
- * means that issues in that column will be marked as already completed.
943
- * * `estimation` (Scrum only) - Contains information about type of estimation
944
- * used for the board. Valid values: none, issueCount, field. If the estimation
945
- * type is "field", the ID and display name of the field used for estimation is
946
- * also returned. Note, estimates for an issue can be updated by a PUT
947
- * /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the
948
- * screen. "timeoriginalestimate" field will never be on the screen, so in order
949
- * to update it "originalEstimate" in "timetracking" field should be updated.
950
- * * `ranking` \- Contains information about custom field used for ranking in
951
- * the given board.
952
- *
953
- * @returns Returns the configuration of the board for given boardId.
954
- *
955
- * example: {
956
- * "columnConfig": {
957
- * "columns": [
958
- * {
959
- * "name": "To Do",
960
- * "statuses": [
961
- * {
962
- * "id": "1",
963
- * "self": "https://your-domain.atlassian.net/status/1"
964
- * },
965
- * {
966
- * "id": "4",
967
- * "self": "https://your-domain.atlassian.net/status/4"
968
- * }
969
- * ]
970
- * },
971
- * {
972
- * "max": 4,
973
- * "min": 2,
974
- * "name": "In progress",
975
- * "statuses": [
976
- * {
977
- * "id": "3",
978
- * "self": "https://your-domain.atlassian.net/status/3"
979
- * }
980
- * ]
981
- * },
982
- * {
983
- * "name": "Done",
984
- * "statuses": [
985
- * {
986
- * "id": "5",
987
- * "self": "https://your-domain.atlassian.net/status/5"
988
- * }
989
- * ]
990
- * }
991
- * ],
992
- * "constraintType": "issueCount"
993
- * },
994
- * "estimation": {
995
- * "field": {
996
- * "displayName": "Story Points",
997
- * "fieldId": "customfield_10002"
998
- * },
999
- * "type": "field"
1000
- * },
1001
- * "filter": {
1002
- * "id": "1001",
1003
- * "self": "https://your-domain.atlassian.net/filter/1001"
1004
- * },
1005
- * "id": 10000,
1006
- * "location": {
1007
- * "id": "10010",
1008
- * "key": "PROJ",
1009
- * "name": "name",
1010
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/10010",
1011
- * "type": "project"
1012
- * },
1013
- * "name": "Board",
1014
- * "ranking": {
1015
- * "rankCustomFieldId": 10020
1016
- * },
1017
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
1018
- * }
1019
- * @path {GET} /rest/agile/1.0/board/{boardId}/configuration
1020
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-configuration-get
1021
- */
1022
- getConfiguration({ boardId, }) {
1023
- return this.getClientInstance()
1024
- .request({
1025
- path: "/rest/agile/1.0/board/{boardId}/configuration",
1026
- method: "GET",
1027
- pathParams: {
1028
- boardId,
1029
- },
1030
- })
1031
- .then(this.getClientInstance().responseHandler({
1032
- 200: {
1033
- "application/json": "json",
1034
- },
1035
- }))
1036
- .then(commonHttpClient.castResponse())
1037
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getConfiguration.response"))
1038
- .then(commonHttpClient.getBody);
1039
- }
1040
- /**
1041
- * Returns all epics from the board, for the given board ID. This only includes
1042
- * epics that the user has permission to view. Note, if the user does not have
1043
- * permission to view the board, no epics will be returned at all.
1044
- *
1045
- * @returns Returns the requested epics, at the specified page of the results.
1046
- *
1047
- * example: {
1048
- * "isLast": false,
1049
- * "maxResults": 2,
1050
- * "startAt": 1,
1051
- * "total": 5,
1052
- * "values": [
1053
- * {
1054
- * "id": 37,
1055
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1056
- * "name": "epic 1",
1057
- * "summary": "epic 1 summary",
1058
- * "color": {
1059
- * "key": "color_4"
1060
- * },
1061
- * "done": true
1062
- * },
1063
- * {
1064
- * "id": 37,
1065
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/13",
1066
- * "name": "epic 2",
1067
- * "summary": "epic 2 summary",
1068
- * "color": {
1069
- * "key": "color_2"
1070
- * },
1071
- * "done": false
1072
- * }
1073
- * ]
1074
- * }
1075
- * @path {GET} /rest/agile/1.0/board/{boardId}/epic
1076
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-get
1077
- */
1078
- getEpics({ boardId, startAt, maxResults, done, }) {
1079
- return this.getClientInstance()
1080
- .request({
1081
- path: "/rest/agile/1.0/board/{boardId}/epic",
1082
- method: "GET",
1083
- pathParams: {
1084
- boardId,
1085
- },
1086
- query: {
1087
- startAt,
1088
- maxResults,
1089
- done,
1090
- },
1091
- })
1092
- .then(this.getClientInstance().responseHandler({
1093
- 200: {
1094
- "application/json": "json",
1095
- },
1096
- }))
1097
- .then(commonHttpClient.castResponse())
1098
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getEpics.response"))
1099
- .then(commonHttpClient.getBody);
1100
- }
1101
- /**
1102
- * @returns 200 response
1103
- * @path {GET} /rest/agile/1.0/board/{boardId}/features
1104
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-get
1105
- */
1106
- getFeaturesForBoard({ boardId, }) {
1107
- return this.getClientInstance()
1108
- .request({
1109
- path: "/rest/agile/1.0/board/{boardId}/features",
1110
- method: "GET",
1111
- pathParams: {
1112
- boardId,
1113
- },
1114
- })
1115
- .then(this.getClientInstance().responseHandler({
1116
- 200: {
1117
- "application/json": "json",
1118
- },
1119
- }))
1120
- .then(commonHttpClient.castResponse())
1121
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getFeaturesForBoard.response"))
1122
- .then(commonHttpClient.getBody);
1123
- }
1124
- /**
1125
- * Returns all issues from the board's backlog, for the given board ID. This only
1126
- * includes issues that the user has permission to view. The backlog contains
1127
- * incomplete issues that are not assigned to any future or active sprint. Note,
1128
- * if the user does not have permission to view the board, no issues will be
1129
- * returned at all. Issues returned from this resource include Agile fields, like
1130
- * sprint, closedSprints, flagged, and epic. By default, the returned issues are
1131
- * ordered by rank.
1132
- *
1133
- * @returns Returns the requested issues, at the specified page of the results.
1134
- *
1135
- * example: {
1136
- * "expand": "names,schema",
1137
- * "issues": [
1138
- * {
1139
- * "expand": "",
1140
- * "fields": {
1141
- * "flagged": true,
1142
- * "sprint": {
1143
- * "id": 37,
1144
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1145
- * "state": "future",
1146
- * "name": "sprint 2",
1147
- * "goal": "sprint 2 goal"
1148
- * },
1149
- * "closedSprints": [
1150
- * {
1151
- * "id": 37,
1152
- * "self":
1153
- * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1154
- * "state": "closed",
1155
- * "name": "sprint 1",
1156
- * "startDate": "2015-04-11T15:22:00.000+10:00",
1157
- * "endDate": "2015-04-20T01:22:00.000+10:00",
1158
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
1159
- * "goal": "sprint 1 goal"
1160
- * }
1161
- * ],
1162
- * "description": "example bug report",
1163
- * "project": {
1164
- * "avatarUrls": {
1165
- * "16x16":
1166
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1167
- * "24x24":
1168
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1169
- * "32x32":
1170
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1171
- * "48x48":
1172
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1173
- * },
1174
- * "id": "10000",
1175
- * "insight": {
1176
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1177
- * "totalIssueCount": 100
1178
- * },
1179
- * "key": "EX",
1180
- * "name": "Example",
1181
- * "projectCategory": {
1182
- * "description": "First Project Category",
1183
- * "id": "10000",
1184
- * "name": "FIRST",
1185
- * "self":
1186
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1187
- * },
1188
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1189
- * "simplified": false,
1190
- * "style": "classic"
1191
- * },
1192
- * "comment": [
1193
- * {
1194
- * "author": {
1195
- * "accountId": "5b10a2844c20165700ede21g",
1196
- * "active": false,
1197
- * "displayName": "Mia Krystof",
1198
- * "self":
1199
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1200
- * },
1201
- * "body": {
1202
- * "type": "doc",
1203
- * "version": 1,
1204
- * "content": [
1205
- * {
1206
- * "type": "paragraph",
1207
- * "content": [
1208
- * {
1209
- * "type": "text",
1210
- * "text": "Lorem ipsum dolor sit amet, consectetur
1211
- * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1212
- * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1213
- * semper."
1214
- * }
1215
- * ]
1216
- * }
1217
- * ]
1218
- * },
1219
- * "created": "2021-01-17T12:34:00.000+0000",
1220
- * "id": "10000",
1221
- * "self":
1222
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1223
- * "updateAuthor": {
1224
- * "accountId": "5b10a2844c20165700ede21g",
1225
- * "active": false,
1226
- * "displayName": "Mia Krystof",
1227
- * "self":
1228
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1229
- * },
1230
- * "updated": "2021-01-18T23:45:00.000+0000",
1231
- * "visibility": {
1232
- * "identifier": "Administrators",
1233
- * "type": "role",
1234
- * "value": "Administrators"
1235
- * }
1236
- * }
1237
- * ],
1238
- * "epic": {
1239
- * "id": 37,
1240
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1241
- * "name": "epic 1",
1242
- * "summary": "epic 1 summary",
1243
- * "color": {
1244
- * "key": "color_4"
1245
- * },
1246
- * "done": true
1247
- * },
1248
- * "worklog": [
1249
- * {
1250
- * "author": {
1251
- * "accountId": "5b10a2844c20165700ede21g",
1252
- * "active": false,
1253
- * "displayName": "Mia Krystof",
1254
- * "self":
1255
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1256
- * },
1257
- * "comment": {
1258
- * "type": "doc",
1259
- * "version": 1,
1260
- * "content": [
1261
- * {
1262
- * "type": "paragraph",
1263
- * "content": [
1264
- * {
1265
- * "type": "text",
1266
- * "text": "I did some work here."
1267
- * }
1268
- * ]
1269
- * }
1270
- * ]
1271
- * },
1272
- * "id": "100028",
1273
- * "issueId": "10002",
1274
- * "self":
1275
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1276
- * "started": "2021-01-17T12:34:00.000+0000",
1277
- * "timeSpent": "3h 20m",
1278
- * "timeSpentSeconds": 12000,
1279
- * "updateAuthor": {
1280
- * "accountId": "5b10a2844c20165700ede21g",
1281
- * "active": false,
1282
- * "displayName": "Mia Krystof",
1283
- * "self":
1284
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1285
- * },
1286
- * "updated": "2021-01-18T23:45:00.000+0000",
1287
- * "visibility": {
1288
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1289
- * "type": "group",
1290
- * "value": "jira-developers"
1291
- * }
1292
- * }
1293
- * ],
1294
- * "updated": 1,
1295
- * "timetracking": {
1296
- * "originalEstimate": "10m",
1297
- * "originalEstimateSeconds": 600,
1298
- * "remainingEstimate": "3m",
1299
- * "remainingEstimateSeconds": 200,
1300
- * "timeSpent": "6m",
1301
- * "timeSpentSeconds": 400
1302
- * }
1303
- * },
1304
- * "id": "10001",
1305
- * "key": "HSP-1",
1306
- * "self":
1307
- * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1308
- * }
1309
- * ],
1310
- * "maxResults": 50,
1311
- * "startAt": 0,
1312
- * "total": 1
1313
- * }
1314
- * @path {GET} /rest/agile/1.0/board/{boardId}/backlog
1315
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-backlog-get
1316
- */
1317
- getIssuesForBacklog({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
1318
- return this.getClientInstance()
1319
- .request({
1320
- path: "/rest/agile/1.0/board/{boardId}/backlog",
1321
- method: "GET",
1322
- pathParams: {
1323
- boardId,
1324
- },
1325
- query: {
1326
- startAt,
1327
- maxResults,
1328
- jql,
1329
- validateQuery,
1330
- fields,
1331
- expand,
1332
- },
1333
- })
1334
- .then(this.getClientInstance().responseHandler({
1335
- 200: {
1336
- "application/json": "json",
1337
- },
1338
- }))
1339
- .then(commonHttpClient.castResponse())
1340
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesForBacklog.response"))
1341
- .then(commonHttpClient.getBody);
1342
- }
1343
- /**
1344
- * Returns all issues from a board, for a given board ID. This only includes
1345
- * issues that the user has permission to view. An issue belongs to the board if
1346
- * its status is mapped to the board's column. Epic issues do not belongs to the
1347
- * scrum boards. Note, if the user does not have permission to view the board, no
1348
- * issues will be returned at all. Issues returned from this resource include
1349
- * Agile fields, like sprint, closedSprints, flagged, and epic. By default, the
1350
- * returned issues are ordered by rank.
1351
- *
1352
- * @returns Returns the requested issues, at the specified page of the results.
1353
- *
1354
- * example: {
1355
- * "expand": "names,schema",
1356
- * "issues": [
1357
- * {
1358
- * "expand": "",
1359
- * "fields": {
1360
- * "flagged": true,
1361
- * "sprint": {
1362
- * "id": 37,
1363
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1364
- * "state": "future",
1365
- * "name": "sprint 2",
1366
- * "goal": "sprint 2 goal"
1367
- * },
1368
- * "closedSprints": [
1369
- * {
1370
- * "id": 37,
1371
- * "self":
1372
- * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1373
- * "state": "closed",
1374
- * "name": "sprint 1",
1375
- * "startDate": "2015-04-11T15:22:00.000+10:00",
1376
- * "endDate": "2015-04-20T01:22:00.000+10:00",
1377
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
1378
- * "goal": "sprint 1 goal"
1379
- * }
1380
- * ],
1381
- * "description": "example bug report",
1382
- * "project": {
1383
- * "avatarUrls": {
1384
- * "16x16":
1385
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1386
- * "24x24":
1387
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1388
- * "32x32":
1389
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1390
- * "48x48":
1391
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1392
- * },
1393
- * "id": "10000",
1394
- * "insight": {
1395
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1396
- * "totalIssueCount": 100
1397
- * },
1398
- * "key": "EX",
1399
- * "name": "Example",
1400
- * "projectCategory": {
1401
- * "description": "First Project Category",
1402
- * "id": "10000",
1403
- * "name": "FIRST",
1404
- * "self":
1405
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1406
- * },
1407
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1408
- * "simplified": false,
1409
- * "style": "classic"
1410
- * },
1411
- * "comment": [
1412
- * {
1413
- * "author": {
1414
- * "accountId": "5b10a2844c20165700ede21g",
1415
- * "active": false,
1416
- * "displayName": "Mia Krystof",
1417
- * "self":
1418
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1419
- * },
1420
- * "body": {
1421
- * "type": "doc",
1422
- * "version": 1,
1423
- * "content": [
1424
- * {
1425
- * "type": "paragraph",
1426
- * "content": [
1427
- * {
1428
- * "type": "text",
1429
- * "text": "Lorem ipsum dolor sit amet, consectetur
1430
- * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1431
- * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1432
- * semper."
1433
- * }
1434
- * ]
1435
- * }
1436
- * ]
1437
- * },
1438
- * "created": "2021-01-17T12:34:00.000+0000",
1439
- * "id": "10000",
1440
- * "self":
1441
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1442
- * "updateAuthor": {
1443
- * "accountId": "5b10a2844c20165700ede21g",
1444
- * "active": false,
1445
- * "displayName": "Mia Krystof",
1446
- * "self":
1447
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1448
- * },
1449
- * "updated": "2021-01-18T23:45:00.000+0000",
1450
- * "visibility": {
1451
- * "identifier": "Administrators",
1452
- * "type": "role",
1453
- * "value": "Administrators"
1454
- * }
1455
- * }
1456
- * ],
1457
- * "epic": {
1458
- * "id": 37,
1459
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1460
- * "name": "epic 1",
1461
- * "summary": "epic 1 summary",
1462
- * "color": {
1463
- * "key": "color_4"
1464
- * },
1465
- * "done": true
1466
- * },
1467
- * "worklog": [
1468
- * {
1469
- * "author": {
1470
- * "accountId": "5b10a2844c20165700ede21g",
1471
- * "active": false,
1472
- * "displayName": "Mia Krystof",
1473
- * "self":
1474
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1475
- * },
1476
- * "comment": {
1477
- * "type": "doc",
1478
- * "version": 1,
1479
- * "content": [
1480
- * {
1481
- * "type": "paragraph",
1482
- * "content": [
1483
- * {
1484
- * "type": "text",
1485
- * "text": "I did some work here."
1486
- * }
1487
- * ]
1488
- * }
1489
- * ]
1490
- * },
1491
- * "id": "100028",
1492
- * "issueId": "10002",
1493
- * "self":
1494
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1495
- * "started": "2021-01-17T12:34:00.000+0000",
1496
- * "timeSpent": "3h 20m",
1497
- * "timeSpentSeconds": 12000,
1498
- * "updateAuthor": {
1499
- * "accountId": "5b10a2844c20165700ede21g",
1500
- * "active": false,
1501
- * "displayName": "Mia Krystof",
1502
- * "self":
1503
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1504
- * },
1505
- * "updated": "2021-01-18T23:45:00.000+0000",
1506
- * "visibility": {
1507
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1508
- * "type": "group",
1509
- * "value": "jira-developers"
1510
- * }
1511
- * }
1512
- * ],
1513
- * "updated": 1,
1514
- * "timetracking": {
1515
- * "originalEstimate": "10m",
1516
- * "originalEstimateSeconds": 600,
1517
- * "remainingEstimate": "3m",
1518
- * "remainingEstimateSeconds": 200,
1519
- * "timeSpent": "6m",
1520
- * "timeSpentSeconds": 400
1521
- * }
1522
- * },
1523
- * "id": "10001",
1524
- * "key": "HSP-1",
1525
- * "self":
1526
- * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1527
- * }
1528
- * ],
1529
- * "maxResults": 50,
1530
- * "startAt": 0,
1531
- * "total": 1
1532
- * }
1533
- * @path {GET} /rest/agile/1.0/board/{boardId}/issue
1534
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
1535
- */
1536
- getIssuesForBoard({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
1537
- return this.getClientInstance()
1538
- .request({
1539
- path: "/rest/agile/1.0/board/{boardId}/issue",
1540
- method: "GET",
1541
- pathParams: {
1542
- boardId,
1543
- },
1544
- query: {
1545
- startAt,
1546
- maxResults,
1547
- jql,
1548
- validateQuery,
1549
- fields,
1550
- expand,
1551
- },
1552
- })
1553
- .then(this.getClientInstance().responseHandler({
1554
- 200: {
1555
- "application/json": "json",
1556
- },
1557
- }))
1558
- .then(commonHttpClient.castResponse())
1559
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesForBoard.response"))
1560
- .then(commonHttpClient.getBody);
1561
- }
1562
- /**
1563
- * Returns all issues that do not belong to any epic on a board, for a given board
1564
- * ID. This only includes issues that the user has permission to view. Issues
1565
- * returned from this resource include Agile fields, like sprint, closedSprints,
1566
- * flagged, and epic. By default, the returned issues are ordered by rank.
1567
- *
1568
- * @returns Returns the requested issues, at the specified page of the results.
1569
- *
1570
- * example: {
1571
- * "expand": "names,schema",
1572
- * "issues": [
1573
- * {
1574
- * "expand": "",
1575
- * "fields": {
1576
- * "flagged": true,
1577
- * "sprint": {
1578
- * "id": 37,
1579
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1580
- * "state": "future",
1581
- * "name": "sprint 2",
1582
- * "goal": "sprint 2 goal"
1583
- * },
1584
- * "closedSprints": [
1585
- * {
1586
- * "id": 37,
1587
- * "self":
1588
- * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1589
- * "state": "closed",
1590
- * "name": "sprint 1",
1591
- * "startDate": "2015-04-11T15:22:00.000+10:00",
1592
- * "endDate": "2015-04-20T01:22:00.000+10:00",
1593
- * "completeDate": "2015-04-20T11:04:00.000+10:00",
1594
- * "goal": "sprint 1 goal"
1595
- * }
1596
- * ],
1597
- * "description": "example bug report",
1598
- * "project": {
1599
- * "avatarUrls": {
1600
- * "16x16":
1601
- * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1602
- * "24x24":
1603
- * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1604
- * "32x32":
1605
- * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1606
- * "48x48":
1607
- * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1608
- * },
1609
- * "id": "10000",
1610
- * "insight": {
1611
- * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1612
- * "totalIssueCount": 100
1613
- * },
1614
- * "key": "EX",
1615
- * "name": "Example",
1616
- * "projectCategory": {
1617
- * "description": "First Project Category",
1618
- * "id": "10000",
1619
- * "name": "FIRST",
1620
- * "self":
1621
- * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1622
- * },
1623
- * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1624
- * "simplified": false,
1625
- * "style": "classic"
1626
- * },
1627
- * "comment": [
1628
- * {
1629
- * "author": {
1630
- * "accountId": "5b10a2844c20165700ede21g",
1631
- * "active": false,
1632
- * "displayName": "Mia Krystof",
1633
- * "self":
1634
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1635
- * },
1636
- * "body": {
1637
- * "type": "doc",
1638
- * "version": 1,
1639
- * "content": [
1640
- * {
1641
- * "type": "paragraph",
1642
- * "content": [
1643
- * {
1644
- * "type": "text",
1645
- * "text": "Lorem ipsum dolor sit amet, consectetur
1646
- * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1647
- * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1648
- * semper."
1649
- * }
1650
- * ]
1651
- * }
1652
- * ]
1653
- * },
1654
- * "created": "2021-01-17T12:34:00.000+0000",
1655
- * "id": "10000",
1656
- * "self":
1657
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1658
- * "updateAuthor": {
1659
- * "accountId": "5b10a2844c20165700ede21g",
1660
- * "active": false,
1661
- * "displayName": "Mia Krystof",
1662
- * "self":
1663
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1664
- * },
1665
- * "updated": "2021-01-18T23:45:00.000+0000",
1666
- * "visibility": {
1667
- * "identifier": "Administrators",
1668
- * "type": "role",
1669
- * "value": "Administrators"
1670
- * }
1671
- * }
1672
- * ],
1673
- * "epic": {
1674
- * "id": 37,
1675
- * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1676
- * "name": "epic 1",
1677
- * "summary": "epic 1 summary",
1678
- * "color": {
1679
- * "key": "color_4"
1680
- * },
1681
- * "done": true
1682
- * },
1683
- * "worklog": [
1684
- * {
1685
- * "author": {
1686
- * "accountId": "5b10a2844c20165700ede21g",
1687
- * "active": false,
1688
- * "displayName": "Mia Krystof",
1689
- * "self":
1690
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1691
- * },
1692
- * "comment": {
1693
- * "type": "doc",
1694
- * "version": 1,
1695
- * "content": [
1696
- * {
1697
- * "type": "paragraph",
1698
- * "content": [
1699
- * {
1700
- * "type": "text",
1701
- * "text": "I did some work here."
1702
- * }
1703
- * ]
1704
- * }
1705
- * ]
1706
- * },
1707
- * "id": "100028",
1708
- * "issueId": "10002",
1709
- * "self":
1710
- * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1711
- * "started": "2021-01-17T12:34:00.000+0000",
1712
- * "timeSpent": "3h 20m",
1713
- * "timeSpentSeconds": 12000,
1714
- * "updateAuthor": {
1715
- * "accountId": "5b10a2844c20165700ede21g",
1716
- * "active": false,
1717
- * "displayName": "Mia Krystof",
1718
- * "self":
1719
- * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1720
- * },
1721
- * "updated": "2021-01-18T23:45:00.000+0000",
1722
- * "visibility": {
1723
- * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1724
- * "type": "group",
1725
- * "value": "jira-developers"
1726
- * }
1727
- * }
1728
- * ],
1729
- * "updated": 1,
1730
- * "timetracking": {
1731
- * "originalEstimate": "10m",
1732
- * "originalEstimateSeconds": 600,
1733
- * "remainingEstimate": "3m",
1734
- * "remainingEstimateSeconds": 200,
1735
- * "timeSpent": "6m",
1736
- * "timeSpentSeconds": 400
1737
- * }
1738
- * },
1739
- * "id": "10001",
1740
- * "key": "HSP-1",
1741
- * "self":
1742
- * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1743
- * }
1744
- * ],
1745
- * "maxResults": 50,
1746
- * "startAt": 0,
1747
- * "total": 1
1748
- * }
1749
- * @path {GET} /rest/agile/1.0/board/{boardId}/epic/none/issue
1750
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get
1751
- */
1752
- getIssuesWithoutEpicForBoard({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) {
1753
- return this.getClientInstance()
1754
- .request({
1755
- path: "/rest/agile/1.0/board/{boardId}/epic/none/issue",
1756
- method: "GET",
1757
- pathParams: {
1758
- boardId,
1759
- },
1760
- query: {
1761
- startAt,
1762
- maxResults,
1763
- jql,
1764
- validateQuery,
1765
- fields,
1766
- expand,
1767
- },
1768
- })
1769
- .then(this.getClientInstance().responseHandler({
1770
- 200: {
1771
- "application/json": "json",
1772
- },
1773
- }))
1774
- .then(commonHttpClient.castResponse())
1775
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesWithoutEpicForBoard.response"))
1776
- .then(commonHttpClient.getBody);
1777
- }
1778
- /**
1779
- * Returns all projects that are associated with the board, for the given board
1780
- * ID. If the user does not have permission to view the board, no projects will be
1781
- * returned at all. Returned projects are ordered by the name.
1782
- *
1783
- * A project is associated with a board if the board filter contains reference the
1784
- * project or there is an issue from the project that belongs to the board.
1785
- *
1786
- * The board filter contains reference the project only if JQL query guarantees
1787
- * that returned issues will be returned from the project set defined in JQL. For
1788
- * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
1789
- * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
1790
- * doesn't have reference to any project.
1791
- *
1792
- * An issue belongs to the board if its status is mapped to the board's column.
1793
- * Epic issues do not belongs to the scrum boards.
1794
- *
1795
- * @returns Returns the board's projects, at the specified page of the results.
1796
- *
1797
- * example: {
1798
- * "isLast": true,
1799
- * "maxResults": 10,
1800
- * "startAt": 0,
1801
- * "total": 2,
1802
- * "values": [
1803
- * {
1804
- * "avatarUrls": {
1805
- * "16x16": "secure/projectavatar?size=xsmall&pid=10000",
1806
- * "24x24": "secure/projectavatar?size=small&pid=10000",
1807
- * "32x32": "secure/projectavatar?size=medium&pid=10000",
1808
- * "48x48": "secure/projectavatar?size=large&pid=10000"
1809
- * },
1810
- * "id": "10000",
1811
- * "key": "EX",
1812
- * "name": "Example",
1813
- * "projectCategory": {
1814
- * "description": "Project category description",
1815
- * "id": "10000",
1816
- * "name": "A project category"
1817
- * },
1818
- * "projectTypeKey": "ProjectTypeKey{key='software'}",
1819
- * "self": "project/EX",
1820
- * "simplified": false
1821
- * }
1822
- * ]
1823
- * }
1824
- * @path {GET} /rest/agile/1.0/board/{boardId}/project
1825
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-get
1826
- */
1827
- getProjects({ boardId, startAt, maxResults, }) {
1828
- return this.getClientInstance()
1829
- .request({
1830
- path: "/rest/agile/1.0/board/{boardId}/project",
1831
- method: "GET",
1832
- pathParams: {
1833
- boardId,
1834
- },
1835
- query: {
1836
- startAt,
1837
- maxResults,
1838
- },
1839
- })
1840
- .then(this.getClientInstance().responseHandler({
1841
- 200: {
1842
- "application/json": "json",
1843
- },
1844
- }))
1845
- .then(commonHttpClient.castResponse())
1846
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getProjects.response"))
1847
- .then(commonHttpClient.getBody);
1848
- }
1849
- /**
1850
- * Returns all projects that are statically associated with the board, for the
1851
- * given board ID. Returned projects are ordered by the name.
1852
- *
1853
- * A project is associated with a board if the board filter contains reference the
1854
- * project.
1855
- *
1856
- * The board filter contains reference the project only if JQL query guarantees
1857
- * that returned issues will be returned from the project set defined in JQL. For
1858
- * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
1859
- * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
1860
- * doesn't have reference to any project.
1861
- *
1862
- * @path {GET} /rest/agile/1.0/board/{boardId}/project/full
1863
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-full-get
1864
- */
1865
- getProjectsFull({ boardId, }) {
1866
- return this.getClientInstance()
1867
- .request({
1868
- path: "/rest/agile/1.0/board/{boardId}/project/full",
1869
- method: "GET",
1870
- pathParams: {
1871
- boardId,
1872
- },
1873
- })
1874
- .then(commonHttpClient.discardResult);
1875
- }
1876
- /**
1877
- * Returns the quick filter for a given quick filter ID. The quick filter will
1878
- * only be returned if the user can view the board that the quick filter belongs
1879
- * to.
1880
- *
1881
- * @returns Returns the requested quick filter.
1882
- *
1883
- * example: {
1884
- * "boardId": 1,
1885
- * "description": "Issues of type bug",
1886
- * "id": 1,
1887
- * "jql": "issueType = bug",
1888
- * "name": "Bugs",
1889
- * "position": 0
1890
- * }
1891
- * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
1892
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-quickfilterid-get
1893
- */
1894
- getQuickFilter({ boardId, quickFilterId, }) {
1895
- return this.getClientInstance()
1896
- .request({
1897
- path: "/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}",
1898
- method: "GET",
1899
- pathParams: {
1900
- boardId,
1901
- quickFilterId,
1902
- },
1903
- })
1904
- .then(this.getClientInstance().responseHandler({
1905
- 200: {
1906
- "application/json": "json",
1907
- },
1908
- }))
1909
- .then(commonHttpClient.castResponse())
1910
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getQuickFilter.response"))
1911
- .then(commonHttpClient.getBody);
1912
- }
1913
- /**
1914
- * @returns 200 response
1915
- * @path {GET} /rest/agile/1.0/board/{boardId}/reports
1916
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-reports-get
1917
- */
1918
- getReportsForBoard({ boardId, }) {
1919
- return this.getClientInstance()
1920
- .request({
1921
- path: "/rest/agile/1.0/board/{boardId}/reports",
1922
- method: "GET",
1923
- pathParams: {
1924
- boardId,
1925
- },
1926
- })
1927
- .then(this.getClientInstance().responseHandler({
1928
- 200: {
1929
- "application/json": "json",
1930
- },
1931
- }))
1932
- .then(commonHttpClient.castResponse())
1933
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getReportsForBoard.response"))
1934
- .then(commonHttpClient.getBody);
1935
- }
1936
- /**
1937
- * Move issues from the backog to the board (if they are already in the backlog of
1938
- * that board).
1939
- * This operation either moves an issue(s) onto a board from the backlog (by
1940
- * adding it to the issueList for the board) Or transitions the issue(s) to the
1941
- * first column for a kanban board with backlog. At most 50 issues may be moved at
1942
- * once.
1943
- *
1944
- * @returns Returns the list of issue with status of rank operation.
1945
- *
1946
- * example: {
1947
- * "entries": [
1948
- * {
1949
- * "issueId": 10000,
1950
- * "issueKey": "PR-1",
1951
- * "status": 200
1952
- * },
1953
- * {
1954
- * "issueId": 10001,
1955
- * "issueKey": "PR-2",
1956
- * "status": 200
1957
- * },
1958
- * {
1959
- * "errors": [
1960
- * "JIRA Agile cannot execute the rank operation at this time. Please try
1961
- * again later."
1962
- * ],
1963
- * "issueId": 10002,
1964
- * "issueKey": "PR-3",
1965
- * "status": 503
1966
- * }
1967
- * ]
1968
- * }
1969
- * @path {POST} /rest/agile/1.0/board/{boardId}/issue
1970
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-post
1971
- */
1972
- moveIssuesToBoard({ boardId, issueRankRequestBean, }) {
1973
- return this.getClientInstance()
1974
- .request({
1975
- path: "/rest/agile/1.0/board/{boardId}/issue",
1976
- method: "POST",
1977
- pathParams: {
1978
- boardId,
1979
- },
1980
- headers: {
1981
- "Content-Type": "application/json",
1982
- },
1983
- body: issueRankRequestBean,
1984
- })
1985
- .then(this.getClientInstance().responseHandler({
1986
- 204: {},
1987
- 207: {
1988
- "application/json": "json",
1989
- },
1990
- }))
1991
- .then(commonHttpClient.castResponse())
1992
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.moveIssuesToBoard.response"))
1993
- .then(commonHttpClient.getBody);
1994
- }
1995
- /**
1996
- * Sets the value of the specified board's property.
1997
- *
1998
- * You can use this resource to store a custom data against the board identified
1999
- * by the id. The user who stores the data is required to have permissions to
2000
- * modify the board.
2001
- *
2002
- * @returns * status: 200, mediaType: application/json
2003
- *
2004
- * Returned if the board property is successfully updated.
2005
- *
2006
- * * status: 201, mediaType: application/json
2007
- *
2008
- * Returned if the board property is successfully created.
2009
- * @path {PUT} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
2010
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-put
2011
- */
2012
- setBoardProperty({ boardId, propertyKey, requestBody, }) {
2013
- return this.getClientInstance()
2014
- .request({
2015
- path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
2016
- method: "PUT",
2017
- pathParams: {
2018
- boardId,
2019
- propertyKey,
2020
- },
2021
- headers: {
2022
- "Content-Type": "application/json",
2023
- },
2024
- body: requestBody,
2025
- })
2026
- .then(this.getClientInstance().responseHandler({
2027
- 200: {
2028
- "application/json": "json",
2029
- },
2030
- 201: {
2031
- "application/json": "json",
2032
- },
2033
- }))
2034
- .then(commonHttpClient.castResponse())
2035
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.setBoardProperty.response"))
2036
- .then(commonHttpClient.asCreatedResponse("body"));
2037
- }
2038
- /**
2039
- * @returns 200 response
2040
- * @path {PUT} /rest/agile/1.0/board/{boardId}/features
2041
- * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-put
2042
- */
2043
- toggleFeatures({ boardId, featureToggleRequestBean, }) {
2044
- return this.getClientInstance()
2045
- .request({
2046
- path: "/rest/agile/1.0/board/{boardId}/features",
2047
- method: "PUT",
2048
- pathParams: {
2049
- boardId,
2050
- },
2051
- headers: {
2052
- "Content-Type": "application/json",
2053
- },
2054
- body: featureToggleRequestBean,
2055
- })
2056
- .then(this.getClientInstance().responseHandler({
2057
- 200: {
2058
- "application/json": "json",
2059
- },
2060
- }))
2061
- .then(commonHttpClient.castResponse())
2062
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.toggleFeatures.response"))
2063
- .then(commonHttpClient.getBody);
19
+ constructor() {
20
+ super(...arguments);
21
+ /**
22
+ * Creates a new board. Board name, type and filter ID is required.
23
+ *
24
+ * * `name` \- Must be less than 255 characters.
25
+ * * `type` \- Valid values: scrum, kanban
26
+ * * `filterId` \- ID of a filter that the user has permissions to view. Note,
27
+ * if the user does not have the 'Create shared objects' permission and tries to
28
+ * create a shared board, a private board will be created instead (remember that
29
+ * board sharing depends on the filter sharing).
30
+ * * `location` \- The container that the board will be located in. `location`
31
+ * must include the `type` property (Valid values: project, user). If choosing
32
+ * 'project', then a project must be specified by a `projectKeyOrId` property in
33
+ * `location`. If choosing 'user', the current user is chosen by default. The
34
+ * `projectKeyOrId` property should not be provided.
35
+ *
36
+ * Note:
37
+ *
38
+ * * If you want to create a new project with an associated board, use the [Jira
39
+ * platform REST API](https://docs.atlassian.com/jira/REST/latest). For more
40
+ * information, see the [Create project](#api-rest-api-3-project-post) method. The
41
+ * `projectTypeKey` for software boards must be 'software' and the
42
+ * `projectTemplateKey` must be either
43
+ * `com.pyxis.greenhopper.jira:gh-kanban-template` or
44
+ * `com.pyxis.greenhopper.jira:gh-scrum-template`.
45
+ * * You can create a filter using the [Jira REST
46
+ * API](https://docs.atlassian.com/jira/REST/latest). For more information, see
47
+ * the [Create filter](#api-rest-api-3-filter-post) method.
48
+ * * If you do not ORDER BY the Rank field for the filter of your board, you
49
+ * will not be able to reorder issues on the board.
50
+ *
51
+ * @returns Returns the created board.
52
+ *
53
+ * example: {
54
+ * "id": 84,
55
+ * "name": "scrum board",
56
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
57
+ * "type": "scrum"
58
+ * }
59
+ * @path {POST} /rest/agile/1.0/board
60
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-post
61
+ */
62
+ this.createBoard = ({ boardCreateBean, }) => {
63
+ return this.getClientInstance()
64
+ .request({
65
+ path: "/rest/agile/1.0/board",
66
+ method: "POST",
67
+ headers: {
68
+ "Content-Type": "application/json",
69
+ },
70
+ body: boardCreateBean,
71
+ })
72
+ .then(this.getClientInstance().responseHandler({
73
+ 201: {
74
+ "application/json": "json",
75
+ },
76
+ }))
77
+ .then(commonHttpClient.castResponse())
78
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.createBoard.response"))
79
+ .then(commonHttpClient.getBody);
80
+ };
81
+ /**
82
+ * Deletes the board. Admin without the view permission can still remove the board.
83
+ *
84
+ * @path {DELETE} /rest/agile/1.0/board/{boardId}
85
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-delete
86
+ */
87
+ this.deleteBoard = ({ boardId, }) => {
88
+ return this.getClientInstance()
89
+ .request({
90
+ path: "/rest/agile/1.0/board/{boardId}",
91
+ method: "DELETE",
92
+ pathParams: {
93
+ boardId,
94
+ },
95
+ })
96
+ .then(commonHttpClient.discardResult);
97
+ };
98
+ /**
99
+ * Removes the property from the board identified by the id. Ths user removing the
100
+ * property is required to have permissions to modify the board.
101
+ *
102
+ * @path {DELETE} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
103
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-delete
104
+ */
105
+ this.deleteBoardProperty = ({ boardId, propertyKey, }) => {
106
+ return this.getClientInstance()
107
+ .request({
108
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
109
+ method: "DELETE",
110
+ pathParams: {
111
+ boardId,
112
+ propertyKey,
113
+ },
114
+ })
115
+ .then(commonHttpClient.discardResult);
116
+ };
117
+ /**
118
+ * Returns all boards. This only includes boards that the user has permission to
119
+ * view.
120
+ *
121
+ * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on
122
+ * February 15, 2024.
123
+ *
124
+ * * `read:board-scope:jira-software`, `read:project:jira`
125
+ *
126
+ * @returns Returns the requested boards, at the specified page of the results.
127
+ *
128
+ * example: {
129
+ * "isLast": false,
130
+ * "maxResults": 2,
131
+ * "startAt": 1,
132
+ * "total": 5,
133
+ * "values": [
134
+ * {
135
+ * "id": 84,
136
+ * "name": "scrum board",
137
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
138
+ * "type": "scrum"
139
+ * },
140
+ * {
141
+ * "id": 92,
142
+ * "name": "kanban board",
143
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
144
+ * "type": "kanban"
145
+ * }
146
+ * ]
147
+ * }
148
+ * @path {GET} /rest/agile/1.0/board
149
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-get
150
+ */
151
+ this.getAllBoards = ({ startAt, maxResults, type, name, projectKeyOrId, accountIdLocation, projectLocation, includePrivate, negateLocationFiltering, orderBy, expand, projectTypeLocation, filterId, } = {}) => {
152
+ return this.getClientInstance()
153
+ .request({
154
+ path: "/rest/agile/1.0/board",
155
+ method: "GET",
156
+ query: {
157
+ startAt,
158
+ maxResults,
159
+ type,
160
+ name,
161
+ projectKeyOrId,
162
+ accountIdLocation,
163
+ projectLocation,
164
+ includePrivate,
165
+ negateLocationFiltering,
166
+ orderBy,
167
+ expand,
168
+ projectTypeLocation,
169
+ filterId,
170
+ },
171
+ })
172
+ .then(this.getClientInstance().responseHandler({
173
+ 200: {
174
+ "application/json": "json",
175
+ },
176
+ }))
177
+ .then(commonHttpClient.castResponse())
178
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllBoards.response"))
179
+ .then(commonHttpClient.getBody);
180
+ };
181
+ /**
182
+ * Returns all quick filters from a board, for a given board ID.
183
+ *
184
+ * @returns Returns the requested quick filters, at the specified page of the results.
185
+ * Quick filters will be ordered first by position.
186
+ *
187
+ * example: {
188
+ * "isLast": false,
189
+ * "maxResults": 2,
190
+ * "startAt": 1,
191
+ * "total": 5,
192
+ * "values": [
193
+ * {
194
+ * "boardId": 1,
195
+ * "description": "Issues of type bug",
196
+ * "id": 1,
197
+ * "jql": "issueType = bug",
198
+ * "name": "Bugs",
199
+ * "position": 0
200
+ * },
201
+ * {
202
+ * "boardId": 1,
203
+ * "description": "Issues of type task",
204
+ * "id": 2,
205
+ * "jql": "issueType = task",
206
+ * "name": "Tasks",
207
+ * "position": 0
208
+ * }
209
+ * ]
210
+ * }
211
+ * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter
212
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-get
213
+ */
214
+ this.getAllQuickFilters = ({ boardId, startAt, maxResults, }) => {
215
+ return this.getClientInstance()
216
+ .request({
217
+ path: "/rest/agile/1.0/board/{boardId}/quickfilter",
218
+ method: "GET",
219
+ pathParams: {
220
+ boardId,
221
+ },
222
+ query: {
223
+ startAt,
224
+ maxResults,
225
+ },
226
+ })
227
+ .then(this.getClientInstance().responseHandler({
228
+ 200: {
229
+ "application/json": "json",
230
+ },
231
+ }))
232
+ .then(commonHttpClient.castResponse())
233
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllQuickFilters.response"))
234
+ .then(commonHttpClient.getBody);
235
+ };
236
+ /**
237
+ * Returns all sprints from a board, for a given board ID. This only includes
238
+ * sprints that the user has permission to view.
239
+ *
240
+ * @returns Returns the requested sprints, at the specified page of the results. Sprints
241
+ * will be ordered first by state (i.e. closed, active, future) then by their
242
+ * position in the backlog.
243
+ *
244
+ * example: {
245
+ * "isLast": false,
246
+ * "maxResults": 2,
247
+ * "startAt": 1,
248
+ * "total": 5,
249
+ * "values": [
250
+ * {
251
+ * "id": 37,
252
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
253
+ * "state": "closed",
254
+ * "name": "sprint 1",
255
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
256
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
257
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
258
+ * "originBoardId": 5,
259
+ * "goal": "sprint 1 goal"
260
+ * },
261
+ * {
262
+ * "id": 72,
263
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
264
+ * "state": "future",
265
+ * "name": "sprint 2",
266
+ * "goal": "sprint 2 goal"
267
+ * }
268
+ * ]
269
+ * }
270
+ * @path {GET} /rest/agile/1.0/board/{boardId}/sprint
271
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-get
272
+ */
273
+ this.getAllSprints = ({ boardId, startAt, maxResults, state, }) => {
274
+ return this.getClientInstance()
275
+ .request({
276
+ path: "/rest/agile/1.0/board/{boardId}/sprint",
277
+ method: "GET",
278
+ pathParams: {
279
+ boardId,
280
+ },
281
+ query: {
282
+ startAt,
283
+ maxResults,
284
+ state,
285
+ },
286
+ })
287
+ .then(this.getClientInstance().responseHandler({
288
+ 200: {
289
+ "application/json": "json",
290
+ },
291
+ }))
292
+ .then(commonHttpClient.castResponse())
293
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllSprints.response"))
294
+ .then(commonHttpClient.getBody);
295
+ };
296
+ /**
297
+ * Returns all versions from a board, for a given board ID. This only includes
298
+ * versions that the user has permission to view. Note, if the user does not have
299
+ * permission to view the board, no versions will be returned at all. Returned
300
+ * versions are ordered by the name of the project from which they belong and then
301
+ * by sequence defined by user.
302
+ *
303
+ * @returns Returns the requested versions, at the specified page of the results.
304
+ *
305
+ * example: {
306
+ * "isLast": false,
307
+ * "maxResults": 2,
308
+ * "startAt": 1,
309
+ * "total": 5,
310
+ * "values": [
311
+ * {
312
+ * "archived": false,
313
+ * "description": "A first version",
314
+ * "id": 10000,
315
+ * "name": "Version 1",
316
+ * "projectId": 10000,
317
+ * "releaseDate": "2015-04-20T01:02:00.000+10:00",
318
+ * "released": true,
319
+ * "self": "https://your-domain.atlassian.net/version/10000"
320
+ * },
321
+ * {
322
+ * "archived": false,
323
+ * "description": "Minor Bugfix version",
324
+ * "id": 10010,
325
+ * "name": "Next Version",
326
+ * "projectId": 10000,
327
+ * "released": false,
328
+ * "self": "https://your-domain.atlassian.net/version/10010"
329
+ * }
330
+ * ]
331
+ * }
332
+ * @path {GET} /rest/agile/1.0/board/{boardId}/version
333
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-version-get
334
+ */
335
+ this.getAllVersions = ({ boardId, startAt, maxResults, released, }) => {
336
+ return this.getClientInstance()
337
+ .request({
338
+ path: "/rest/agile/1.0/board/{boardId}/version",
339
+ method: "GET",
340
+ pathParams: {
341
+ boardId,
342
+ },
343
+ query: {
344
+ startAt,
345
+ maxResults,
346
+ released,
347
+ },
348
+ })
349
+ .then(this.getClientInstance().responseHandler({
350
+ 200: {
351
+ "application/json": "json",
352
+ },
353
+ }))
354
+ .then(commonHttpClient.castResponse())
355
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getAllVersions.response"))
356
+ .then(commonHttpClient.getBody);
357
+ };
358
+ /**
359
+ * Returns the board for the given board ID. This board will only be returned if
360
+ * the user has permission to view it. Admins without the view permission will see
361
+ * the board as a private one, so will see only a subset of the board's data
362
+ * (board location for instance).
363
+ *
364
+ * @returns Returns the requested board.
365
+ *
366
+ * example: {
367
+ * "id": 84,
368
+ * "location": {
369
+ * "displayName": "Example Project",
370
+ * "name": "Example Project",
371
+ * "projectId": 10040,
372
+ * "projectKey": "Example Project Key",
373
+ * "projectName": "Example Project",
374
+ * "projectTypeKey": "KEY",
375
+ * "userAccountId": "5b10a2844c20165700ede21g",
376
+ * "userId": 10040
377
+ * },
378
+ * "name": "scrum board",
379
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
380
+ * "type": "scrum"
381
+ * }
382
+ * @path {GET} /rest/agile/1.0/board/{boardId}
383
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-get
384
+ */
385
+ this.getBoard = ({ boardId, }) => {
386
+ return this.getClientInstance()
387
+ .request({
388
+ path: "/rest/agile/1.0/board/{boardId}",
389
+ method: "GET",
390
+ pathParams: {
391
+ boardId,
392
+ },
393
+ })
394
+ .then(this.getClientInstance().responseHandler({
395
+ 200: {
396
+ "application/json": "json",
397
+ },
398
+ }))
399
+ .then(commonHttpClient.castResponse())
400
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoard.response"))
401
+ .then(commonHttpClient.getBody);
402
+ };
403
+ /**
404
+ * Returns any boards which use the provided filter id. This method can be
405
+ * executed by users without a valid software license in order to find which
406
+ * boards are using a particular filter.
407
+ *
408
+ * @returns Returns the requested boards, at the specified page of the results.
409
+ *
410
+ * example: {
411
+ * "id": 84,
412
+ * "name": "scrum board",
413
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
414
+ * }
415
+ * @path {GET} /rest/agile/1.0/board/filter/{filterId}
416
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-filter-filterid-get
417
+ */
418
+ this.getBoardByFilterId = ({ filterId, startAt, maxResults, }) => {
419
+ return this.getClientInstance()
420
+ .request({
421
+ path: "/rest/agile/1.0/board/filter/{filterId}",
422
+ method: "GET",
423
+ pathParams: {
424
+ filterId,
425
+ },
426
+ query: {
427
+ startAt,
428
+ maxResults,
429
+ },
430
+ })
431
+ .then(this.getClientInstance().responseHandler({
432
+ 200: {
433
+ "application/json": "json",
434
+ },
435
+ }))
436
+ .then(commonHttpClient.castResponse())
437
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardByFilterId.response"))
438
+ .then(commonHttpClient.getBody);
439
+ };
440
+ /**
441
+ * Returns all issues that belong to an epic on the board, for the given epic ID
442
+ * and the board ID. This only includes issues that the user has permission to
443
+ * view. Issues returned from this resource include Agile fields, like sprint,
444
+ * closedSprints, flagged, and epic. By default, the returned issues are ordered
445
+ * by rank.
446
+ *
447
+ * @returns Returns the requested issues, at the specified page of the results.
448
+ *
449
+ * example: {
450
+ * "expand": "names,schema",
451
+ * "issues": [
452
+ * {
453
+ * "expand": "",
454
+ * "fields": {
455
+ * "flagged": true,
456
+ * "sprint": {
457
+ * "id": 37,
458
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
459
+ * "state": "future",
460
+ * "name": "sprint 2",
461
+ * "goal": "sprint 2 goal"
462
+ * },
463
+ * "closedSprints": [
464
+ * {
465
+ * "id": 37,
466
+ * "self":
467
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
468
+ * "state": "closed",
469
+ * "name": "sprint 1",
470
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
471
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
472
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
473
+ * "goal": "sprint 1 goal"
474
+ * }
475
+ * ],
476
+ * "description": "example bug report",
477
+ * "project": {
478
+ * "avatarUrls": {
479
+ * "16x16":
480
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
481
+ * "24x24":
482
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
483
+ * "32x32":
484
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
485
+ * "48x48":
486
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
487
+ * },
488
+ * "id": "10000",
489
+ * "insight": {
490
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
491
+ * "totalIssueCount": 100
492
+ * },
493
+ * "key": "EX",
494
+ * "name": "Example",
495
+ * "projectCategory": {
496
+ * "description": "First Project Category",
497
+ * "id": "10000",
498
+ * "name": "FIRST",
499
+ * "self":
500
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
501
+ * },
502
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
503
+ * "simplified": false,
504
+ * "style": "classic"
505
+ * },
506
+ * "comment": [
507
+ * {
508
+ * "author": {
509
+ * "accountId": "5b10a2844c20165700ede21g",
510
+ * "active": false,
511
+ * "displayName": "Mia Krystof",
512
+ * "self":
513
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
514
+ * },
515
+ * "body": {
516
+ * "type": "doc",
517
+ * "version": 1,
518
+ * "content": [
519
+ * {
520
+ * "type": "paragraph",
521
+ * "content": [
522
+ * {
523
+ * "type": "text",
524
+ * "text": "Lorem ipsum dolor sit amet, consectetur
525
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
526
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
527
+ * semper."
528
+ * }
529
+ * ]
530
+ * }
531
+ * ]
532
+ * },
533
+ * "created": "2021-01-17T12:34:00.000+0000",
534
+ * "id": "10000",
535
+ * "self":
536
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
537
+ * "updateAuthor": {
538
+ * "accountId": "5b10a2844c20165700ede21g",
539
+ * "active": false,
540
+ * "displayName": "Mia Krystof",
541
+ * "self":
542
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
543
+ * },
544
+ * "updated": "2021-01-18T23:45:00.000+0000",
545
+ * "visibility": {
546
+ * "identifier": "Administrators",
547
+ * "type": "role",
548
+ * "value": "Administrators"
549
+ * }
550
+ * }
551
+ * ],
552
+ * "epic": {
553
+ * "id": 37,
554
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
555
+ * "name": "epic 1",
556
+ * "summary": "epic 1 summary",
557
+ * "color": {
558
+ * "key": "color_4"
559
+ * },
560
+ * "done": true
561
+ * },
562
+ * "worklog": [
563
+ * {
564
+ * "author": {
565
+ * "accountId": "5b10a2844c20165700ede21g",
566
+ * "active": false,
567
+ * "displayName": "Mia Krystof",
568
+ * "self":
569
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
570
+ * },
571
+ * "comment": {
572
+ * "type": "doc",
573
+ * "version": 1,
574
+ * "content": [
575
+ * {
576
+ * "type": "paragraph",
577
+ * "content": [
578
+ * {
579
+ * "type": "text",
580
+ * "text": "I did some work here."
581
+ * }
582
+ * ]
583
+ * }
584
+ * ]
585
+ * },
586
+ * "id": "100028",
587
+ * "issueId": "10002",
588
+ * "self":
589
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
590
+ * "started": "2021-01-17T12:34:00.000+0000",
591
+ * "timeSpent": "3h 20m",
592
+ * "timeSpentSeconds": 12000,
593
+ * "updateAuthor": {
594
+ * "accountId": "5b10a2844c20165700ede21g",
595
+ * "active": false,
596
+ * "displayName": "Mia Krystof",
597
+ * "self":
598
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
599
+ * },
600
+ * "updated": "2021-01-18T23:45:00.000+0000",
601
+ * "visibility": {
602
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
603
+ * "type": "group",
604
+ * "value": "jira-developers"
605
+ * }
606
+ * }
607
+ * ],
608
+ * "updated": 1,
609
+ * "timetracking": {
610
+ * "originalEstimate": "10m",
611
+ * "originalEstimateSeconds": 600,
612
+ * "remainingEstimate": "3m",
613
+ * "remainingEstimateSeconds": 200,
614
+ * "timeSpent": "6m",
615
+ * "timeSpentSeconds": 400
616
+ * }
617
+ * },
618
+ * "id": "10001",
619
+ * "key": "HSP-1",
620
+ * "self":
621
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
622
+ * }
623
+ * ],
624
+ * "maxResults": 50,
625
+ * "startAt": 0,
626
+ * "total": 1
627
+ * }
628
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
629
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-epicid-issue-get
630
+ */
631
+ this.getBoardIssuesForEpic = ({ boardId, epicId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
632
+ return this.getClientInstance()
633
+ .request({
634
+ path: "/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue",
635
+ method: "GET",
636
+ pathParams: {
637
+ boardId,
638
+ epicId,
639
+ },
640
+ query: {
641
+ startAt,
642
+ maxResults,
643
+ jql,
644
+ validateQuery,
645
+ fields,
646
+ expand,
647
+ },
648
+ })
649
+ .then(this.getClientInstance().responseHandler({
650
+ 200: {
651
+ "application/json": "json",
652
+ },
653
+ }))
654
+ .then(commonHttpClient.castResponse())
655
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardIssuesForEpic.response"))
656
+ .then(commonHttpClient.getBody);
657
+ };
658
+ /**
659
+ * Get all issues you have access to that belong to the sprint from the board.
660
+ * Issue returned from this resource contains additional fields like: sprint,
661
+ * closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order
662
+ * has higher priority than default rank.
663
+ *
664
+ * @returns Returns the requested issues, at the specified page of the results.
665
+ *
666
+ * example: {
667
+ * "expand": "names,schema",
668
+ * "issues": [
669
+ * {
670
+ * "expand": "",
671
+ * "fields": {
672
+ * "flagged": true,
673
+ * "sprint": {
674
+ * "id": 37,
675
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
676
+ * "state": "future",
677
+ * "name": "sprint 2",
678
+ * "goal": "sprint 2 goal"
679
+ * },
680
+ * "closedSprints": [
681
+ * {
682
+ * "id": 37,
683
+ * "self":
684
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
685
+ * "state": "closed",
686
+ * "name": "sprint 1",
687
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
688
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
689
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
690
+ * "goal": "sprint 1 goal"
691
+ * }
692
+ * ],
693
+ * "description": "example bug report",
694
+ * "project": {
695
+ * "avatarUrls": {
696
+ * "16x16":
697
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
698
+ * "24x24":
699
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
700
+ * "32x32":
701
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
702
+ * "48x48":
703
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
704
+ * },
705
+ * "id": "10000",
706
+ * "insight": {
707
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
708
+ * "totalIssueCount": 100
709
+ * },
710
+ * "key": "EX",
711
+ * "name": "Example",
712
+ * "projectCategory": {
713
+ * "description": "First Project Category",
714
+ * "id": "10000",
715
+ * "name": "FIRST",
716
+ * "self":
717
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
718
+ * },
719
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
720
+ * "simplified": false,
721
+ * "style": "classic"
722
+ * },
723
+ * "comment": [
724
+ * {
725
+ * "author": {
726
+ * "accountId": "5b10a2844c20165700ede21g",
727
+ * "active": false,
728
+ * "displayName": "Mia Krystof",
729
+ * "self":
730
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
731
+ * },
732
+ * "body": {
733
+ * "type": "doc",
734
+ * "version": 1,
735
+ * "content": [
736
+ * {
737
+ * "type": "paragraph",
738
+ * "content": [
739
+ * {
740
+ * "type": "text",
741
+ * "text": "Lorem ipsum dolor sit amet, consectetur
742
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
743
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
744
+ * semper."
745
+ * }
746
+ * ]
747
+ * }
748
+ * ]
749
+ * },
750
+ * "created": "2021-01-17T12:34:00.000+0000",
751
+ * "id": "10000",
752
+ * "self":
753
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
754
+ * "updateAuthor": {
755
+ * "accountId": "5b10a2844c20165700ede21g",
756
+ * "active": false,
757
+ * "displayName": "Mia Krystof",
758
+ * "self":
759
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
760
+ * },
761
+ * "updated": "2021-01-18T23:45:00.000+0000",
762
+ * "visibility": {
763
+ * "identifier": "Administrators",
764
+ * "type": "role",
765
+ * "value": "Administrators"
766
+ * }
767
+ * }
768
+ * ],
769
+ * "epic": {
770
+ * "id": 37,
771
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
772
+ * "name": "epic 1",
773
+ * "summary": "epic 1 summary",
774
+ * "color": {
775
+ * "key": "color_4"
776
+ * },
777
+ * "done": true
778
+ * },
779
+ * "worklog": [
780
+ * {
781
+ * "author": {
782
+ * "accountId": "5b10a2844c20165700ede21g",
783
+ * "active": false,
784
+ * "displayName": "Mia Krystof",
785
+ * "self":
786
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
787
+ * },
788
+ * "comment": {
789
+ * "type": "doc",
790
+ * "version": 1,
791
+ * "content": [
792
+ * {
793
+ * "type": "paragraph",
794
+ * "content": [
795
+ * {
796
+ * "type": "text",
797
+ * "text": "I did some work here."
798
+ * }
799
+ * ]
800
+ * }
801
+ * ]
802
+ * },
803
+ * "id": "100028",
804
+ * "issueId": "10002",
805
+ * "self":
806
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
807
+ * "started": "2021-01-17T12:34:00.000+0000",
808
+ * "timeSpent": "3h 20m",
809
+ * "timeSpentSeconds": 12000,
810
+ * "updateAuthor": {
811
+ * "accountId": "5b10a2844c20165700ede21g",
812
+ * "active": false,
813
+ * "displayName": "Mia Krystof",
814
+ * "self":
815
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
816
+ * },
817
+ * "updated": "2021-01-18T23:45:00.000+0000",
818
+ * "visibility": {
819
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
820
+ * "type": "group",
821
+ * "value": "jira-developers"
822
+ * }
823
+ * }
824
+ * ],
825
+ * "updated": 1,
826
+ * "timetracking": {
827
+ * "originalEstimate": "10m",
828
+ * "originalEstimateSeconds": 600,
829
+ * "remainingEstimate": "3m",
830
+ * "remainingEstimateSeconds": 200,
831
+ * "timeSpent": "6m",
832
+ * "timeSpentSeconds": 400
833
+ * }
834
+ * },
835
+ * "id": "10001",
836
+ * "key": "HSP-1",
837
+ * "self":
838
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
839
+ * }
840
+ * ],
841
+ * "maxResults": 50,
842
+ * "startAt": 0,
843
+ * "total": 1
844
+ * }
845
+ * @path {GET} /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
846
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-sprintid-issue-get
847
+ */
848
+ this.getBoardIssuesForSprint = ({ boardId, sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
849
+ return this.getClientInstance()
850
+ .request({
851
+ path: "/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue",
852
+ method: "GET",
853
+ pathParams: {
854
+ boardId,
855
+ sprintId,
856
+ },
857
+ query: {
858
+ startAt,
859
+ maxResults,
860
+ jql,
861
+ validateQuery,
862
+ fields,
863
+ expand,
864
+ },
865
+ })
866
+ .then(this.getClientInstance().responseHandler({
867
+ 200: {
868
+ "application/json": "json",
869
+ },
870
+ }))
871
+ .then(commonHttpClient.castResponse())
872
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardIssuesForSprint.response"))
873
+ .then(commonHttpClient.getBody);
874
+ };
875
+ /**
876
+ * Returns the value of the property with a given key from the board identified by
877
+ * the provided id. The user who retrieves the property is required to have
878
+ * permissions to view the board.
879
+ *
880
+ * @returns Returned if the board exists and the property was found.
881
+ * @path {GET} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
882
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get
883
+ */
884
+ this.getBoardProperty = ({ boardId, propertyKey, }) => {
885
+ return this.getClientInstance()
886
+ .request({
887
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
888
+ method: "GET",
889
+ pathParams: {
890
+ boardId,
891
+ propertyKey,
892
+ },
893
+ })
894
+ .then(this.getClientInstance().responseHandler({
895
+ 200: {
896
+ "application/json": "json",
897
+ },
898
+ }))
899
+ .then(commonHttpClient.castResponse())
900
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardProperty.response"))
901
+ .then(commonHttpClient.getBody);
902
+ };
903
+ /**
904
+ * Returns the keys of all properties for the board identified by the id. The user
905
+ * who retrieves the property keys is required to have permissions to view the
906
+ * board.
907
+ *
908
+ * @returns Returned if the board with given id exists.
909
+ * @path {GET} /rest/agile/1.0/board/{boardId}/properties
910
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
911
+ */
912
+ this.getBoardPropertyKeys = ({ boardId, }) => {
913
+ return this.getClientInstance()
914
+ .request({
915
+ path: "/rest/agile/1.0/board/{boardId}/properties",
916
+ method: "GET",
917
+ pathParams: {
918
+ boardId,
919
+ },
920
+ })
921
+ .then(this.getClientInstance().responseHandler({
922
+ 200: {
923
+ "application/json": "json",
924
+ },
925
+ }))
926
+ .then(commonHttpClient.castResponse())
927
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getBoardPropertyKeys.response"))
928
+ .then(commonHttpClient.getBody);
929
+ };
930
+ /**
931
+ * Get the board configuration. The response contains the following fields:
932
+ *
933
+ * * `id` \- ID of the board.
934
+ * * `name` \- Name of the board.
935
+ * * `filter` \- Reference to the filter used by the given board.
936
+ * * `location` \- Reference to the container that the board is located in.
937
+ * Includes the container type (Valid values: project, user).
938
+ * * `subQuery` (Kanban only) - JQL subquery used by the given board.
939
+ * * `columnConfig` \- The column configuration lists the columns for the board,
940
+ * in the order defined in the column configuration. For each column, it shows the
941
+ * issue status mapping as well as the constraint type (Valid values: none,
942
+ * issueCount, issueCountExclSubs) for the min/max number of issues. Note, the
943
+ * last column with statuses mapped to it is treated as the "Done" column, which
944
+ * means that issues in that column will be marked as already completed.
945
+ * * `estimation` (Scrum only) - Contains information about type of estimation
946
+ * used for the board. Valid values: none, issueCount, field. If the estimation
947
+ * type is "field", the ID and display name of the field used for estimation is
948
+ * also returned. Note, estimates for an issue can be updated by a PUT
949
+ * /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the
950
+ * screen. "timeoriginalestimate" field will never be on the screen, so in order
951
+ * to update it "originalEstimate" in "timetracking" field should be updated.
952
+ * * `ranking` \- Contains information about custom field used for ranking in
953
+ * the given board.
954
+ *
955
+ * @returns Returns the configuration of the board for given boardId.
956
+ *
957
+ * example: {
958
+ * "columnConfig": {
959
+ * "columns": [
960
+ * {
961
+ * "name": "To Do",
962
+ * "statuses": [
963
+ * {
964
+ * "id": "1",
965
+ * "self": "https://your-domain.atlassian.net/status/1"
966
+ * },
967
+ * {
968
+ * "id": "4",
969
+ * "self": "https://your-domain.atlassian.net/status/4"
970
+ * }
971
+ * ]
972
+ * },
973
+ * {
974
+ * "max": 4,
975
+ * "min": 2,
976
+ * "name": "In progress",
977
+ * "statuses": [
978
+ * {
979
+ * "id": "3",
980
+ * "self": "https://your-domain.atlassian.net/status/3"
981
+ * }
982
+ * ]
983
+ * },
984
+ * {
985
+ * "name": "Done",
986
+ * "statuses": [
987
+ * {
988
+ * "id": "5",
989
+ * "self": "https://your-domain.atlassian.net/status/5"
990
+ * }
991
+ * ]
992
+ * }
993
+ * ],
994
+ * "constraintType": "issueCount"
995
+ * },
996
+ * "estimation": {
997
+ * "field": {
998
+ * "displayName": "Story Points",
999
+ * "fieldId": "customfield_10002"
1000
+ * },
1001
+ * "type": "field"
1002
+ * },
1003
+ * "filter": {
1004
+ * "id": "1001",
1005
+ * "self": "https://your-domain.atlassian.net/filter/1001"
1006
+ * },
1007
+ * "id": 10000,
1008
+ * "location": {
1009
+ * "id": "10010",
1010
+ * "key": "PROJ",
1011
+ * "name": "name",
1012
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/10010",
1013
+ * "type": "project"
1014
+ * },
1015
+ * "name": "Board",
1016
+ * "ranking": {
1017
+ * "rankCustomFieldId": 10020
1018
+ * },
1019
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
1020
+ * }
1021
+ * @path {GET} /rest/agile/1.0/board/{boardId}/configuration
1022
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-configuration-get
1023
+ */
1024
+ this.getConfiguration = ({ boardId, }) => {
1025
+ return this.getClientInstance()
1026
+ .request({
1027
+ path: "/rest/agile/1.0/board/{boardId}/configuration",
1028
+ method: "GET",
1029
+ pathParams: {
1030
+ boardId,
1031
+ },
1032
+ })
1033
+ .then(this.getClientInstance().responseHandler({
1034
+ 200: {
1035
+ "application/json": "json",
1036
+ },
1037
+ }))
1038
+ .then(commonHttpClient.castResponse())
1039
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getConfiguration.response"))
1040
+ .then(commonHttpClient.getBody);
1041
+ };
1042
+ /**
1043
+ * Returns all epics from the board, for the given board ID. This only includes
1044
+ * epics that the user has permission to view. Note, if the user does not have
1045
+ * permission to view the board, no epics will be returned at all.
1046
+ *
1047
+ * @returns Returns the requested epics, at the specified page of the results.
1048
+ *
1049
+ * example: {
1050
+ * "isLast": false,
1051
+ * "maxResults": 2,
1052
+ * "startAt": 1,
1053
+ * "total": 5,
1054
+ * "values": [
1055
+ * {
1056
+ * "id": 37,
1057
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1058
+ * "name": "epic 1",
1059
+ * "summary": "epic 1 summary",
1060
+ * "color": {
1061
+ * "key": "color_4"
1062
+ * },
1063
+ * "done": true
1064
+ * },
1065
+ * {
1066
+ * "id": 37,
1067
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/13",
1068
+ * "name": "epic 2",
1069
+ * "summary": "epic 2 summary",
1070
+ * "color": {
1071
+ * "key": "color_2"
1072
+ * },
1073
+ * "done": false
1074
+ * }
1075
+ * ]
1076
+ * }
1077
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic
1078
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-get
1079
+ */
1080
+ this.getEpics = ({ boardId, startAt, maxResults, done, }) => {
1081
+ return this.getClientInstance()
1082
+ .request({
1083
+ path: "/rest/agile/1.0/board/{boardId}/epic",
1084
+ method: "GET",
1085
+ pathParams: {
1086
+ boardId,
1087
+ },
1088
+ query: {
1089
+ startAt,
1090
+ maxResults,
1091
+ done,
1092
+ },
1093
+ })
1094
+ .then(this.getClientInstance().responseHandler({
1095
+ 200: {
1096
+ "application/json": "json",
1097
+ },
1098
+ }))
1099
+ .then(commonHttpClient.castResponse())
1100
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getEpics.response"))
1101
+ .then(commonHttpClient.getBody);
1102
+ };
1103
+ /**
1104
+ * @returns 200 response
1105
+ * @path {GET} /rest/agile/1.0/board/{boardId}/features
1106
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-get
1107
+ */
1108
+ this.getFeaturesForBoard = ({ boardId, }) => {
1109
+ return this.getClientInstance()
1110
+ .request({
1111
+ path: "/rest/agile/1.0/board/{boardId}/features",
1112
+ method: "GET",
1113
+ pathParams: {
1114
+ boardId,
1115
+ },
1116
+ })
1117
+ .then(this.getClientInstance().responseHandler({
1118
+ 200: {
1119
+ "application/json": "json",
1120
+ },
1121
+ }))
1122
+ .then(commonHttpClient.castResponse())
1123
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getFeaturesForBoard.response"))
1124
+ .then(commonHttpClient.getBody);
1125
+ };
1126
+ /**
1127
+ * Returns all issues from the board's backlog, for the given board ID. This only
1128
+ * includes issues that the user has permission to view. The backlog contains
1129
+ * incomplete issues that are not assigned to any future or active sprint. Note,
1130
+ * if the user does not have permission to view the board, no issues will be
1131
+ * returned at all. Issues returned from this resource include Agile fields, like
1132
+ * sprint, closedSprints, flagged, and epic. By default, the returned issues are
1133
+ * ordered by rank.
1134
+ *
1135
+ * @returns Returns the requested issues, at the specified page of the results.
1136
+ *
1137
+ * example: {
1138
+ * "expand": "names,schema",
1139
+ * "issues": [
1140
+ * {
1141
+ * "expand": "",
1142
+ * "fields": {
1143
+ * "flagged": true,
1144
+ * "sprint": {
1145
+ * "id": 37,
1146
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1147
+ * "state": "future",
1148
+ * "name": "sprint 2",
1149
+ * "goal": "sprint 2 goal"
1150
+ * },
1151
+ * "closedSprints": [
1152
+ * {
1153
+ * "id": 37,
1154
+ * "self":
1155
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1156
+ * "state": "closed",
1157
+ * "name": "sprint 1",
1158
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
1159
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
1160
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
1161
+ * "goal": "sprint 1 goal"
1162
+ * }
1163
+ * ],
1164
+ * "description": "example bug report",
1165
+ * "project": {
1166
+ * "avatarUrls": {
1167
+ * "16x16":
1168
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1169
+ * "24x24":
1170
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1171
+ * "32x32":
1172
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1173
+ * "48x48":
1174
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1175
+ * },
1176
+ * "id": "10000",
1177
+ * "insight": {
1178
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1179
+ * "totalIssueCount": 100
1180
+ * },
1181
+ * "key": "EX",
1182
+ * "name": "Example",
1183
+ * "projectCategory": {
1184
+ * "description": "First Project Category",
1185
+ * "id": "10000",
1186
+ * "name": "FIRST",
1187
+ * "self":
1188
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1189
+ * },
1190
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1191
+ * "simplified": false,
1192
+ * "style": "classic"
1193
+ * },
1194
+ * "comment": [
1195
+ * {
1196
+ * "author": {
1197
+ * "accountId": "5b10a2844c20165700ede21g",
1198
+ * "active": false,
1199
+ * "displayName": "Mia Krystof",
1200
+ * "self":
1201
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1202
+ * },
1203
+ * "body": {
1204
+ * "type": "doc",
1205
+ * "version": 1,
1206
+ * "content": [
1207
+ * {
1208
+ * "type": "paragraph",
1209
+ * "content": [
1210
+ * {
1211
+ * "type": "text",
1212
+ * "text": "Lorem ipsum dolor sit amet, consectetur
1213
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1214
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1215
+ * semper."
1216
+ * }
1217
+ * ]
1218
+ * }
1219
+ * ]
1220
+ * },
1221
+ * "created": "2021-01-17T12:34:00.000+0000",
1222
+ * "id": "10000",
1223
+ * "self":
1224
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1225
+ * "updateAuthor": {
1226
+ * "accountId": "5b10a2844c20165700ede21g",
1227
+ * "active": false,
1228
+ * "displayName": "Mia Krystof",
1229
+ * "self":
1230
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1231
+ * },
1232
+ * "updated": "2021-01-18T23:45:00.000+0000",
1233
+ * "visibility": {
1234
+ * "identifier": "Administrators",
1235
+ * "type": "role",
1236
+ * "value": "Administrators"
1237
+ * }
1238
+ * }
1239
+ * ],
1240
+ * "epic": {
1241
+ * "id": 37,
1242
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1243
+ * "name": "epic 1",
1244
+ * "summary": "epic 1 summary",
1245
+ * "color": {
1246
+ * "key": "color_4"
1247
+ * },
1248
+ * "done": true
1249
+ * },
1250
+ * "worklog": [
1251
+ * {
1252
+ * "author": {
1253
+ * "accountId": "5b10a2844c20165700ede21g",
1254
+ * "active": false,
1255
+ * "displayName": "Mia Krystof",
1256
+ * "self":
1257
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1258
+ * },
1259
+ * "comment": {
1260
+ * "type": "doc",
1261
+ * "version": 1,
1262
+ * "content": [
1263
+ * {
1264
+ * "type": "paragraph",
1265
+ * "content": [
1266
+ * {
1267
+ * "type": "text",
1268
+ * "text": "I did some work here."
1269
+ * }
1270
+ * ]
1271
+ * }
1272
+ * ]
1273
+ * },
1274
+ * "id": "100028",
1275
+ * "issueId": "10002",
1276
+ * "self":
1277
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1278
+ * "started": "2021-01-17T12:34:00.000+0000",
1279
+ * "timeSpent": "3h 20m",
1280
+ * "timeSpentSeconds": 12000,
1281
+ * "updateAuthor": {
1282
+ * "accountId": "5b10a2844c20165700ede21g",
1283
+ * "active": false,
1284
+ * "displayName": "Mia Krystof",
1285
+ * "self":
1286
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1287
+ * },
1288
+ * "updated": "2021-01-18T23:45:00.000+0000",
1289
+ * "visibility": {
1290
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1291
+ * "type": "group",
1292
+ * "value": "jira-developers"
1293
+ * }
1294
+ * }
1295
+ * ],
1296
+ * "updated": 1,
1297
+ * "timetracking": {
1298
+ * "originalEstimate": "10m",
1299
+ * "originalEstimateSeconds": 600,
1300
+ * "remainingEstimate": "3m",
1301
+ * "remainingEstimateSeconds": 200,
1302
+ * "timeSpent": "6m",
1303
+ * "timeSpentSeconds": 400
1304
+ * }
1305
+ * },
1306
+ * "id": "10001",
1307
+ * "key": "HSP-1",
1308
+ * "self":
1309
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1310
+ * }
1311
+ * ],
1312
+ * "maxResults": 50,
1313
+ * "startAt": 0,
1314
+ * "total": 1
1315
+ * }
1316
+ * @path {GET} /rest/agile/1.0/board/{boardId}/backlog
1317
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-backlog-get
1318
+ */
1319
+ this.getIssuesForBacklog = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
1320
+ return this.getClientInstance()
1321
+ .request({
1322
+ path: "/rest/agile/1.0/board/{boardId}/backlog",
1323
+ method: "GET",
1324
+ pathParams: {
1325
+ boardId,
1326
+ },
1327
+ query: {
1328
+ startAt,
1329
+ maxResults,
1330
+ jql,
1331
+ validateQuery,
1332
+ fields,
1333
+ expand,
1334
+ },
1335
+ })
1336
+ .then(this.getClientInstance().responseHandler({
1337
+ 200: {
1338
+ "application/json": "json",
1339
+ },
1340
+ }))
1341
+ .then(commonHttpClient.castResponse())
1342
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesForBacklog.response"))
1343
+ .then(commonHttpClient.getBody);
1344
+ };
1345
+ /**
1346
+ * Returns all issues from a board, for a given board ID. This only includes
1347
+ * issues that the user has permission to view. An issue belongs to the board if
1348
+ * its status is mapped to the board's column. Epic issues do not belongs to the
1349
+ * scrum boards. Note, if the user does not have permission to view the board, no
1350
+ * issues will be returned at all. Issues returned from this resource include
1351
+ * Agile fields, like sprint, closedSprints, flagged, and epic. By default, the
1352
+ * returned issues are ordered by rank.
1353
+ *
1354
+ * @returns Returns the requested issues, at the specified page of the results.
1355
+ *
1356
+ * example: {
1357
+ * "expand": "names,schema",
1358
+ * "issues": [
1359
+ * {
1360
+ * "expand": "",
1361
+ * "fields": {
1362
+ * "flagged": true,
1363
+ * "sprint": {
1364
+ * "id": 37,
1365
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1366
+ * "state": "future",
1367
+ * "name": "sprint 2",
1368
+ * "goal": "sprint 2 goal"
1369
+ * },
1370
+ * "closedSprints": [
1371
+ * {
1372
+ * "id": 37,
1373
+ * "self":
1374
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1375
+ * "state": "closed",
1376
+ * "name": "sprint 1",
1377
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
1378
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
1379
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
1380
+ * "goal": "sprint 1 goal"
1381
+ * }
1382
+ * ],
1383
+ * "description": "example bug report",
1384
+ * "project": {
1385
+ * "avatarUrls": {
1386
+ * "16x16":
1387
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1388
+ * "24x24":
1389
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1390
+ * "32x32":
1391
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1392
+ * "48x48":
1393
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1394
+ * },
1395
+ * "id": "10000",
1396
+ * "insight": {
1397
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1398
+ * "totalIssueCount": 100
1399
+ * },
1400
+ * "key": "EX",
1401
+ * "name": "Example",
1402
+ * "projectCategory": {
1403
+ * "description": "First Project Category",
1404
+ * "id": "10000",
1405
+ * "name": "FIRST",
1406
+ * "self":
1407
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1408
+ * },
1409
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1410
+ * "simplified": false,
1411
+ * "style": "classic"
1412
+ * },
1413
+ * "comment": [
1414
+ * {
1415
+ * "author": {
1416
+ * "accountId": "5b10a2844c20165700ede21g",
1417
+ * "active": false,
1418
+ * "displayName": "Mia Krystof",
1419
+ * "self":
1420
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1421
+ * },
1422
+ * "body": {
1423
+ * "type": "doc",
1424
+ * "version": 1,
1425
+ * "content": [
1426
+ * {
1427
+ * "type": "paragraph",
1428
+ * "content": [
1429
+ * {
1430
+ * "type": "text",
1431
+ * "text": "Lorem ipsum dolor sit amet, consectetur
1432
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1433
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1434
+ * semper."
1435
+ * }
1436
+ * ]
1437
+ * }
1438
+ * ]
1439
+ * },
1440
+ * "created": "2021-01-17T12:34:00.000+0000",
1441
+ * "id": "10000",
1442
+ * "self":
1443
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1444
+ * "updateAuthor": {
1445
+ * "accountId": "5b10a2844c20165700ede21g",
1446
+ * "active": false,
1447
+ * "displayName": "Mia Krystof",
1448
+ * "self":
1449
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1450
+ * },
1451
+ * "updated": "2021-01-18T23:45:00.000+0000",
1452
+ * "visibility": {
1453
+ * "identifier": "Administrators",
1454
+ * "type": "role",
1455
+ * "value": "Administrators"
1456
+ * }
1457
+ * }
1458
+ * ],
1459
+ * "epic": {
1460
+ * "id": 37,
1461
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1462
+ * "name": "epic 1",
1463
+ * "summary": "epic 1 summary",
1464
+ * "color": {
1465
+ * "key": "color_4"
1466
+ * },
1467
+ * "done": true
1468
+ * },
1469
+ * "worklog": [
1470
+ * {
1471
+ * "author": {
1472
+ * "accountId": "5b10a2844c20165700ede21g",
1473
+ * "active": false,
1474
+ * "displayName": "Mia Krystof",
1475
+ * "self":
1476
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1477
+ * },
1478
+ * "comment": {
1479
+ * "type": "doc",
1480
+ * "version": 1,
1481
+ * "content": [
1482
+ * {
1483
+ * "type": "paragraph",
1484
+ * "content": [
1485
+ * {
1486
+ * "type": "text",
1487
+ * "text": "I did some work here."
1488
+ * }
1489
+ * ]
1490
+ * }
1491
+ * ]
1492
+ * },
1493
+ * "id": "100028",
1494
+ * "issueId": "10002",
1495
+ * "self":
1496
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1497
+ * "started": "2021-01-17T12:34:00.000+0000",
1498
+ * "timeSpent": "3h 20m",
1499
+ * "timeSpentSeconds": 12000,
1500
+ * "updateAuthor": {
1501
+ * "accountId": "5b10a2844c20165700ede21g",
1502
+ * "active": false,
1503
+ * "displayName": "Mia Krystof",
1504
+ * "self":
1505
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1506
+ * },
1507
+ * "updated": "2021-01-18T23:45:00.000+0000",
1508
+ * "visibility": {
1509
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1510
+ * "type": "group",
1511
+ * "value": "jira-developers"
1512
+ * }
1513
+ * }
1514
+ * ],
1515
+ * "updated": 1,
1516
+ * "timetracking": {
1517
+ * "originalEstimate": "10m",
1518
+ * "originalEstimateSeconds": 600,
1519
+ * "remainingEstimate": "3m",
1520
+ * "remainingEstimateSeconds": 200,
1521
+ * "timeSpent": "6m",
1522
+ * "timeSpentSeconds": 400
1523
+ * }
1524
+ * },
1525
+ * "id": "10001",
1526
+ * "key": "HSP-1",
1527
+ * "self":
1528
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1529
+ * }
1530
+ * ],
1531
+ * "maxResults": 50,
1532
+ * "startAt": 0,
1533
+ * "total": 1
1534
+ * }
1535
+ * @path {GET} /rest/agile/1.0/board/{boardId}/issue
1536
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
1537
+ */
1538
+ this.getIssuesForBoard = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
1539
+ return this.getClientInstance()
1540
+ .request({
1541
+ path: "/rest/agile/1.0/board/{boardId}/issue",
1542
+ method: "GET",
1543
+ pathParams: {
1544
+ boardId,
1545
+ },
1546
+ query: {
1547
+ startAt,
1548
+ maxResults,
1549
+ jql,
1550
+ validateQuery,
1551
+ fields,
1552
+ expand,
1553
+ },
1554
+ })
1555
+ .then(this.getClientInstance().responseHandler({
1556
+ 200: {
1557
+ "application/json": "json",
1558
+ },
1559
+ }))
1560
+ .then(commonHttpClient.castResponse())
1561
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesForBoard.response"))
1562
+ .then(commonHttpClient.getBody);
1563
+ };
1564
+ /**
1565
+ * Returns all issues that do not belong to any epic on a board, for a given board
1566
+ * ID. This only includes issues that the user has permission to view. Issues
1567
+ * returned from this resource include Agile fields, like sprint, closedSprints,
1568
+ * flagged, and epic. By default, the returned issues are ordered by rank.
1569
+ *
1570
+ * @returns Returns the requested issues, at the specified page of the results.
1571
+ *
1572
+ * example: {
1573
+ * "expand": "names,schema",
1574
+ * "issues": [
1575
+ * {
1576
+ * "expand": "",
1577
+ * "fields": {
1578
+ * "flagged": true,
1579
+ * "sprint": {
1580
+ * "id": 37,
1581
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1582
+ * "state": "future",
1583
+ * "name": "sprint 2",
1584
+ * "goal": "sprint 2 goal"
1585
+ * },
1586
+ * "closedSprints": [
1587
+ * {
1588
+ * "id": 37,
1589
+ * "self":
1590
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1591
+ * "state": "closed",
1592
+ * "name": "sprint 1",
1593
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
1594
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
1595
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
1596
+ * "goal": "sprint 1 goal"
1597
+ * }
1598
+ * ],
1599
+ * "description": "example bug report",
1600
+ * "project": {
1601
+ * "avatarUrls": {
1602
+ * "16x16":
1603
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1604
+ * "24x24":
1605
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1606
+ * "32x32":
1607
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1608
+ * "48x48":
1609
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1610
+ * },
1611
+ * "id": "10000",
1612
+ * "insight": {
1613
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1614
+ * "totalIssueCount": 100
1615
+ * },
1616
+ * "key": "EX",
1617
+ * "name": "Example",
1618
+ * "projectCategory": {
1619
+ * "description": "First Project Category",
1620
+ * "id": "10000",
1621
+ * "name": "FIRST",
1622
+ * "self":
1623
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1624
+ * },
1625
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1626
+ * "simplified": false,
1627
+ * "style": "classic"
1628
+ * },
1629
+ * "comment": [
1630
+ * {
1631
+ * "author": {
1632
+ * "accountId": "5b10a2844c20165700ede21g",
1633
+ * "active": false,
1634
+ * "displayName": "Mia Krystof",
1635
+ * "self":
1636
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1637
+ * },
1638
+ * "body": {
1639
+ * "type": "doc",
1640
+ * "version": 1,
1641
+ * "content": [
1642
+ * {
1643
+ * "type": "paragraph",
1644
+ * "content": [
1645
+ * {
1646
+ * "type": "text",
1647
+ * "text": "Lorem ipsum dolor sit amet, consectetur
1648
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1649
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1650
+ * semper."
1651
+ * }
1652
+ * ]
1653
+ * }
1654
+ * ]
1655
+ * },
1656
+ * "created": "2021-01-17T12:34:00.000+0000",
1657
+ * "id": "10000",
1658
+ * "self":
1659
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1660
+ * "updateAuthor": {
1661
+ * "accountId": "5b10a2844c20165700ede21g",
1662
+ * "active": false,
1663
+ * "displayName": "Mia Krystof",
1664
+ * "self":
1665
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1666
+ * },
1667
+ * "updated": "2021-01-18T23:45:00.000+0000",
1668
+ * "visibility": {
1669
+ * "identifier": "Administrators",
1670
+ * "type": "role",
1671
+ * "value": "Administrators"
1672
+ * }
1673
+ * }
1674
+ * ],
1675
+ * "epic": {
1676
+ * "id": 37,
1677
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1678
+ * "name": "epic 1",
1679
+ * "summary": "epic 1 summary",
1680
+ * "color": {
1681
+ * "key": "color_4"
1682
+ * },
1683
+ * "done": true
1684
+ * },
1685
+ * "worklog": [
1686
+ * {
1687
+ * "author": {
1688
+ * "accountId": "5b10a2844c20165700ede21g",
1689
+ * "active": false,
1690
+ * "displayName": "Mia Krystof",
1691
+ * "self":
1692
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1693
+ * },
1694
+ * "comment": {
1695
+ * "type": "doc",
1696
+ * "version": 1,
1697
+ * "content": [
1698
+ * {
1699
+ * "type": "paragraph",
1700
+ * "content": [
1701
+ * {
1702
+ * "type": "text",
1703
+ * "text": "I did some work here."
1704
+ * }
1705
+ * ]
1706
+ * }
1707
+ * ]
1708
+ * },
1709
+ * "id": "100028",
1710
+ * "issueId": "10002",
1711
+ * "self":
1712
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1713
+ * "started": "2021-01-17T12:34:00.000+0000",
1714
+ * "timeSpent": "3h 20m",
1715
+ * "timeSpentSeconds": 12000,
1716
+ * "updateAuthor": {
1717
+ * "accountId": "5b10a2844c20165700ede21g",
1718
+ * "active": false,
1719
+ * "displayName": "Mia Krystof",
1720
+ * "self":
1721
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1722
+ * },
1723
+ * "updated": "2021-01-18T23:45:00.000+0000",
1724
+ * "visibility": {
1725
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1726
+ * "type": "group",
1727
+ * "value": "jira-developers"
1728
+ * }
1729
+ * }
1730
+ * ],
1731
+ * "updated": 1,
1732
+ * "timetracking": {
1733
+ * "originalEstimate": "10m",
1734
+ * "originalEstimateSeconds": 600,
1735
+ * "remainingEstimate": "3m",
1736
+ * "remainingEstimateSeconds": 200,
1737
+ * "timeSpent": "6m",
1738
+ * "timeSpentSeconds": 400
1739
+ * }
1740
+ * },
1741
+ * "id": "10001",
1742
+ * "key": "HSP-1",
1743
+ * "self":
1744
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1745
+ * }
1746
+ * ],
1747
+ * "maxResults": 50,
1748
+ * "startAt": 0,
1749
+ * "total": 1
1750
+ * }
1751
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic/none/issue
1752
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get
1753
+ */
1754
+ this.getIssuesWithoutEpicForBoard = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
1755
+ return this.getClientInstance()
1756
+ .request({
1757
+ path: "/rest/agile/1.0/board/{boardId}/epic/none/issue",
1758
+ method: "GET",
1759
+ pathParams: {
1760
+ boardId,
1761
+ },
1762
+ query: {
1763
+ startAt,
1764
+ maxResults,
1765
+ jql,
1766
+ validateQuery,
1767
+ fields,
1768
+ expand,
1769
+ },
1770
+ })
1771
+ .then(this.getClientInstance().responseHandler({
1772
+ 200: {
1773
+ "application/json": "json",
1774
+ },
1775
+ }))
1776
+ .then(commonHttpClient.castResponse())
1777
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getIssuesWithoutEpicForBoard.response"))
1778
+ .then(commonHttpClient.getBody);
1779
+ };
1780
+ /**
1781
+ * Returns all projects that are associated with the board, for the given board
1782
+ * ID. If the user does not have permission to view the board, no projects will be
1783
+ * returned at all. Returned projects are ordered by the name.
1784
+ *
1785
+ * A project is associated with a board if the board filter contains reference the
1786
+ * project or there is an issue from the project that belongs to the board.
1787
+ *
1788
+ * The board filter contains reference the project only if JQL query guarantees
1789
+ * that returned issues will be returned from the project set defined in JQL. For
1790
+ * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
1791
+ * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
1792
+ * doesn't have reference to any project.
1793
+ *
1794
+ * An issue belongs to the board if its status is mapped to the board's column.
1795
+ * Epic issues do not belongs to the scrum boards.
1796
+ *
1797
+ * @returns Returns the board's projects, at the specified page of the results.
1798
+ *
1799
+ * example: {
1800
+ * "isLast": true,
1801
+ * "maxResults": 10,
1802
+ * "startAt": 0,
1803
+ * "total": 2,
1804
+ * "values": [
1805
+ * {
1806
+ * "avatarUrls": {
1807
+ * "16x16": "secure/projectavatar?size=xsmall&pid=10000",
1808
+ * "24x24": "secure/projectavatar?size=small&pid=10000",
1809
+ * "32x32": "secure/projectavatar?size=medium&pid=10000",
1810
+ * "48x48": "secure/projectavatar?size=large&pid=10000"
1811
+ * },
1812
+ * "id": "10000",
1813
+ * "key": "EX",
1814
+ * "name": "Example",
1815
+ * "projectCategory": {
1816
+ * "description": "Project category description",
1817
+ * "id": "10000",
1818
+ * "name": "A project category"
1819
+ * },
1820
+ * "projectTypeKey": "ProjectTypeKey{key='software'}",
1821
+ * "self": "project/EX",
1822
+ * "simplified": false
1823
+ * }
1824
+ * ]
1825
+ * }
1826
+ * @path {GET} /rest/agile/1.0/board/{boardId}/project
1827
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-get
1828
+ */
1829
+ this.getProjects = ({ boardId, startAt, maxResults, }) => {
1830
+ return this.getClientInstance()
1831
+ .request({
1832
+ path: "/rest/agile/1.0/board/{boardId}/project",
1833
+ method: "GET",
1834
+ pathParams: {
1835
+ boardId,
1836
+ },
1837
+ query: {
1838
+ startAt,
1839
+ maxResults,
1840
+ },
1841
+ })
1842
+ .then(this.getClientInstance().responseHandler({
1843
+ 200: {
1844
+ "application/json": "json",
1845
+ },
1846
+ }))
1847
+ .then(commonHttpClient.castResponse())
1848
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getProjects.response"))
1849
+ .then(commonHttpClient.getBody);
1850
+ };
1851
+ /**
1852
+ * Returns all projects that are statically associated with the board, for the
1853
+ * given board ID. Returned projects are ordered by the name.
1854
+ *
1855
+ * A project is associated with a board if the board filter contains reference the
1856
+ * project.
1857
+ *
1858
+ * The board filter contains reference the project only if JQL query guarantees
1859
+ * that returned issues will be returned from the project set defined in JQL. For
1860
+ * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
1861
+ * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
1862
+ * doesn't have reference to any project.
1863
+ *
1864
+ * @path {GET} /rest/agile/1.0/board/{boardId}/project/full
1865
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-full-get
1866
+ */
1867
+ this.getProjectsFull = ({ boardId, }) => {
1868
+ return this.getClientInstance()
1869
+ .request({
1870
+ path: "/rest/agile/1.0/board/{boardId}/project/full",
1871
+ method: "GET",
1872
+ pathParams: {
1873
+ boardId,
1874
+ },
1875
+ })
1876
+ .then(commonHttpClient.discardResult);
1877
+ };
1878
+ /**
1879
+ * Returns the quick filter for a given quick filter ID. The quick filter will
1880
+ * only be returned if the user can view the board that the quick filter belongs
1881
+ * to.
1882
+ *
1883
+ * @returns Returns the requested quick filter.
1884
+ *
1885
+ * example: {
1886
+ * "boardId": 1,
1887
+ * "description": "Issues of type bug",
1888
+ * "id": 1,
1889
+ * "jql": "issueType = bug",
1890
+ * "name": "Bugs",
1891
+ * "position": 0
1892
+ * }
1893
+ * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
1894
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-quickfilterid-get
1895
+ */
1896
+ this.getQuickFilter = ({ boardId, quickFilterId, }) => {
1897
+ return this.getClientInstance()
1898
+ .request({
1899
+ path: "/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}",
1900
+ method: "GET",
1901
+ pathParams: {
1902
+ boardId,
1903
+ quickFilterId,
1904
+ },
1905
+ })
1906
+ .then(this.getClientInstance().responseHandler({
1907
+ 200: {
1908
+ "application/json": "json",
1909
+ },
1910
+ }))
1911
+ .then(commonHttpClient.castResponse())
1912
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getQuickFilter.response"))
1913
+ .then(commonHttpClient.getBody);
1914
+ };
1915
+ /**
1916
+ * @returns 200 response
1917
+ * @path {GET} /rest/agile/1.0/board/{boardId}/reports
1918
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-reports-get
1919
+ */
1920
+ this.getReportsForBoard = ({ boardId, }) => {
1921
+ return this.getClientInstance()
1922
+ .request({
1923
+ path: "/rest/agile/1.0/board/{boardId}/reports",
1924
+ method: "GET",
1925
+ pathParams: {
1926
+ boardId,
1927
+ },
1928
+ })
1929
+ .then(this.getClientInstance().responseHandler({
1930
+ 200: {
1931
+ "application/json": "json",
1932
+ },
1933
+ }))
1934
+ .then(commonHttpClient.castResponse())
1935
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.getReportsForBoard.response"))
1936
+ .then(commonHttpClient.getBody);
1937
+ };
1938
+ /**
1939
+ * Move issues from the backog to the board (if they are already in the backlog of
1940
+ * that board).
1941
+ * This operation either moves an issue(s) onto a board from the backlog (by
1942
+ * adding it to the issueList for the board) Or transitions the issue(s) to the
1943
+ * first column for a kanban board with backlog. At most 50 issues may be moved at
1944
+ * once.
1945
+ *
1946
+ * @returns Returns the list of issue with status of rank operation.
1947
+ *
1948
+ * example: {
1949
+ * "entries": [
1950
+ * {
1951
+ * "issueId": 10000,
1952
+ * "issueKey": "PR-1",
1953
+ * "status": 200
1954
+ * },
1955
+ * {
1956
+ * "issueId": 10001,
1957
+ * "issueKey": "PR-2",
1958
+ * "status": 200
1959
+ * },
1960
+ * {
1961
+ * "errors": [
1962
+ * "JIRA Agile cannot execute the rank operation at this time. Please try
1963
+ * again later."
1964
+ * ],
1965
+ * "issueId": 10002,
1966
+ * "issueKey": "PR-3",
1967
+ * "status": 503
1968
+ * }
1969
+ * ]
1970
+ * }
1971
+ * @path {POST} /rest/agile/1.0/board/{boardId}/issue
1972
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-post
1973
+ */
1974
+ this.moveIssuesToBoard = ({ boardId, issueRankRequestBean, }) => {
1975
+ return this.getClientInstance()
1976
+ .request({
1977
+ path: "/rest/agile/1.0/board/{boardId}/issue",
1978
+ method: "POST",
1979
+ pathParams: {
1980
+ boardId,
1981
+ },
1982
+ headers: {
1983
+ "Content-Type": "application/json",
1984
+ },
1985
+ body: issueRankRequestBean,
1986
+ })
1987
+ .then(this.getClientInstance().responseHandler({
1988
+ 204: {},
1989
+ 207: {
1990
+ "application/json": "json",
1991
+ },
1992
+ }))
1993
+ .then(commonHttpClient.castResponse())
1994
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.moveIssuesToBoard.response"))
1995
+ .then(commonHttpClient.getBody);
1996
+ };
1997
+ /**
1998
+ * Sets the value of the specified board's property.
1999
+ *
2000
+ * You can use this resource to store a custom data against the board identified
2001
+ * by the id. The user who stores the data is required to have permissions to
2002
+ * modify the board.
2003
+ *
2004
+ * @returns * status: 200, mediaType: application/json
2005
+ *
2006
+ * Returned if the board property is successfully updated.
2007
+ *
2008
+ * * status: 201, mediaType: application/json
2009
+ *
2010
+ * Returned if the board property is successfully created.
2011
+ * @path {PUT} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
2012
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-put
2013
+ */
2014
+ this.setBoardProperty = ({ boardId, propertyKey, requestBody, }) => {
2015
+ return this.getClientInstance()
2016
+ .request({
2017
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
2018
+ method: "PUT",
2019
+ pathParams: {
2020
+ boardId,
2021
+ propertyKey,
2022
+ },
2023
+ headers: {
2024
+ "Content-Type": "application/json",
2025
+ },
2026
+ body: requestBody,
2027
+ })
2028
+ .then(this.getClientInstance().responseHandler({
2029
+ 200: {
2030
+ "application/json": "json",
2031
+ },
2032
+ 201: {
2033
+ "application/json": "json",
2034
+ },
2035
+ }))
2036
+ .then(commonHttpClient.castResponse())
2037
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.setBoardProperty.response"))
2038
+ .then(commonHttpClient.asCreatedResponse("body"));
2039
+ };
2040
+ /**
2041
+ * @returns 200 response
2042
+ * @path {PUT} /rest/agile/1.0/board/{boardId}/features
2043
+ * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-put
2044
+ */
2045
+ this.toggleFeatures = ({ boardId, featureToggleRequestBean, }) => {
2046
+ return this.getClientInstance()
2047
+ .request({
2048
+ path: "/rest/agile/1.0/board/{boardId}/features",
2049
+ method: "PUT",
2050
+ pathParams: {
2051
+ boardId,
2052
+ },
2053
+ headers: {
2054
+ "Content-Type": "application/json",
2055
+ },
2056
+ body: featureToggleRequestBean,
2057
+ })
2058
+ .then(this.getClientInstance().responseHandler({
2059
+ 200: {
2060
+ "application/json": "json",
2061
+ },
2062
+ }))
2063
+ .then(commonHttpClient.castResponse())
2064
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("BoardService.toggleFeatures.response"))
2065
+ .then(commonHttpClient.getBody);
2066
+ };
2064
2067
  }
2065
2068
  static initialize() {
2066
2069
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("BoardService.getAllBoards.response", zod_1.z