azure-devops-extension-api 4.270.0 → 5.271.0

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 (699) hide show
  1. package/Accounts/Accounts.d.ts +126 -126
  2. package/Accounts/Accounts.js +61 -62
  3. package/Accounts/Accounts.min.js +1 -1
  4. package/Accounts/AccountsClient.d.ts +24 -24
  5. package/Accounts/AccountsClient.js +78 -124
  6. package/Accounts/AccountsClient.min.js +1 -1
  7. package/Accounts/index.d.ts +2 -2
  8. package/Accounts/index.js +18 -9
  9. package/Accounts/index.min.js +1 -1
  10. package/AdvancedSecurity.Reporting/Reporting.d.ts +717 -717
  11. package/AdvancedSecurity.Reporting/Reporting.js +203 -204
  12. package/AdvancedSecurity.Reporting/Reporting.min.js +1 -1
  13. package/AdvancedSecurity.Reporting/ReportingClient.d.ts +83 -83
  14. package/AdvancedSecurity.Reporting/ReportingClient.js +267 -343
  15. package/AdvancedSecurity.Reporting/ReportingClient.min.js +1 -1
  16. package/Alert/Alert.d.ts +1265 -1265
  17. package/Alert/Alert.js +425 -426
  18. package/Alert/Alert.min.js +1 -1
  19. package/Alert/AlertClient.d.ts +184 -159
  20. package/Alert/AlertClient.js +512 -533
  21. package/Alert/AlertClient.min.js +1 -1
  22. package/Build/Build.d.ts +3318 -3292
  23. package/Build/Build.js +613 -607
  24. package/Build/Build.min.js +1 -1
  25. package/Build/BuildClient.d.ts +842 -820
  26. package/Build/BuildClient.js +2319 -2568
  27. package/Build/BuildClient.min.js +1 -1
  28. package/Build/BuildServices.d.ts +32 -32
  29. package/Build/BuildServices.js +13 -14
  30. package/Build/BuildServices.min.js +1 -1
  31. package/Build/index.d.ts +3 -3
  32. package/Build/index.js +19 -10
  33. package/Build/index.min.js +1 -1
  34. package/Comments/Comments.d.ts +309 -309
  35. package/Comments/Comments.js +93 -94
  36. package/Comments/Comments.min.js +1 -1
  37. package/Comments/index.d.ts +1 -1
  38. package/Comments/index.js +17 -8
  39. package/Comments/index.min.js +1 -1
  40. package/Common/Client.d.ts +9 -9
  41. package/Common/Client.js +25 -26
  42. package/Common/Client.min.js +1 -1
  43. package/Common/CommonServices.d.ts +774 -735
  44. package/Common/CommonServices.js +71 -72
  45. package/Common/CommonServices.min.js +1 -1
  46. package/Common/Context.js +2 -0
  47. package/Common/Fetch.d.ts +95 -95
  48. package/Common/Fetch.js +131 -168
  49. package/Common/Fetch.min.js +1 -1
  50. package/Common/RestClientBase.d.ts +96 -96
  51. package/Common/RestClientBase.js +109 -139
  52. package/Common/RestClientBase.min.js +1 -1
  53. package/Common/System.d.ts +30 -30
  54. package/Common/System.js +39 -40
  55. package/Common/System.min.js +1 -1
  56. package/Common/SystemData.d.ts +129 -129
  57. package/Common/SystemData.js +138 -139
  58. package/Common/SystemData.min.js +1 -1
  59. package/Common/Util/Serialization.d.ts +15 -15
  60. package/Common/Util/Serialization.js +51 -53
  61. package/Common/Util/Serialization.min.js +1 -1
  62. package/Common/Util/Url.d.ts +238 -236
  63. package/Common/Util/Url.js +605 -626
  64. package/Common/Util/Url.min.js +1 -1
  65. package/Common/index.d.ts +3 -3
  66. package/Common/index.js +19 -9
  67. package/Common/index.min.js +1 -1
  68. package/Contributions/Contributions.d.ts +694 -694
  69. package/Contributions/Contributions.js +185 -186
  70. package/Contributions/Contributions.min.js +1 -1
  71. package/Contributions/ContributionsClient.d.ts +31 -31
  72. package/Contributions/ContributionsClient.js +99 -147
  73. package/Contributions/ContributionsClient.min.js +1 -1
  74. package/Contributions/index.d.ts +2 -2
  75. package/Contributions/index.js +18 -9
  76. package/Contributions/index.min.js +1 -1
  77. package/Core/Core.d.ts +546 -546
  78. package/Core/Core.js +79 -80
  79. package/Core/Core.min.js +1 -1
  80. package/Core/CoreClient.d.ts +224 -224
  81. package/Core/CoreClient.js +652 -777
  82. package/Core/CoreClient.min.js +1 -1
  83. package/Core/index.d.ts +2 -2
  84. package/Core/index.js +18 -9
  85. package/Core/index.min.js +1 -1
  86. package/Dashboard/Dashboard.d.ts +393 -393
  87. package/Dashboard/Dashboard.js +56 -57
  88. package/Dashboard/Dashboard.min.js +1 -1
  89. package/Dashboard/DashboardClient.d.ts +106 -106
  90. package/Dashboard/DashboardClient.js +317 -393
  91. package/Dashboard/DashboardClient.min.js +1 -1
  92. package/Dashboard/WidgetConfigHelpers.d.ts +34 -34
  93. package/Dashboard/WidgetConfigHelpers.js +41 -45
  94. package/Dashboard/WidgetConfigHelpers.min.js +1 -1
  95. package/Dashboard/WidgetContracts.d.ts +213 -213
  96. package/Dashboard/WidgetContracts.js +24 -25
  97. package/Dashboard/WidgetContracts.min.js +1 -1
  98. package/Dashboard/WidgetHelpers.d.ts +89 -89
  99. package/Dashboard/WidgetHelpers.js +135 -146
  100. package/Dashboard/WidgetHelpers.min.js +1 -1
  101. package/Dashboard/index.d.ts +5 -5
  102. package/Dashboard/index.js +21 -12
  103. package/Dashboard/index.min.js +1 -1
  104. package/DistributedTaskCommon/DistributedTaskCommon.d.ts +103 -103
  105. package/DistributedTaskCommon/DistributedTaskCommon.js +7 -9
  106. package/DistributedTaskCommon/DistributedTaskCommon.min.js +1 -1
  107. package/DistributedTaskCommon/index.d.ts +1 -1
  108. package/DistributedTaskCommon/index.js +17 -4
  109. package/DistributedTaskCommon/index.min.js +1 -1
  110. package/ExtensionManagement/ExtensionManagement.d.ts +1163 -1163
  111. package/ExtensionManagement/ExtensionManagement.js +284 -285
  112. package/ExtensionManagement/ExtensionManagement.min.js +1 -1
  113. package/ExtensionManagement/ExtensionManagementClient.d.ts +191 -191
  114. package/ExtensionManagement/ExtensionManagementClient.js +551 -648
  115. package/ExtensionManagement/ExtensionManagementClient.min.js +1 -1
  116. package/ExtensionManagement/index.d.ts +2 -2
  117. package/ExtensionManagement/index.js +18 -9
  118. package/ExtensionManagement/index.min.js +1 -1
  119. package/Favorite/Favorite.d.ts +124 -124
  120. package/Favorite/Favorite.js +7 -9
  121. package/Favorite/Favorite.min.js +1 -1
  122. package/Favorite/FavoriteClient.d.ts +78 -78
  123. package/Favorite/FavoriteClient.js +247 -314
  124. package/Favorite/FavoriteClient.min.js +1 -1
  125. package/FeatureAvailability/FeatureAvailability.d.ts +13 -13
  126. package/FeatureAvailability/FeatureAvailability.js +7 -9
  127. package/FeatureAvailability/FeatureAvailability.min.js +1 -1
  128. package/FeatureAvailability/FeatureAvailabilityClient.d.ts +45 -45
  129. package/FeatureAvailability/FeatureAvailabilityClient.js +136 -189
  130. package/FeatureAvailability/FeatureAvailabilityClient.min.js +1 -1
  131. package/FeatureAvailability/index.d.ts +2 -2
  132. package/FeatureAvailability/index.js +18 -8
  133. package/FeatureAvailability/index.min.js +1 -1
  134. package/FeatureManagement/FeatureManagement.d.ts +161 -161
  135. package/FeatureManagement/FeatureManagement.js +26 -27
  136. package/FeatureManagement/FeatureManagement.min.js +1 -1
  137. package/FeatureManagement/FeatureManagementClient.d.ts +78 -78
  138. package/FeatureManagement/FeatureManagementClient.js +214 -273
  139. package/FeatureManagement/FeatureManagementClient.min.js +1 -1
  140. package/FeatureManagement/index.d.ts +2 -2
  141. package/FeatureManagement/index.js +18 -9
  142. package/FeatureManagement/index.min.js +1 -1
  143. package/FileContainer/FileContainer.d.ts +193 -193
  144. package/FileContainer/FileContainer.js +58 -59
  145. package/FileContainer/FileContainer.min.js +1 -1
  146. package/FileContainer/FileContainerClient.d.ts +47 -47
  147. package/FileContainer/FileContainerClient.js +132 -182
  148. package/FileContainer/FileContainerClient.min.js +1 -1
  149. package/FileContainer/index.d.ts +2 -2
  150. package/FileContainer/index.js +18 -9
  151. package/FileContainer/index.min.js +1 -1
  152. package/FormInput/FormInput.d.ts +278 -278
  153. package/FormInput/FormInput.js +77 -78
  154. package/FormInput/FormInput.min.js +1 -1
  155. package/FormInput/index.d.ts +1 -1
  156. package/FormInput/index.js +17 -8
  157. package/FormInput/index.min.js +1 -1
  158. package/Gallery/Gallery.d.ts +1911 -1911
  159. package/Gallery/Gallery.js +788 -789
  160. package/Gallery/Gallery.min.js +1 -1
  161. package/Gallery/GalleryClient.d.ts +613 -603
  162. package/Gallery/GalleryClient.js +1884 -2100
  163. package/Gallery/GalleryClient.min.js +1 -1
  164. package/Gallery/index.d.ts +2 -2
  165. package/Gallery/index.js +18 -9
  166. package/Gallery/index.min.js +1 -1
  167. package/Git/CodeEditorTypes.d.ts +305 -305
  168. package/Git/CodeEditorTypes.js +27 -28
  169. package/Git/CodeEditorTypes.min.js +1 -1
  170. package/Git/Git.d.ts +3976 -4071
  171. package/Git/Git.js +830 -839
  172. package/Git/Git.min.js +1 -1
  173. package/Git/GitClient.d.ts +1468 -1466
  174. package/Git/GitClient.js +3892 -4347
  175. package/Git/GitClient.min.js +1 -1
  176. package/Git/GitServices.d.ts +16 -16
  177. package/Git/GitServices.js +10 -11
  178. package/Git/GitServices.min.js +1 -1
  179. package/Git/index.d.ts +4 -4
  180. package/Git/index.js +20 -11
  181. package/Git/index.min.js +1 -1
  182. package/Graph/Graph.d.ts +518 -518
  183. package/Graph/Graph.js +14 -15
  184. package/Graph/Graph.min.js +1 -1
  185. package/Graph/GraphClient.d.ts +261 -261
  186. package/Graph/GraphClient.js +737 -867
  187. package/Graph/GraphClient.min.js +1 -1
  188. package/Graph/index.d.ts +2 -2
  189. package/Graph/index.js +18 -9
  190. package/Graph/index.min.js +1 -1
  191. package/Identities/Identities.d.ts +242 -242
  192. package/Identities/Identities.js +49 -50
  193. package/Identities/Identities.min.js +1 -1
  194. package/Identities/IdentityProvider.d.ts +40 -40
  195. package/Identities/IdentityProvider.js +47 -49
  196. package/Identities/IdentityProvider.min.js +1 -1
  197. package/Identities/IdentityService.d.ts +72 -72
  198. package/Identities/IdentityService.js +13 -14
  199. package/Identities/IdentityService.min.js +1 -1
  200. package/Identities/index.d.ts +3 -3
  201. package/Identities/index.js +19 -10
  202. package/Identities/index.min.js +1 -1
  203. package/Locations/Locations.d.ts +150 -150
  204. package/Locations/Locations.js +28 -29
  205. package/Locations/Locations.min.js +1 -1
  206. package/Locations/LocationsClient.d.ts +65 -65
  207. package/Locations/LocationsClient.js +211 -276
  208. package/Locations/LocationsClient.min.js +1 -1
  209. package/Locations/index.d.ts +2 -2
  210. package/Locations/index.js +18 -9
  211. package/Locations/index.min.js +1 -1
  212. package/Management/Management.d.ts +424 -407
  213. package/Management/Management.js +27 -28
  214. package/Management/Management.min.js +1 -1
  215. package/Management/ManagementClient.d.ts +116 -105
  216. package/Management/ManagementClient.js +349 -398
  217. package/Management/ManagementClient.min.js +1 -1
  218. package/Notification/Notification.d.ts +1387 -1387
  219. package/Notification/Notification.js +385 -386
  220. package/Notification/Notification.min.js +1 -1
  221. package/Notification/NotificationClient.d.ts +149 -149
  222. package/Notification/NotificationClient.js +420 -511
  223. package/Notification/NotificationClient.min.js +1 -1
  224. package/Notification/index.d.ts +2 -2
  225. package/Notification/index.js +18 -9
  226. package/Notification/index.min.js +1 -1
  227. package/Operations/Operations.d.ts +77 -77
  228. package/Operations/Operations.js +38 -39
  229. package/Operations/Operations.min.js +1 -1
  230. package/Operations/OperationsClient.d.ts +13 -13
  231. package/Operations/OperationsClient.js +45 -86
  232. package/Operations/OperationsClient.min.js +1 -1
  233. package/Operations/index.d.ts +2 -2
  234. package/Operations/index.js +18 -9
  235. package/Operations/index.min.js +1 -1
  236. package/Pipelines/Pipelines.d.ts +341 -341
  237. package/Pipelines/Pipelines.js +82 -83
  238. package/Pipelines/Pipelines.min.js +1 -1
  239. package/Pipelines/PipelinesClient.d.ts +92 -92
  240. package/Pipelines/PipelinesClient.js +260 -325
  241. package/Pipelines/PipelinesClient.min.js +1 -1
  242. package/Policy/Policy.d.ts +160 -160
  243. package/Policy/Policy.js +38 -39
  244. package/Policy/Policy.min.js +1 -1
  245. package/Policy/PolicyClient.d.ts +99 -99
  246. package/Policy/PolicyClient.js +274 -346
  247. package/Policy/PolicyClient.min.js +1 -1
  248. package/Policy/index.d.ts +2 -2
  249. package/Policy/index.js +18 -9
  250. package/Policy/index.min.js +1 -1
  251. package/Profile/Profile.d.ts +175 -175
  252. package/Profile/Profile.js +35 -36
  253. package/Profile/Profile.min.js +1 -1
  254. package/Profile/ProfileClient.d.ts +86 -86
  255. package/Profile/ProfileClient.js +277 -347
  256. package/Profile/ProfileClient.min.js +1 -1
  257. package/Profile/index.d.ts +2 -2
  258. package/Profile/index.js +18 -9
  259. package/Profile/index.min.js +1 -1
  260. package/ProjectAnalysis/ProjectAnalysis.d.ts +59 -59
  261. package/ProjectAnalysis/ProjectAnalysis.js +18 -19
  262. package/ProjectAnalysis/ProjectAnalysis.min.js +1 -1
  263. package/ProjectAnalysis/ProjectAnalysisClient.d.ts +34 -34
  264. package/ProjectAnalysis/ProjectAnalysisClient.js +110 -159
  265. package/ProjectAnalysis/ProjectAnalysisClient.min.js +1 -1
  266. package/ProjectAnalysis/index.d.ts +2 -2
  267. package/ProjectAnalysis/index.js +18 -9
  268. package/ProjectAnalysis/index.min.js +1 -1
  269. package/README.md +57 -1
  270. package/Release/Release.d.ts +4068 -4068
  271. package/Release/Release.js +876 -877
  272. package/Release/Release.min.js +1 -1
  273. package/Release/ReleaseClient.d.ts +720 -720
  274. package/Release/ReleaseClient.js +2003 -2273
  275. package/Release/ReleaseClient.min.js +1 -1
  276. package/Release/index.d.ts +2 -2
  277. package/Release/index.js +18 -9
  278. package/Release/index.min.js +1 -1
  279. package/ResourceUsage/ResourceUsage.d.ts +13 -13
  280. package/ResourceUsage/ResourceUsage.js +7 -9
  281. package/ResourceUsage/ResourceUsage.min.js +1 -1
  282. package/ResourceUsage/ResourceUsageClient.d.ts +20 -20
  283. package/ResourceUsage/ResourceUsageClient.js +51 -93
  284. package/ResourceUsage/ResourceUsageClient.min.js +1 -1
  285. package/ServiceEndpoint/ServiceEndpoint.d.ts +894 -894
  286. package/ServiceEndpoint/ServiceEndpoint.js +84 -85
  287. package/ServiceEndpoint/ServiceEndpoint.min.js +1 -1
  288. package/ServiceEndpoint/ServiceEndpointClient.d.ts +190 -190
  289. package/ServiceEndpoint/ServiceEndpointClient.js +556 -669
  290. package/ServiceEndpoint/ServiceEndpointClient.min.js +1 -1
  291. package/ServiceEndpoint/index.d.ts +2 -2
  292. package/ServiceEndpoint/index.js +18 -9
  293. package/ServiceEndpoint/index.min.js +1 -1
  294. package/ServiceHooks/ServiceHooks.d.ts +758 -758
  295. package/ServiceHooks/ServiceHooks.js +114 -115
  296. package/ServiceHooks/ServiceHooks.min.js +1 -1
  297. package/ServiceHooks/ServiceHooksClient.d.ts +156 -156
  298. package/ServiceHooks/ServiceHooksClient.js +434 -526
  299. package/ServiceHooks/ServiceHooksClient.min.js +1 -1
  300. package/ServiceHooks/index.d.ts +2 -2
  301. package/ServiceHooks/index.js +18 -9
  302. package/ServiceHooks/index.min.js +1 -1
  303. package/TaskAgent/TaskAgent.d.ts +3777 -3777
  304. package/TaskAgent/TaskAgent.js +594 -594
  305. package/TaskAgent/TaskAgent.min.js +1 -1
  306. package/TaskAgent/TaskAgentClient.d.ts +1085 -1073
  307. package/TaskAgent/TaskAgentClient.js +3273 -3731
  308. package/TaskAgent/TaskAgentClient.min.js +1 -1
  309. package/TaskAgent/index.d.ts +2 -2
  310. package/TaskAgent/index.js +18 -9
  311. package/TaskAgent/index.min.js +1 -1
  312. package/Test/Test.d.ts +5918 -5874
  313. package/Test/Test.js +1068 -1069
  314. package/Test/Test.min.js +1 -1
  315. package/Test/TestClient.d.ts +635 -635
  316. package/Test/TestClient.js +1822 -2088
  317. package/Test/TestClient.min.js +1 -1
  318. package/Test/index.d.ts +2 -2
  319. package/Test/index.js +18 -9
  320. package/Test/index.min.js +1 -1
  321. package/TestPlan/TestPlan.d.ts +1616 -1616
  322. package/TestPlan/TestPlan.js +270 -271
  323. package/TestPlan/TestPlan.min.js +1 -1
  324. package/TestPlan/TestPlanClient.d.ts +408 -408
  325. package/TestPlan/TestPlanClient.js +1160 -1387
  326. package/TestPlan/TestPlanClient.min.js +1 -1
  327. package/TestPlan/index.d.ts +2 -2
  328. package/TestPlan/index.js +18 -9
  329. package/TestPlan/index.min.js +1 -1
  330. package/TestResults/TestResults.d.ts +5 -5
  331. package/TestResults/TestResults.js +7 -9
  332. package/TestResults/TestResults.min.js +1 -1
  333. package/TestResults/TestResultsClient.d.ts +1060 -1039
  334. package/TestResults/TestResultsClient.js +3099 -3491
  335. package/TestResults/TestResultsClient.min.js +1 -1
  336. package/TestResults/index.d.ts +2 -2
  337. package/TestResults/index.js +18 -8
  338. package/TestResults/index.min.js +1 -1
  339. package/Tfvc/Tfvc.d.ts +730 -730
  340. package/Tfvc/Tfvc.js +106 -107
  341. package/Tfvc/Tfvc.min.js +1 -1
  342. package/Tfvc/TfvcClient.d.ts +227 -227
  343. package/Tfvc/TfvcClient.js +620 -732
  344. package/Tfvc/TfvcClient.min.js +1 -1
  345. package/Tfvc/index.d.ts +2 -2
  346. package/Tfvc/index.js +18 -9
  347. package/Tfvc/index.min.js +1 -1
  348. package/WebApi/WebApi.d.ts +408 -408
  349. package/WebApi/WebApi.js +55 -56
  350. package/WebApi/WebApi.min.js +1 -1
  351. package/WebApi/index.d.ts +1 -1
  352. package/WebApi/index.js +17 -8
  353. package/WebApi/index.min.js +1 -1
  354. package/Wiki/Wiki.d.ts +328 -328
  355. package/Wiki/Wiki.js +22 -23
  356. package/Wiki/Wiki.min.js +1 -1
  357. package/Wiki/WikiClient.d.ts +218 -218
  358. package/Wiki/WikiClient.js +585 -684
  359. package/Wiki/WikiClient.min.js +1 -1
  360. package/Wiki/index.d.ts +2 -2
  361. package/Wiki/index.js +18 -9
  362. package/Wiki/index.min.js +1 -1
  363. package/Work/Work.d.ts +1298 -1298
  364. package/Work/Work.js +187 -188
  365. package/Work/Work.min.js +1 -1
  366. package/Work/WorkClient.d.ts +421 -421
  367. package/Work/WorkClient.js +1255 -1455
  368. package/Work/WorkClient.min.js +1 -1
  369. package/Work/index.d.ts +2 -2
  370. package/Work/index.js +18 -9
  371. package/Work/index.min.js +1 -1
  372. package/WorkItemTracking/WorkItemTracking.d.ts +2158 -2158
  373. package/WorkItemTracking/WorkItemTracking.js +431 -432
  374. package/WorkItemTracking/WorkItemTracking.min.js +1 -1
  375. package/WorkItemTracking/WorkItemTrackingClient.d.ts +624 -624
  376. package/WorkItemTracking/WorkItemTrackingClient.js +1688 -1918
  377. package/WorkItemTracking/WorkItemTrackingClient.min.js +1 -1
  378. package/WorkItemTracking/WorkItemTrackingServices.d.ts +320 -320
  379. package/WorkItemTracking/WorkItemTrackingServices.js +18 -19
  380. package/WorkItemTracking/WorkItemTrackingServices.min.js +1 -1
  381. package/WorkItemTracking/index.d.ts +3 -3
  382. package/WorkItemTracking/index.js +19 -10
  383. package/WorkItemTracking/index.min.js +1 -1
  384. package/WorkItemTrackingProcess/WorkItemTrackingProcess.d.ts +1238 -1238
  385. package/WorkItemTrackingProcess/WorkItemTrackingProcess.js +299 -300
  386. package/WorkItemTrackingProcess/WorkItemTrackingProcess.min.js +1 -1
  387. package/WorkItemTrackingProcess/WorkItemTrackingProcessClient.d.ts +462 -462
  388. package/WorkItemTrackingProcess/WorkItemTrackingProcessClient.js +1224 -1386
  389. package/WorkItemTrackingProcess/WorkItemTrackingProcessClient.min.js +1 -1
  390. package/WorkItemTrackingProcess/index.d.ts +2 -2
  391. package/WorkItemTrackingProcess/index.js +18 -9
  392. package/WorkItemTrackingProcess/index.min.js +1 -1
  393. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitions.d.ts +575 -575
  394. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitions.js +96 -97
  395. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitions.min.js +1 -1
  396. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitionsClient.d.ts +376 -376
  397. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitionsClient.js +991 -1126
  398. package/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitionsClient.min.js +1 -1
  399. package/WorkItemTrackingProcessDefinitions/index.d.ts +2 -2
  400. package/WorkItemTrackingProcessDefinitions/index.js +18 -9
  401. package/WorkItemTrackingProcessDefinitions/index.min.js +1 -1
  402. package/_manifest/Spdx2xVs3xComparisonToolOutput.json +4 -4
  403. package/_manifest/spdx_2.2/ESRPClientLogs0504231512019.json +1 -0
  404. package/_manifest/spdx_2.2/bsi.cose +0 -0
  405. package/_manifest/spdx_2.2/bsi.json +1 -1
  406. package/_manifest/spdx_2.2/manifest.cat +0 -0
  407. package/_manifest/spdx_2.2/manifest.spdx.cose +0 -0
  408. package/_manifest/spdx_2.2/manifest.spdx.json +1 -1
  409. package/_manifest/spdx_2.2/manifest.spdx.json.sha256 +1 -1
  410. package/_manifest/spdx_3.0/manifest.spdx.json +1 -1
  411. package/_manifest/spdx_3.0/manifest.spdx.json.sha256 +1 -1
  412. package/esm/Accounts/Accounts.js +58 -0
  413. package/esm/Accounts/Accounts.min.js +1 -0
  414. package/esm/Accounts/AccountsClient.js +59 -0
  415. package/esm/Accounts/AccountsClient.min.js +1 -0
  416. package/esm/Accounts/index.js +2 -0
  417. package/esm/Accounts/index.min.js +1 -0
  418. package/esm/AdvancedSecurity.Reporting/Reporting.js +200 -0
  419. package/esm/AdvancedSecurity.Reporting/Reporting.min.js +1 -0
  420. package/esm/AdvancedSecurity.Reporting/ReportingClient.js +228 -0
  421. package/esm/AdvancedSecurity.Reporting/ReportingClient.min.js +1 -0
  422. package/esm/Alert/Alert.js +422 -0
  423. package/esm/Alert/Alert.min.js +1 -0
  424. package/esm/Alert/AlertClient.js +457 -0
  425. package/esm/Alert/AlertClient.min.js +1 -0
  426. package/esm/Build/Build.js +610 -0
  427. package/esm/Build/Build.min.js +1 -0
  428. package/esm/Build/BuildClient.js +2108 -0
  429. package/esm/Build/BuildClient.min.js +1 -0
  430. package/esm/Build/BuildServices.js +10 -0
  431. package/esm/Build/BuildServices.min.js +1 -0
  432. package/esm/Build/index.js +3 -0
  433. package/esm/Build/index.min.js +1 -0
  434. package/esm/Comments/Comments.js +90 -0
  435. package/esm/Comments/Comments.min.js +1 -0
  436. package/esm/Comments/index.js +1 -0
  437. package/esm/Comments/index.min.js +1 -0
  438. package/esm/Common/Client.js +22 -0
  439. package/esm/Common/Client.min.js +1 -0
  440. package/esm/Common/CommonServices.js +68 -0
  441. package/esm/Common/CommonServices.min.js +1 -0
  442. package/esm/Common/Context.js +1 -0
  443. package/esm/Common/Fetch.js +117 -0
  444. package/esm/Common/Fetch.min.js +1 -0
  445. package/esm/Common/RestClientBase.js +92 -0
  446. package/esm/Common/RestClientBase.min.js +1 -0
  447. package/esm/Common/System.js +36 -0
  448. package/esm/Common/System.min.js +1 -0
  449. package/esm/Common/SystemData.js +135 -0
  450. package/esm/Common/SystemData.min.js +1 -0
  451. package/esm/Common/Util/Serialization.js +48 -0
  452. package/esm/Common/Util/Serialization.min.js +1 -0
  453. package/esm/Common/Util/Url.js +595 -0
  454. package/esm/Common/Util/Url.min.js +1 -0
  455. package/esm/Common/index.js +3 -0
  456. package/esm/Common/index.min.js +1 -0
  457. package/esm/Contributions/Contributions.js +182 -0
  458. package/esm/Contributions/Contributions.min.js +1 -0
  459. package/esm/Contributions/ContributionsClient.js +78 -0
  460. package/esm/Contributions/ContributionsClient.min.js +1 -0
  461. package/esm/Contributions/index.js +2 -0
  462. package/esm/Contributions/index.min.js +1 -0
  463. package/esm/Core/Core.js +76 -0
  464. package/esm/Core/Core.min.js +1 -0
  465. package/esm/Core/CoreClient.js +573 -0
  466. package/esm/Core/CoreClient.min.js +1 -0
  467. package/esm/Core/index.js +2 -0
  468. package/esm/Core/index.min.js +1 -0
  469. package/esm/Dashboard/Dashboard.js +53 -0
  470. package/esm/Dashboard/Dashboard.min.js +1 -0
  471. package/esm/Dashboard/DashboardClient.js +278 -0
  472. package/esm/Dashboard/DashboardClient.min.js +1 -0
  473. package/esm/Dashboard/WidgetConfigHelpers.js +37 -0
  474. package/esm/Dashboard/WidgetConfigHelpers.min.js +1 -0
  475. package/esm/Dashboard/WidgetContracts.js +21 -0
  476. package/esm/Dashboard/WidgetContracts.min.js +1 -0
  477. package/esm/Dashboard/WidgetHelpers.js +129 -0
  478. package/esm/Dashboard/WidgetHelpers.min.js +1 -0
  479. package/esm/Dashboard/index.js +5 -0
  480. package/esm/Dashboard/index.min.js +1 -0
  481. package/esm/DistributedTaskCommon/DistributedTaskCommon.js +6 -0
  482. package/esm/DistributedTaskCommon/DistributedTaskCommon.min.js +1 -0
  483. package/esm/DistributedTaskCommon/index.js +1 -0
  484. package/esm/DistributedTaskCommon/index.min.js +1 -0
  485. package/esm/ExtensionManagement/ExtensionManagement.js +281 -0
  486. package/esm/ExtensionManagement/ExtensionManagement.min.js +1 -0
  487. package/esm/ExtensionManagement/ExtensionManagementClient.js +486 -0
  488. package/esm/ExtensionManagement/ExtensionManagementClient.min.js +1 -0
  489. package/esm/ExtensionManagement/index.js +2 -0
  490. package/esm/ExtensionManagement/index.min.js +1 -0
  491. package/esm/Favorite/Favorite.js +6 -0
  492. package/esm/Favorite/Favorite.min.js +1 -0
  493. package/esm/Favorite/FavoriteClient.js +214 -0
  494. package/esm/Favorite/FavoriteClient.min.js +1 -0
  495. package/esm/FeatureAvailability/FeatureAvailability.js +6 -0
  496. package/esm/FeatureAvailability/FeatureAvailability.min.js +1 -0
  497. package/esm/FeatureAvailability/FeatureAvailabilityClient.js +113 -0
  498. package/esm/FeatureAvailability/FeatureAvailabilityClient.min.js +1 -0
  499. package/esm/FeatureAvailability/index.js +2 -0
  500. package/esm/FeatureAvailability/index.min.js +1 -0
  501. package/esm/FeatureManagement/FeatureManagement.js +23 -0
  502. package/esm/FeatureManagement/FeatureManagement.min.js +1 -0
  503. package/esm/FeatureManagement/FeatureManagementClient.js +183 -0
  504. package/esm/FeatureManagement/FeatureManagementClient.min.js +1 -0
  505. package/esm/FeatureManagement/index.js +2 -0
  506. package/esm/FeatureManagement/index.min.js +1 -0
  507. package/esm/FileContainer/FileContainer.js +55 -0
  508. package/esm/FileContainer/FileContainer.min.js +1 -0
  509. package/esm/FileContainer/FileContainerClient.js +111 -0
  510. package/esm/FileContainer/FileContainerClient.min.js +1 -0
  511. package/esm/FileContainer/index.js +2 -0
  512. package/esm/FileContainer/index.min.js +1 -0
  513. package/esm/FormInput/FormInput.js +74 -0
  514. package/esm/FormInput/FormInput.min.js +1 -0
  515. package/esm/FormInput/index.js +1 -0
  516. package/esm/FormInput/index.min.js +1 -0
  517. package/esm/Gallery/Gallery.js +785 -0
  518. package/esm/Gallery/Gallery.min.js +1 -0
  519. package/esm/Gallery/GalleryClient.js +1701 -0
  520. package/esm/Gallery/GalleryClient.min.js +1 -0
  521. package/esm/Gallery/index.js +2 -0
  522. package/esm/Gallery/index.min.js +1 -0
  523. package/esm/Git/CodeEditorTypes.js +24 -0
  524. package/esm/Git/CodeEditorTypes.min.js +1 -0
  525. package/esm/Git/Git.js +827 -0
  526. package/esm/Git/Git.min.js +1 -0
  527. package/esm/Git/GitClient.js +3571 -0
  528. package/esm/Git/GitClient.min.js +1 -0
  529. package/esm/Git/GitServices.js +7 -0
  530. package/esm/Git/GitServices.min.js +1 -0
  531. package/esm/Git/index.js +4 -0
  532. package/esm/Git/index.min.js +1 -0
  533. package/esm/Graph/Graph.js +11 -0
  534. package/esm/Graph/Graph.min.js +1 -0
  535. package/esm/Graph/GraphClient.js +644 -0
  536. package/esm/Graph/GraphClient.min.js +1 -0
  537. package/esm/Graph/index.js +2 -0
  538. package/esm/Graph/index.min.js +1 -0
  539. package/esm/Identities/Identities.js +46 -0
  540. package/esm/Identities/Identities.min.js +1 -0
  541. package/esm/Identities/IdentityProvider.js +43 -0
  542. package/esm/Identities/IdentityProvider.min.js +1 -0
  543. package/esm/Identities/IdentityService.js +10 -0
  544. package/esm/Identities/IdentityService.min.js +1 -0
  545. package/esm/Identities/index.js +3 -0
  546. package/esm/Identities/index.min.js +1 -0
  547. package/esm/Locations/Locations.js +25 -0
  548. package/esm/Locations/Locations.min.js +1 -0
  549. package/esm/Locations/LocationsClient.js +178 -0
  550. package/esm/Locations/LocationsClient.min.js +1 -0
  551. package/esm/Locations/index.js +2 -0
  552. package/esm/Locations/index.min.js +1 -0
  553. package/esm/Management/Management.js +24 -0
  554. package/esm/Management/Management.min.js +1 -0
  555. package/esm/Management/ManagementClient.js +302 -0
  556. package/esm/Management/ManagementClient.min.js +1 -0
  557. package/esm/Notification/Notification.js +382 -0
  558. package/esm/Notification/Notification.min.js +1 -0
  559. package/esm/Notification/NotificationClient.js +359 -0
  560. package/esm/Notification/NotificationClient.min.js +1 -0
  561. package/esm/Notification/index.js +2 -0
  562. package/esm/Notification/index.min.js +1 -0
  563. package/esm/Operations/Operations.js +35 -0
  564. package/esm/Operations/Operations.min.js +1 -0
  565. package/esm/Operations/OperationsClient.js +30 -0
  566. package/esm/Operations/OperationsClient.min.js +1 -0
  567. package/esm/Operations/index.js +2 -0
  568. package/esm/Operations/index.min.js +1 -0
  569. package/esm/Pipelines/Pipelines.js +79 -0
  570. package/esm/Pipelines/Pipelines.min.js +1 -0
  571. package/esm/Pipelines/PipelinesClient.js +227 -0
  572. package/esm/Pipelines/PipelinesClient.min.js +1 -0
  573. package/esm/Policy/Policy.js +35 -0
  574. package/esm/Policy/Policy.min.js +1 -0
  575. package/esm/Policy/PolicyClient.js +237 -0
  576. package/esm/Policy/PolicyClient.min.js +1 -0
  577. package/esm/Policy/index.js +2 -0
  578. package/esm/Policy/index.min.js +1 -0
  579. package/esm/Profile/Profile.js +32 -0
  580. package/esm/Profile/Profile.min.js +1 -0
  581. package/esm/Profile/ProfileClient.js +240 -0
  582. package/esm/Profile/ProfileClient.min.js +1 -0
  583. package/esm/Profile/index.js +2 -0
  584. package/esm/Profile/index.min.js +1 -0
  585. package/esm/ProjectAnalysis/ProjectAnalysis.js +15 -0
  586. package/esm/ProjectAnalysis/ProjectAnalysis.min.js +1 -0
  587. package/esm/ProjectAnalysis/ProjectAnalysisClient.js +89 -0
  588. package/esm/ProjectAnalysis/ProjectAnalysisClient.min.js +1 -0
  589. package/esm/ProjectAnalysis/index.js +2 -0
  590. package/esm/ProjectAnalysis/index.min.js +1 -0
  591. package/esm/Release/Release.js +873 -0
  592. package/esm/Release/Release.min.js +1 -0
  593. package/esm/Release/ReleaseClient.js +1816 -0
  594. package/esm/Release/ReleaseClient.min.js +1 -0
  595. package/esm/Release/index.js +2 -0
  596. package/esm/Release/index.min.js +1 -0
  597. package/esm/ResourceUsage/ResourceUsage.js +6 -0
  598. package/esm/ResourceUsage/ResourceUsage.min.js +1 -0
  599. package/esm/ResourceUsage/ResourceUsageClient.js +34 -0
  600. package/esm/ResourceUsage/ResourceUsageClient.min.js +1 -0
  601. package/esm/ServiceEndpoint/ServiceEndpoint.js +81 -0
  602. package/esm/ServiceEndpoint/ServiceEndpoint.min.js +1 -0
  603. package/esm/ServiceEndpoint/ServiceEndpointClient.js +489 -0
  604. package/esm/ServiceEndpoint/ServiceEndpointClient.min.js +1 -0
  605. package/esm/ServiceEndpoint/index.js +2 -0
  606. package/esm/ServiceEndpoint/index.min.js +1 -0
  607. package/esm/ServiceHooks/ServiceHooks.js +111 -0
  608. package/esm/ServiceHooks/ServiceHooks.min.js +1 -0
  609. package/esm/ServiceHooks/ServiceHooksClient.js +375 -0
  610. package/esm/ServiceHooks/ServiceHooksClient.min.js +1 -0
  611. package/esm/ServiceHooks/index.js +2 -0
  612. package/esm/ServiceHooks/index.min.js +1 -0
  613. package/esm/TaskAgent/TaskAgent.js +590 -0
  614. package/esm/TaskAgent/TaskAgent.min.js +1 -0
  615. package/esm/TaskAgent/TaskAgentClient.js +2946 -0
  616. package/esm/TaskAgent/TaskAgentClient.min.js +1 -0
  617. package/esm/TaskAgent/index.js +2 -0
  618. package/esm/TaskAgent/index.min.js +1 -0
  619. package/esm/Test/Test.js +1065 -0
  620. package/esm/Test/Test.min.js +1 -0
  621. package/esm/Test/TestClient.js +1655 -0
  622. package/esm/Test/TestClient.min.js +1 -0
  623. package/esm/Test/index.js +2 -0
  624. package/esm/Test/index.min.js +1 -0
  625. package/esm/TestPlan/TestPlan.js +267 -0
  626. package/esm/TestPlan/TestPlan.min.js +1 -0
  627. package/esm/TestPlan/TestPlanClient.js +1051 -0
  628. package/esm/TestPlan/TestPlanClient.min.js +1 -0
  629. package/esm/TestPlan/index.js +2 -0
  630. package/esm/TestPlan/index.min.js +1 -0
  631. package/esm/TestResults/TestResults.js +6 -0
  632. package/esm/TestResults/TestResults.min.js +1 -0
  633. package/esm/TestResults/TestResultsClient.js +2822 -0
  634. package/esm/TestResults/TestResultsClient.min.js +1 -0
  635. package/esm/TestResults/index.js +2 -0
  636. package/esm/TestResults/index.min.js +1 -0
  637. package/esm/Tfvc/Tfvc.js +103 -0
  638. package/esm/Tfvc/Tfvc.min.js +1 -0
  639. package/esm/Tfvc/TfvcClient.js +559 -0
  640. package/esm/Tfvc/TfvcClient.min.js +1 -0
  641. package/esm/Tfvc/index.js +2 -0
  642. package/esm/Tfvc/index.min.js +1 -0
  643. package/esm/WebApi/WebApi.js +52 -0
  644. package/esm/WebApi/WebApi.min.js +1 -0
  645. package/esm/WebApi/index.js +1 -0
  646. package/esm/WebApi/index.min.js +1 -0
  647. package/esm/Wiki/Wiki.js +19 -0
  648. package/esm/Wiki/Wiki.min.js +1 -0
  649. package/esm/Wiki/WikiClient.js +528 -0
  650. package/esm/Wiki/WikiClient.min.js +1 -0
  651. package/esm/Wiki/index.js +2 -0
  652. package/esm/Wiki/index.min.js +1 -0
  653. package/esm/Work/Work.js +184 -0
  654. package/esm/Work/Work.min.js +1 -0
  655. package/esm/Work/WorkClient.js +1128 -0
  656. package/esm/Work/WorkClient.min.js +1 -0
  657. package/esm/Work/index.js +2 -0
  658. package/esm/Work/index.min.js +1 -0
  659. package/esm/WorkItemTracking/WorkItemTracking.js +428 -0
  660. package/esm/WorkItemTracking/WorkItemTracking.min.js +1 -0
  661. package/esm/WorkItemTracking/WorkItemTrackingClient.js +1525 -0
  662. package/esm/WorkItemTracking/WorkItemTrackingClient.min.js +1 -0
  663. package/esm/WorkItemTracking/WorkItemTrackingServices.js +15 -0
  664. package/esm/WorkItemTracking/WorkItemTrackingServices.min.js +1 -0
  665. package/esm/WorkItemTracking/index.js +3 -0
  666. package/esm/WorkItemTracking/index.min.js +1 -0
  667. package/esm/WorkItemTrackingProcess/WorkItemTrackingProcess.js +296 -0
  668. package/esm/WorkItemTrackingProcess/WorkItemTrackingProcess.min.js +1 -0
  669. package/esm/WorkItemTrackingProcess/WorkItemTrackingProcessClient.js +1097 -0
  670. package/esm/WorkItemTrackingProcess/WorkItemTrackingProcessClient.min.js +1 -0
  671. package/esm/WorkItemTrackingProcess/index.js +2 -0
  672. package/esm/WorkItemTrackingProcess/index.min.js +1 -0
  673. package/esm/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitions.js +93 -0
  674. package/esm/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitions.min.js +1 -0
  675. package/esm/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitionsClient.js +886 -0
  676. package/esm/WorkItemTrackingProcessDefinitions/WorkItemTrackingProcessDefinitionsClient.min.js +1 -0
  677. package/esm/WorkItemTrackingProcessDefinitions/index.js +2 -0
  678. package/esm/WorkItemTrackingProcessDefinitions/index.min.js +1 -0
  679. package/esm/index.js +1 -0
  680. package/esm/index.min.js +1 -0
  681. package/index.d.ts +1 -1
  682. package/index.js +17 -8
  683. package/index.min.js +1 -1
  684. package/package.json +232 -37
  685. package/Boards/Boards.d.ts +0 -631
  686. package/Boards/Boards.js +0 -26
  687. package/Boards/Boards.min.js +0 -1
  688. package/Boards/BoardsClient.d.ts +0 -187
  689. package/Boards/BoardsClient.js +0 -589
  690. package/Boards/BoardsClient.min.js +0 -1
  691. package/Boards/index.d.ts +0 -2
  692. package/Boards/index.js +0 -9
  693. package/Boards/index.min.js +0 -1
  694. package/_manifest/spdx_2.2/ESRPClientLogs0331143549591.json +0 -1
  695. package/_manifest/spdx_3.0/ESRPClientLogs0331143549461.json +0 -1
  696. package/_manifest/spdx_3.0/bsi.cose +0 -0
  697. package/_manifest/spdx_3.0/bsi.json +0 -1
  698. package/_manifest/spdx_3.0/manifest.cat +0 -0
  699. package/_manifest/spdx_3.0/manifest.spdx.cose +0 -0
@@ -1,624 +1,624 @@
1
- import { IVssRestClientOptions } from "../Common/Context";
2
- import { RestClientBase } from "../Common/RestClientBase";
3
- import * as WebApi from "../WebApi/WebApi";
4
- import * as WorkItemTracking from "../WorkItemTracking/WorkItemTracking";
5
- export declare class WorkItemTrackingRestClient extends RestClientBase {
6
- constructor(options: IVssRestClientOptions);
7
- static readonly RESOURCE_AREA_ID: string;
8
- /**
9
- * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done, Follows and activity work items details.
10
- *
11
- * @param queryOption -
12
- */
13
- getAccountMyWorkData(queryOption?: WorkItemTracking.QueryOption): Promise<WorkItemTracking.AccountMyWorkResult>;
14
- /**
15
- * Gets recent work item activities
16
- *
17
- */
18
- getRecentActivityData(): Promise<WorkItemTracking.AccountRecentActivityWorkItemModel2[]>;
19
- /**
20
- * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE.
21
- *
22
- */
23
- getRecentMentions(): Promise<WorkItemTracking.AccountRecentMentionWorkItemModel[]>;
24
- /**
25
- * Get the list of work item tracking outbound artifact link types.
26
- *
27
- */
28
- getWorkArtifactLinkTypes(): Promise<WorkItemTracking.WorkArtifactLink[]>;
29
- /**
30
- * Queries work items linked to a given list of artifact URI.
31
- *
32
- * @param artifactUriQuery - Defines a list of artifact URI for querying work items.
33
- * @param project - Project ID or project name
34
- */
35
- queryWorkItemsForArtifactUris(artifactUriQuery: WorkItemTracking.ArtifactUriQuery, project?: string): Promise<WorkItemTracking.ArtifactUriQueryResult>;
36
- /**
37
- * Uploads an attachment.
38
- *
39
- * @param content - Content to upload
40
- * @param project - Project ID or project name
41
- * @param fileName - The name of the file
42
- * @param uploadType - Attachment upload type: Simple or Chunked
43
- * @param areaPath - Target project Area Path
44
- */
45
- createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<WorkItemTracking.AttachmentReference>;
46
- /**
47
- * Downloads an attachment.
48
- *
49
- * @param id - Attachment ID
50
- * @param project - Project ID or project name
51
- * @param fileName - Name of the file
52
- * @param download - If set to \<c\>true\</c\> always download attachment
53
- */
54
- getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>;
55
- /**
56
- * Downloads an attachment.
57
- *
58
- * @param id - Attachment ID
59
- * @param project - Project ID or project name
60
- * @param fileName - Name of the file
61
- * @param download - If set to \<c\>true\</c\> always download attachment
62
- */
63
- getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>;
64
- /**
65
- * Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.
66
- *
67
- * @param project - Project ID or project name
68
- * @param ids - Comma separated integer classification nodes ids. It's not required, if you want root nodes.
69
- * @param depth - Depth of children to fetch.
70
- * @param errorPolicy - Flag to handle errors in getting some nodes. Possible options are Fail and Omit.
71
- */
72
- getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: WorkItemTracking.ClassificationNodesErrorPolicy): Promise<WorkItemTracking.WorkItemClassificationNode[]>;
73
- /**
74
- * Gets root classification nodes under the project.
75
- *
76
- * @param project - Project ID or project name
77
- * @param depth - Depth of children to fetch.
78
- */
79
- getRootNodes(project: string, depth?: number): Promise<WorkItemTracking.WorkItemClassificationNode[]>;
80
- /**
81
- * Create new or update an existing classification node.
82
- *
83
- * @param postedNode - Node to create or update.
84
- * @param project - Project ID or project name
85
- * @param structureGroup - Structure group of the classification node, area or iteration.
86
- * @param path - Path of the classification node.
87
- */
88
- createOrUpdateClassificationNode(postedNode: WorkItemTracking.WorkItemClassificationNode, project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string): Promise<WorkItemTracking.WorkItemClassificationNode>;
89
- /**
90
- * Delete an existing classification node.
91
- *
92
- * @param project - Project ID or project name
93
- * @param structureGroup - Structure group of the classification node, area or iteration.
94
- * @param path - Path of the classification node.
95
- * @param reclassifyId - Id of the target classification node for reclassification.
96
- */
97
- deleteClassificationNode(project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>;
98
- /**
99
- * Gets the classification node for a given node path.
100
- *
101
- * @param project - Project ID or project name
102
- * @param structureGroup - Structure group of the classification node, area or iteration.
103
- * @param path - Path of the classification node.
104
- * @param depth - Depth of children to fetch.
105
- */
106
- getClassificationNode(project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemTracking.WorkItemClassificationNode>;
107
- /**
108
- * Update an existing classification node.
109
- *
110
- * @param postedNode - Node to create or update.
111
- * @param project - Project ID or project name
112
- * @param structureGroup - Structure group of the classification node, area or iteration.
113
- * @param path - Path of the classification node.
114
- */
115
- updateClassificationNode(postedNode: WorkItemTracking.WorkItemClassificationNode, project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string): Promise<WorkItemTracking.WorkItemClassificationNode>;
116
- /**
117
- * Gets a comment for a work item at the specified revision.
118
- *
119
- * @param id - Work item id
120
- * @param revision - Revision for which the comment need to be fetched
121
- * @param project - Project ID or project name
122
- */
123
- getComment(id: number, revision: number, project?: string): Promise<WorkItemTracking.WorkItemComment>;
124
- /**
125
- * Gets the specified number of comments for a work item from the specified revision.
126
- *
127
- * @param id - Work item id
128
- * @param project - Project ID or project name
129
- * @param fromRevision - Revision from which comments are to be fetched (default is 1)
130
- * @param top - The number of comments to return (default is 200)
131
- * @param order - Ascending or descending by revision id (default is ascending)
132
- */
133
- getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: WorkItemTracking.CommentSortOrder): Promise<WorkItemTracking.WorkItemComments>;
134
- /**
135
- * Create a new field.
136
- *
137
- * @param workItemField - New field definition
138
- * @param project - Project ID or project name
139
- */
140
- createField(workItemField: WorkItemTracking.WorkItemField, project?: string): Promise<WorkItemTracking.WorkItemField>;
141
- /**
142
- * Deletes the field. To undelete a filed, see "Update Field" API.
143
- *
144
- * @param fieldNameOrRefName - Field simple name or reference name
145
- * @param project - Project ID or project name
146
- */
147
- deleteField(fieldNameOrRefName: string, project?: string): Promise<void>;
148
- /**
149
- * Gets information on a specific field.
150
- *
151
- * @param fieldNameOrRefName - Field simple name or reference name
152
- * @param project - Project ID or project name
153
- */
154
- getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemTracking.WorkItemField>;
155
- /**
156
- * Returns information for all fields. The project ID/name parameter is optional.
157
- *
158
- * @param project - Project ID or project name
159
- * @param expand - Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.
160
- */
161
- getFields(project?: string, expand?: WorkItemTracking.GetFieldsExpand): Promise<WorkItemTracking.WorkItemField[]>;
162
- /**
163
- * Update a field.
164
- *
165
- * @param payload - Payload contains desired value of the field's properties
166
- * @param fieldNameOrRefName - Name/reference name of the field to be updated
167
- * @param project - Project ID or project name
168
- */
169
- updateField(payload: WorkItemTracking.UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemTracking.WorkItemField>;
170
- /**
171
- * Creates a query, or moves a query.
172
- *
173
- * @param postedQuery - The query to create.
174
- * @param project - Project ID or project name
175
- * @param query - The parent id or path under which the query is to be created.
176
- * @param validateWiqlOnly - If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.
177
- */
178
- createQuery(postedQuery: WorkItemTracking.QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
179
- /**
180
- * Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.
181
- *
182
- * @param project - Project ID or project name
183
- * @param query - ID or path of the query or folder to delete.
184
- */
185
- deleteQuery(project: string, query: string): Promise<void>;
186
- /**
187
- * Gets the root queries and their children
188
- *
189
- * @param project - Project ID or project name
190
- * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
191
- * @param depth - In the folder of queries, return child queries and folders to this depth.
192
- * @param includeDeleted - Include deleted queries and folders
193
- */
194
- getQueries(project: string, expand?: WorkItemTracking.QueryExpand, depth?: number, includeDeleted?: boolean): Promise<WorkItemTracking.QueryHierarchyItem[]>;
195
- /**
196
- * Retrieves an individual query and its children
197
- *
198
- * @param project - Project ID or project name
199
- * @param query - ID or path of the query.
200
- * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
201
- * @param depth - In the folder of queries, return child queries and folders to this depth.
202
- * @param includeDeleted - Include deleted queries and folders
203
- * @param useIsoDateFormat - DateTime query clauses will be formatted using a ISO 8601 compliant format
204
- */
205
- getQuery(project: string, query: string, expand?: WorkItemTracking.QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
206
- /**
207
- * Searches all queries the user has access to in the current project
208
- *
209
- * @param project - Project ID or project name
210
- * @param filter - The text to filter the queries with.
211
- * @param top - The number of queries to return (Default is 50 and maximum is 200).
212
- * @param expand -
213
- * @param includeDeleted - Include deleted queries and folders
214
- */
215
- searchQueries(project: string, filter: string, top?: number, expand?: WorkItemTracking.QueryExpand, includeDeleted?: boolean): Promise<WorkItemTracking.QueryHierarchyItemsResult>;
216
- /**
217
- * Update a query or a folder. This allows you to update, rename and move queries and folders.
218
- *
219
- * @param queryUpdate - The query to update.
220
- * @param project - Project ID or project name
221
- * @param query - The ID or path for the query to update.
222
- * @param undeleteDescendants - Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.
223
- */
224
- updateQuery(queryUpdate: WorkItemTracking.QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
225
- /**
226
- * Gets a list of queries by ids (Maximum 1000)
227
- *
228
- * @param queryGetRequest -
229
- * @param project - Project ID or project name
230
- */
231
- getQueriesBatch(queryGetRequest: WorkItemTracking.QueryBatchGetRequest, project: string): Promise<WorkItemTracking.QueryHierarchyItem[]>;
232
- /**
233
- * Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.
234
- *
235
- * @param id - ID of the work item to be destroyed permanently
236
- * @param project - Project ID or project name
237
- */
238
- destroyWorkItem(id: number, project?: string): Promise<void>;
239
- /**
240
- * Gets a deleted work item from Recycle Bin.
241
- *
242
- * @param id - ID of the work item to be returned
243
- * @param project - Project ID or project name
244
- */
245
- getDeletedWorkItem(id: number, project?: string): Promise<WorkItemTracking.WorkItemDelete>;
246
- /**
247
- * Gets the work items from the recycle bin, whose IDs have been specified in the parameters
248
- *
249
- * @param ids - Comma separated list of IDs of the deleted work items to be returned
250
- * @param project - Project ID or project name
251
- */
252
- getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemTracking.WorkItemDeleteReference[]>;
253
- /**
254
- * Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
255
- *
256
- * @param project - Project ID or project name
257
- */
258
- getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemTracking.WorkItemDeleteShallowReference[]>;
259
- /**
260
- * Restores the deleted work item from Recycle Bin.
261
- *
262
- * @param payload - Paylod with instructions to update the IsDeleted flag to false
263
- * @param id - ID of the work item to be restored
264
- * @param project - Project ID or project name
265
- */
266
- restoreWorkItem(payload: WorkItemTracking.WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemTracking.WorkItemDelete>;
267
- /**
268
- * Returns a fully hydrated work item for the requested revision
269
- *
270
- * @param id -
271
- * @param revisionNumber -
272
- * @param project - Project ID or project name
273
- * @param expand -
274
- */
275
- getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
276
- /**
277
- * Returns the list of fully hydrated work item revisions, paged.
278
- *
279
- * @param id -
280
- * @param project - Project ID or project name
281
- * @param top -
282
- * @param skip -
283
- * @param expand -
284
- */
285
- getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem[]>;
286
- /**
287
- * RESTful method to send mail for selected/queried work items.
288
- *
289
- * @param body -
290
- * @param project - Project ID or project name
291
- */
292
- sendMail(body: WorkItemTracking.SendMailBody, project?: string): Promise<void>;
293
- /**
294
- * Creates a template
295
- *
296
- * @param template - Template contents
297
- * @param project - Project ID or project name
298
- * @param team - Team ID or team name
299
- */
300
- createTemplate(template: WorkItemTracking.WorkItemTemplate, project: string, team: string): Promise<WorkItemTracking.WorkItemTemplate>;
301
- /**
302
- * Gets template
303
- *
304
- * @param project - Project ID or project name
305
- * @param team - Team ID or team name
306
- * @param workitemtypename - Optional, When specified returns templates for given Work item type.
307
- */
308
- getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTracking.WorkItemTemplateReference[]>;
309
- /**
310
- * Deletes the template with given id
311
- *
312
- * @param project - Project ID or project name
313
- * @param team - Team ID or team name
314
- * @param templateId - Template id
315
- */
316
- deleteTemplate(project: string, team: string, templateId: string): Promise<void>;
317
- /**
318
- * Gets the template with specified id
319
- *
320
- * @param project - Project ID or project name
321
- * @param team - Team ID or team name
322
- * @param templateId - Template Id
323
- */
324
- getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTracking.WorkItemTemplate>;
325
- /**
326
- * Replace template contents
327
- *
328
- * @param templateContent - Template contents to replace with
329
- * @param project - Project ID or project name
330
- * @param team - Team ID or team name
331
- * @param templateId - Template id
332
- */
333
- replaceTemplate(templateContent: WorkItemTracking.WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTracking.WorkItemTemplate>;
334
- /**
335
- * Returns a single update for a work item
336
- *
337
- * @param id -
338
- * @param updateNumber -
339
- * @param project - Project ID or project name
340
- */
341
- getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemTracking.WorkItemUpdate>;
342
- /**
343
- * Returns the deltas between work item revisions
344
- *
345
- * @param id -
346
- * @param project - Project ID or project name
347
- * @param top -
348
- * @param skip -
349
- */
350
- getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemTracking.WorkItemUpdate[]>;
351
- /**
352
- * Gets the results of the query given its WIQL.
353
- *
354
- * @param wiql - The query containing the WIQL.
355
- * @param project - Project ID or project name
356
- * @param team - Team ID or team name
357
- * @param timePrecision - Whether or not to use time precision.
358
- * @param top - The max number of results to return.
359
- */
360
- queryByWiql(wiql: WorkItemTracking.Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemTracking.WorkItemQueryResult>;
361
- /**
362
- * Gets the results of the query given the query ID.
363
- *
364
- * @param id - The query ID.
365
- * @param project - Project ID or project name
366
- * @param team - Team ID or team name
367
- * @param timePrecision - Whether or not to use time precision.
368
- * @param top - The max number of results to return.
369
- */
370
- getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>;
371
- /**
372
- * Gets the results of the query given the query ID.
373
- *
374
- * @param id - The query ID.
375
- * @param project - Project ID or project name
376
- * @param team - Team ID or team name
377
- * @param timePrecision - Whether or not to use time precision.
378
- * @param top - The max number of results to return.
379
- */
380
- queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemTracking.WorkItemQueryResult>;
381
- /**
382
- * Get a work item icon given the friendly name and icon color.
383
- *
384
- * @param icon - The name of the icon
385
- * @param color - The 6-digit hex color for the icon
386
- * @param v - The version of the icon (used only for cache invalidation)
387
- */
388
- getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemTracking.WorkItemIcon>;
389
- /**
390
- * Get a list of all work item icons.
391
- *
392
- */
393
- getWorkItemIcons(): Promise<WorkItemTracking.WorkItemIcon[]>;
394
- /**
395
- * Get a work item icon given the friendly name and icon color.
396
- *
397
- * @param icon - The name of the icon
398
- * @param color - The 6-digit hex color for the icon
399
- * @param v - The version of the icon (used only for cache invalidation)
400
- */
401
- getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>;
402
- /**
403
- * Get a work item icon given the friendly name and icon color.
404
- *
405
- * @param icon - The name of the icon
406
- * @param color - The 6-digit hex color for the icon
407
- * @param v - The version of the icon (used only for cache invalidation)
408
- */
409
- getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>;
410
- /**
411
- * Get a batch of work item links
412
- *
413
- * @param project - Project ID or project name
414
- * @param linkTypes - A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
415
- * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
416
- * @param continuationToken - Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
417
- * @param startDateTime - Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
418
- */
419
- getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<WorkItemTracking.ReportingWorkItemLinksBatch>;
420
- /**
421
- * Gets the work item relation type definition.
422
- *
423
- * @param relation - The relation name
424
- */
425
- getRelationType(relation: string): Promise<WorkItemTracking.WorkItemRelationType>;
426
- /**
427
- * Gets the work item relation types.
428
- *
429
- */
430
- getRelationTypes(): Promise<WorkItemTracking.WorkItemRelationType[]>;
431
- /**
432
- * Get a batch of work item revisions with the option of including deleted items
433
- *
434
- * @param project - Project ID or project name
435
- * @param fields - A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
436
- * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
437
- * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
438
- * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
439
- * @param includeIdentityRef - Return an identity reference instead of a string value for identity fields.
440
- * @param includeDeleted - Specify if the deleted item should be returned.
441
- * @param includeTagRef - Specify if the tag objects should be returned for System.Tags field.
442
- * @param includeLatestOnly - Return only the latest revisions of work items, skipping all historical revisions
443
- * @param expand - Return all the fields in work item revisions, including long text fields which are not returned by default
444
- * @param includeDiscussionChangesOnly - Return only the those revisions of work items, where only history field was changed
445
- * @param maxPageSize - The maximum number of results to return in this batch
446
- */
447
- readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: WorkItemTracking.ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<WorkItemTracking.ReportingWorkItemRevisionsBatch>;
448
- /**
449
- * Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.
450
- *
451
- * @param filter - An object that contains request settings: field filter, type filter, identity format
452
- * @param project - Project ID or project name
453
- * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
454
- * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
455
- * @param expand -
456
- */
457
- readReportingRevisionsPost(filter: WorkItemTracking.ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: WorkItemTracking.ReportingRevisionsExpand): Promise<WorkItemTracking.ReportingWorkItemRevisionsBatch>;
458
- /**
459
- * Creates a single work item.
460
- *
461
- * @param document - The JSON Patch document representing the work item
462
- * @param project - Project ID or project name
463
- * @param type - The work item type of the work item to create
464
- * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
465
- * @param bypassRules - Do not enforce the work item type rules on this update
466
- * @param suppressNotifications - Do not fire any notifications for this change
467
- * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
468
- */
469
- createWorkItem(document: WebApi.JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
470
- /**
471
- * Returns a single work item from a template.
472
- *
473
- * @param project - Project ID or project name
474
- * @param type - The work item type name
475
- * @param fields - Comma-separated list of requested fields
476
- * @param asOf - AsOf UTC date time string
477
- * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
478
- */
479
- getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
480
- /**
481
- * Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.
482
- *
483
- * @param id - ID of the work item to be deleted
484
- * @param project - Project ID or project name
485
- * @param destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
486
- */
487
- deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemTracking.WorkItemDelete>;
488
- /**
489
- * Returns a single work item.
490
- *
491
- * @param id - The work item id
492
- * @param project - Project ID or project name
493
- * @param fields - Comma-separated list of requested fields
494
- * @param asOf - AsOf UTC date time string
495
- * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
496
- */
497
- getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
498
- /**
499
- * Returns a list of work items (Maximum 200)
500
- *
501
- * @param ids - The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
502
- * @param project - Project ID or project name
503
- * @param fields - Comma-separated list of requested fields
504
- * @param asOf - AsOf UTC date time string
505
- * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
506
- * @param errorPolicy - The flag to control error policy in a bulk get work items request. Possible options are \{Fail, Omit\}.
507
- */
508
- getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemTracking.WorkItemExpand, errorPolicy?: WorkItemTracking.WorkItemErrorPolicy): Promise<WorkItemTracking.WorkItem[]>;
509
- /**
510
- * Updates a single work item.
511
- *
512
- * @param document - The JSON Patch document representing the update
513
- * @param id - The id of the work item to update
514
- * @param project - Project ID or project name
515
- * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
516
- * @param bypassRules - Do not enforce the work item type rules on this update
517
- * @param suppressNotifications - Do not fire any notifications for this change
518
- * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
519
- */
520
- updateWorkItem(document: WebApi.JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
521
- /**
522
- * Gets work items for a list of work item ids (Maximum 200)
523
- *
524
- * @param workItemGetRequest -
525
- * @param project - Project ID or project name
526
- */
527
- getWorkItemsBatch(workItemGetRequest: WorkItemTracking.WorkItemBatchGetRequest, project?: string): Promise<WorkItemTracking.WorkItem[]>;
528
- /**
529
- * INTERNAL ONLY: It will be used for My account work experience. Get the work item type state color for multiple projects
530
- *
531
- * @param projectNames -
532
- */
533
- getWorkItemStateColors(projectNames: string[]): Promise<WorkItemTracking.ProjectWorkItemStateColors[]>;
534
- /**
535
- * Returns the next state on the given work item IDs.
536
- *
537
- * @param ids - list of work item ids
538
- * @param action - possible actions. Currently only supports checkin
539
- */
540
- getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemTracking.WorkItemNextStateOnTransition[]>;
541
- /**
542
- * Get all work item type categories.
543
- *
544
- * @param project - Project ID or project name
545
- */
546
- getWorkItemTypeCategories(project: string): Promise<WorkItemTracking.WorkItemTypeCategory[]>;
547
- /**
548
- * Get specific work item type category by name.
549
- *
550
- * @param project - Project ID or project name
551
- * @param category - The category name
552
- */
553
- getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTracking.WorkItemTypeCategory>;
554
- /**
555
- * INTERNAL ONLY: It will be used for My account work experience. Get the wit type color for multiple projects
556
- *
557
- * @param projectNames -
558
- */
559
- getWorkItemTypeColors(projectNames: string[]): Promise<{
560
- key: string;
561
- value: WorkItemTracking.WorkItemTypeColor[];
562
- }[]>;
563
- /**
564
- * INTERNAL ONLY: It is used for color and icon providers. Get the wit type color for multiple projects
565
- *
566
- * @param projectNames -
567
- */
568
- getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{
569
- key: string;
570
- value: WorkItemTracking.WorkItemTypeColorAndIcon[];
571
- }[]>;
572
- /**
573
- * Returns a work item type definition.
574
- *
575
- * @param project - Project ID or project name
576
- * @param type - Work item type name
577
- */
578
- getWorkItemType(project: string, type: string): Promise<WorkItemTracking.WorkItemType>;
579
- /**
580
- * Returns the list of work item types
581
- *
582
- * @param project - Project ID or project name
583
- */
584
- getWorkItemTypes(project: string): Promise<WorkItemTracking.WorkItemType[]>;
585
- /**
586
- * Get a list of fields for a work item type with detailed references.
587
- *
588
- * @param project - Project ID or project name
589
- * @param type - Work item type.
590
- * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
591
- */
592
- getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTracking.WorkItemTypeFieldsExpandLevel): Promise<WorkItemTracking.WorkItemTypeFieldWithReferences[]>;
593
- /**
594
- * Get a field for a work item type with detailed references.
595
- *
596
- * @param project - Project ID or project name
597
- * @param type - Work item type.
598
- * @param field -
599
- * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
600
- */
601
- getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTracking.WorkItemTypeFieldsExpandLevel): Promise<WorkItemTracking.WorkItemTypeFieldWithReferences>;
602
- /**
603
- * Returns the state names and colors for a work item type.
604
- *
605
- * @param project - Project ID or project name
606
- * @param type - The state name
607
- */
608
- getWorkItemTypeStates(project: string, type: string): Promise<WorkItemTracking.WorkItemStateColor[]>;
609
- /**
610
- * Export work item type
611
- *
612
- * @param project - Project ID or project name
613
- * @param type -
614
- * @param exportGlobalLists -
615
- */
616
- exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTracking.WorkItemTypeTemplate>;
617
- /**
618
- * Add/updates a work item type
619
- *
620
- * @param updateModel -
621
- * @param project - Project ID or project name
622
- */
623
- updateWorkItemTypeDefinition(updateModel: WorkItemTracking.WorkItemTypeTemplateUpdateModel, project?: string): Promise<WorkItemTracking.ProvisioningResult>;
624
- }
1
+ import { IVssRestClientOptions } from "../Common/Context";
2
+ import { RestClientBase } from "../Common/RestClientBase";
3
+ import * as WebApi from "../WebApi/WebApi";
4
+ import * as WorkItemTracking from "../WorkItemTracking/WorkItemTracking";
5
+ export declare class WorkItemTrackingRestClient extends RestClientBase {
6
+ constructor(options: IVssRestClientOptions);
7
+ static readonly RESOURCE_AREA_ID = "5264459e-e5e0-4bd8-b118-0985e68a4ec5";
8
+ /**
9
+ * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE. This returns Doing, Done, Follows and activity work items details.
10
+ *
11
+ * @param queryOption -
12
+ */
13
+ getAccountMyWorkData(queryOption?: WorkItemTracking.QueryOption): Promise<WorkItemTracking.AccountMyWorkResult>;
14
+ /**
15
+ * Gets recent work item activities
16
+ *
17
+ */
18
+ getRecentActivityData(): Promise<WorkItemTracking.AccountRecentActivityWorkItemModel2[]>;
19
+ /**
20
+ * INTERNAL ONLY: USED BY ACCOUNT MY WORK PAGE.
21
+ *
22
+ */
23
+ getRecentMentions(): Promise<WorkItemTracking.AccountRecentMentionWorkItemModel[]>;
24
+ /**
25
+ * Get the list of work item tracking outbound artifact link types.
26
+ *
27
+ */
28
+ getWorkArtifactLinkTypes(): Promise<WorkItemTracking.WorkArtifactLink[]>;
29
+ /**
30
+ * Queries work items linked to a given list of artifact URI.
31
+ *
32
+ * @param artifactUriQuery - Defines a list of artifact URI for querying work items.
33
+ * @param project - Project ID or project name
34
+ */
35
+ queryWorkItemsForArtifactUris(artifactUriQuery: WorkItemTracking.ArtifactUriQuery, project?: string): Promise<WorkItemTracking.ArtifactUriQueryResult>;
36
+ /**
37
+ * Uploads an attachment.
38
+ *
39
+ * @param content - Content to upload
40
+ * @param project - Project ID or project name
41
+ * @param fileName - The name of the file
42
+ * @param uploadType - Attachment upload type: Simple or Chunked
43
+ * @param areaPath - Target project Area Path
44
+ */
45
+ createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<WorkItemTracking.AttachmentReference>;
46
+ /**
47
+ * Downloads an attachment.
48
+ *
49
+ * @param id - Attachment ID
50
+ * @param project - Project ID or project name
51
+ * @param fileName - Name of the file
52
+ * @param download - If set to \<c\>true\</c\> always download attachment
53
+ */
54
+ getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>;
55
+ /**
56
+ * Downloads an attachment.
57
+ *
58
+ * @param id - Attachment ID
59
+ * @param project - Project ID or project name
60
+ * @param fileName - Name of the file
61
+ * @param download - If set to \<c\>true\</c\> always download attachment
62
+ */
63
+ getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>;
64
+ /**
65
+ * Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.
66
+ *
67
+ * @param project - Project ID or project name
68
+ * @param ids - Comma separated integer classification nodes ids. It's not required, if you want root nodes.
69
+ * @param depth - Depth of children to fetch.
70
+ * @param errorPolicy - Flag to handle errors in getting some nodes. Possible options are Fail and Omit.
71
+ */
72
+ getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: WorkItemTracking.ClassificationNodesErrorPolicy): Promise<WorkItemTracking.WorkItemClassificationNode[]>;
73
+ /**
74
+ * Gets root classification nodes under the project.
75
+ *
76
+ * @param project - Project ID or project name
77
+ * @param depth - Depth of children to fetch.
78
+ */
79
+ getRootNodes(project: string, depth?: number): Promise<WorkItemTracking.WorkItemClassificationNode[]>;
80
+ /**
81
+ * Create new or update an existing classification node.
82
+ *
83
+ * @param postedNode - Node to create or update.
84
+ * @param project - Project ID or project name
85
+ * @param structureGroup - Structure group of the classification node, area or iteration.
86
+ * @param path - Path of the classification node.
87
+ */
88
+ createOrUpdateClassificationNode(postedNode: WorkItemTracking.WorkItemClassificationNode, project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string): Promise<WorkItemTracking.WorkItemClassificationNode>;
89
+ /**
90
+ * Delete an existing classification node.
91
+ *
92
+ * @param project - Project ID or project name
93
+ * @param structureGroup - Structure group of the classification node, area or iteration.
94
+ * @param path - Path of the classification node.
95
+ * @param reclassifyId - Id of the target classification node for reclassification.
96
+ */
97
+ deleteClassificationNode(project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>;
98
+ /**
99
+ * Gets the classification node for a given node path.
100
+ *
101
+ * @param project - Project ID or project name
102
+ * @param structureGroup - Structure group of the classification node, area or iteration.
103
+ * @param path - Path of the classification node.
104
+ * @param depth - Depth of children to fetch.
105
+ */
106
+ getClassificationNode(project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemTracking.WorkItemClassificationNode>;
107
+ /**
108
+ * Update an existing classification node.
109
+ *
110
+ * @param postedNode - Node to create or update.
111
+ * @param project - Project ID or project name
112
+ * @param structureGroup - Structure group of the classification node, area or iteration.
113
+ * @param path - Path of the classification node.
114
+ */
115
+ updateClassificationNode(postedNode: WorkItemTracking.WorkItemClassificationNode, project: string, structureGroup: WorkItemTracking.TreeStructureGroup, path?: string): Promise<WorkItemTracking.WorkItemClassificationNode>;
116
+ /**
117
+ * Gets a comment for a work item at the specified revision.
118
+ *
119
+ * @param id - Work item id
120
+ * @param revision - Revision for which the comment need to be fetched
121
+ * @param project - Project ID or project name
122
+ */
123
+ getComment(id: number, revision: number, project?: string): Promise<WorkItemTracking.WorkItemComment>;
124
+ /**
125
+ * Gets the specified number of comments for a work item from the specified revision.
126
+ *
127
+ * @param id - Work item id
128
+ * @param project - Project ID or project name
129
+ * @param fromRevision - Revision from which comments are to be fetched (default is 1)
130
+ * @param top - The number of comments to return (default is 200)
131
+ * @param order - Ascending or descending by revision id (default is ascending)
132
+ */
133
+ getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: WorkItemTracking.CommentSortOrder): Promise<WorkItemTracking.WorkItemComments>;
134
+ /**
135
+ * Create a new field.
136
+ *
137
+ * @param workItemField - New field definition
138
+ * @param project - Project ID or project name
139
+ */
140
+ createField(workItemField: WorkItemTracking.WorkItemField, project?: string): Promise<WorkItemTracking.WorkItemField>;
141
+ /**
142
+ * Deletes the field. To undelete a filed, see "Update Field" API.
143
+ *
144
+ * @param fieldNameOrRefName - Field simple name or reference name
145
+ * @param project - Project ID or project name
146
+ */
147
+ deleteField(fieldNameOrRefName: string, project?: string): Promise<void>;
148
+ /**
149
+ * Gets information on a specific field.
150
+ *
151
+ * @param fieldNameOrRefName - Field simple name or reference name
152
+ * @param project - Project ID or project name
153
+ */
154
+ getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemTracking.WorkItemField>;
155
+ /**
156
+ * Returns information for all fields. The project ID/name parameter is optional.
157
+ *
158
+ * @param project - Project ID or project name
159
+ * @param expand - Use ExtensionFields to include extension fields, otherwise exclude them. Unless the feature flag for this parameter is enabled, extension fields are always included.
160
+ */
161
+ getFields(project?: string, expand?: WorkItemTracking.GetFieldsExpand): Promise<WorkItemTracking.WorkItemField[]>;
162
+ /**
163
+ * Update a field.
164
+ *
165
+ * @param payload - Payload contains desired value of the field's properties
166
+ * @param fieldNameOrRefName - Name/reference name of the field to be updated
167
+ * @param project - Project ID or project name
168
+ */
169
+ updateField(payload: WorkItemTracking.UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemTracking.WorkItemField>;
170
+ /**
171
+ * Creates a query, or moves a query.
172
+ *
173
+ * @param postedQuery - The query to create.
174
+ * @param project - Project ID or project name
175
+ * @param query - The parent id or path under which the query is to be created.
176
+ * @param validateWiqlOnly - If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.
177
+ */
178
+ createQuery(postedQuery: WorkItemTracking.QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
179
+ /**
180
+ * Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.
181
+ *
182
+ * @param project - Project ID or project name
183
+ * @param query - ID or path of the query or folder to delete.
184
+ */
185
+ deleteQuery(project: string, query: string): Promise<void>;
186
+ /**
187
+ * Gets the root queries and their children
188
+ *
189
+ * @param project - Project ID or project name
190
+ * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
191
+ * @param depth - In the folder of queries, return child queries and folders to this depth.
192
+ * @param includeDeleted - Include deleted queries and folders
193
+ */
194
+ getQueries(project: string, expand?: WorkItemTracking.QueryExpand, depth?: number, includeDeleted?: boolean): Promise<WorkItemTracking.QueryHierarchyItem[]>;
195
+ /**
196
+ * Retrieves an individual query and its children
197
+ *
198
+ * @param project - Project ID or project name
199
+ * @param query - ID or path of the query.
200
+ * @param expand - Include the query string (wiql), clauses, query result columns, and sort options in the results.
201
+ * @param depth - In the folder of queries, return child queries and folders to this depth.
202
+ * @param includeDeleted - Include deleted queries and folders
203
+ * @param useIsoDateFormat - DateTime query clauses will be formatted using a ISO 8601 compliant format
204
+ */
205
+ getQuery(project: string, query: string, expand?: WorkItemTracking.QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
206
+ /**
207
+ * Searches all queries the user has access to in the current project
208
+ *
209
+ * @param project - Project ID or project name
210
+ * @param filter - The text to filter the queries with.
211
+ * @param top - The number of queries to return (Default is 50 and maximum is 200).
212
+ * @param expand -
213
+ * @param includeDeleted - Include deleted queries and folders
214
+ */
215
+ searchQueries(project: string, filter: string, top?: number, expand?: WorkItemTracking.QueryExpand, includeDeleted?: boolean): Promise<WorkItemTracking.QueryHierarchyItemsResult>;
216
+ /**
217
+ * Update a query or a folder. This allows you to update, rename and move queries and folders.
218
+ *
219
+ * @param queryUpdate - The query to update.
220
+ * @param project - Project ID or project name
221
+ * @param query - The ID or path for the query to update.
222
+ * @param undeleteDescendants - Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.
223
+ */
224
+ updateQuery(queryUpdate: WorkItemTracking.QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<WorkItemTracking.QueryHierarchyItem>;
225
+ /**
226
+ * Gets a list of queries by ids (Maximum 1000)
227
+ *
228
+ * @param queryGetRequest -
229
+ * @param project - Project ID or project name
230
+ */
231
+ getQueriesBatch(queryGetRequest: WorkItemTracking.QueryBatchGetRequest, project: string): Promise<WorkItemTracking.QueryHierarchyItem[]>;
232
+ /**
233
+ * Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.
234
+ *
235
+ * @param id - ID of the work item to be destroyed permanently
236
+ * @param project - Project ID or project name
237
+ */
238
+ destroyWorkItem(id: number, project?: string): Promise<void>;
239
+ /**
240
+ * Gets a deleted work item from Recycle Bin.
241
+ *
242
+ * @param id - ID of the work item to be returned
243
+ * @param project - Project ID or project name
244
+ */
245
+ getDeletedWorkItem(id: number, project?: string): Promise<WorkItemTracking.WorkItemDelete>;
246
+ /**
247
+ * Gets the work items from the recycle bin, whose IDs have been specified in the parameters
248
+ *
249
+ * @param ids - Comma separated list of IDs of the deleted work items to be returned
250
+ * @param project - Project ID or project name
251
+ */
252
+ getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemTracking.WorkItemDeleteReference[]>;
253
+ /**
254
+ * Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
255
+ *
256
+ * @param project - Project ID or project name
257
+ */
258
+ getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemTracking.WorkItemDeleteShallowReference[]>;
259
+ /**
260
+ * Restores the deleted work item from Recycle Bin.
261
+ *
262
+ * @param payload - Paylod with instructions to update the IsDeleted flag to false
263
+ * @param id - ID of the work item to be restored
264
+ * @param project - Project ID or project name
265
+ */
266
+ restoreWorkItem(payload: WorkItemTracking.WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemTracking.WorkItemDelete>;
267
+ /**
268
+ * Returns a fully hydrated work item for the requested revision
269
+ *
270
+ * @param id -
271
+ * @param revisionNumber -
272
+ * @param project - Project ID or project name
273
+ * @param expand -
274
+ */
275
+ getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
276
+ /**
277
+ * Returns the list of fully hydrated work item revisions, paged.
278
+ *
279
+ * @param id -
280
+ * @param project - Project ID or project name
281
+ * @param top -
282
+ * @param skip -
283
+ * @param expand -
284
+ */
285
+ getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem[]>;
286
+ /**
287
+ * RESTful method to send mail for selected/queried work items.
288
+ *
289
+ * @param body -
290
+ * @param project - Project ID or project name
291
+ */
292
+ sendMail(body: WorkItemTracking.SendMailBody, project?: string): Promise<void>;
293
+ /**
294
+ * Creates a template
295
+ *
296
+ * @param template - Template contents
297
+ * @param project - Project ID or project name
298
+ * @param team - Team ID or team name
299
+ */
300
+ createTemplate(template: WorkItemTracking.WorkItemTemplate, project: string, team: string): Promise<WorkItemTracking.WorkItemTemplate>;
301
+ /**
302
+ * Gets template
303
+ *
304
+ * @param project - Project ID or project name
305
+ * @param team - Team ID or team name
306
+ * @param workitemtypename - Optional, When specified returns templates for given Work item type.
307
+ */
308
+ getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTracking.WorkItemTemplateReference[]>;
309
+ /**
310
+ * Deletes the template with given id
311
+ *
312
+ * @param project - Project ID or project name
313
+ * @param team - Team ID or team name
314
+ * @param templateId - Template id
315
+ */
316
+ deleteTemplate(project: string, team: string, templateId: string): Promise<void>;
317
+ /**
318
+ * Gets the template with specified id
319
+ *
320
+ * @param project - Project ID or project name
321
+ * @param team - Team ID or team name
322
+ * @param templateId - Template Id
323
+ */
324
+ getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTracking.WorkItemTemplate>;
325
+ /**
326
+ * Replace template contents
327
+ *
328
+ * @param templateContent - Template contents to replace with
329
+ * @param project - Project ID or project name
330
+ * @param team - Team ID or team name
331
+ * @param templateId - Template id
332
+ */
333
+ replaceTemplate(templateContent: WorkItemTracking.WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTracking.WorkItemTemplate>;
334
+ /**
335
+ * Returns a single update for a work item
336
+ *
337
+ * @param id -
338
+ * @param updateNumber -
339
+ * @param project - Project ID or project name
340
+ */
341
+ getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemTracking.WorkItemUpdate>;
342
+ /**
343
+ * Returns the deltas between work item revisions
344
+ *
345
+ * @param id -
346
+ * @param project - Project ID or project name
347
+ * @param top -
348
+ * @param skip -
349
+ */
350
+ getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemTracking.WorkItemUpdate[]>;
351
+ /**
352
+ * Gets the results of the query given its WIQL.
353
+ *
354
+ * @param wiql - The query containing the WIQL.
355
+ * @param project - Project ID or project name
356
+ * @param team - Team ID or team name
357
+ * @param timePrecision - Whether or not to use time precision.
358
+ * @param top - The max number of results to return.
359
+ */
360
+ queryByWiql(wiql: WorkItemTracking.Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemTracking.WorkItemQueryResult>;
361
+ /**
362
+ * Gets the results of the query given the query ID.
363
+ *
364
+ * @param id - The query ID.
365
+ * @param project - Project ID or project name
366
+ * @param team - Team ID or team name
367
+ * @param timePrecision - Whether or not to use time precision.
368
+ * @param top - The max number of results to return.
369
+ */
370
+ getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>;
371
+ /**
372
+ * Gets the results of the query given the query ID.
373
+ *
374
+ * @param id - The query ID.
375
+ * @param project - Project ID or project name
376
+ * @param team - Team ID or team name
377
+ * @param timePrecision - Whether or not to use time precision.
378
+ * @param top - The max number of results to return.
379
+ */
380
+ queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemTracking.WorkItemQueryResult>;
381
+ /**
382
+ * Get a work item icon given the friendly name and icon color.
383
+ *
384
+ * @param icon - The name of the icon
385
+ * @param color - The 6-digit hex color for the icon
386
+ * @param v - The version of the icon (used only for cache invalidation)
387
+ */
388
+ getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemTracking.WorkItemIcon>;
389
+ /**
390
+ * Get a list of all work item icons.
391
+ *
392
+ */
393
+ getWorkItemIcons(): Promise<WorkItemTracking.WorkItemIcon[]>;
394
+ /**
395
+ * Get a work item icon given the friendly name and icon color.
396
+ *
397
+ * @param icon - The name of the icon
398
+ * @param color - The 6-digit hex color for the icon
399
+ * @param v - The version of the icon (used only for cache invalidation)
400
+ */
401
+ getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>;
402
+ /**
403
+ * Get a work item icon given the friendly name and icon color.
404
+ *
405
+ * @param icon - The name of the icon
406
+ * @param color - The 6-digit hex color for the icon
407
+ * @param v - The version of the icon (used only for cache invalidation)
408
+ */
409
+ getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>;
410
+ /**
411
+ * Get a batch of work item links
412
+ *
413
+ * @param project - Project ID or project name
414
+ * @param linkTypes - A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
415
+ * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.
416
+ * @param continuationToken - Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
417
+ * @param startDateTime - Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
418
+ */
419
+ getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<WorkItemTracking.ReportingWorkItemLinksBatch>;
420
+ /**
421
+ * Gets the work item relation type definition.
422
+ *
423
+ * @param relation - The relation name
424
+ */
425
+ getRelationType(relation: string): Promise<WorkItemTracking.WorkItemRelationType>;
426
+ /**
427
+ * Gets the work item relation types.
428
+ *
429
+ */
430
+ getRelationTypes(): Promise<WorkItemTracking.WorkItemRelationType[]>;
431
+ /**
432
+ * Get a batch of work item revisions with the option of including deleted items
433
+ *
434
+ * @param project - Project ID or project name
435
+ * @param fields - A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
436
+ * @param types - A list of types to filter the results to specific work item types. Omit this parameter to get work item revisions of all work item types.
437
+ * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
438
+ * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
439
+ * @param includeIdentityRef - Return an identity reference instead of a string value for identity fields.
440
+ * @param includeDeleted - Specify if the deleted item should be returned.
441
+ * @param includeTagRef - Specify if the tag objects should be returned for System.Tags field.
442
+ * @param includeLatestOnly - Return only the latest revisions of work items, skipping all historical revisions
443
+ * @param expand - Return all the fields in work item revisions, including long text fields which are not returned by default
444
+ * @param includeDiscussionChangesOnly - Return only the those revisions of work items, where only history field was changed
445
+ * @param maxPageSize - The maximum number of results to return in this batch
446
+ */
447
+ readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: WorkItemTracking.ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<WorkItemTracking.ReportingWorkItemRevisionsBatch>;
448
+ /**
449
+ * Get a batch of work item revisions. This request may be used if your list of fields is large enough that it may run the URL over the length limit.
450
+ *
451
+ * @param filter - An object that contains request settings: field filter, type filter, identity format
452
+ * @param project - Project ID or project name
453
+ * @param continuationToken - Specifies the watermark to start the batch from. Omit this parameter to get the first batch of revisions.
454
+ * @param startDateTime - Date/time to use as a starting point for revisions, all revisions will occur after this date/time. Cannot be used in conjunction with 'watermark' parameter.
455
+ * @param expand -
456
+ */
457
+ readReportingRevisionsPost(filter: WorkItemTracking.ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: WorkItemTracking.ReportingRevisionsExpand): Promise<WorkItemTracking.ReportingWorkItemRevisionsBatch>;
458
+ /**
459
+ * Creates a single work item.
460
+ *
461
+ * @param document - The JSON Patch document representing the work item
462
+ * @param project - Project ID or project name
463
+ * @param type - The work item type of the work item to create
464
+ * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
465
+ * @param bypassRules - Do not enforce the work item type rules on this update
466
+ * @param suppressNotifications - Do not fire any notifications for this change
467
+ * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
468
+ */
469
+ createWorkItem(document: WebApi.JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
470
+ /**
471
+ * Returns a single work item from a template.
472
+ *
473
+ * @param project - Project ID or project name
474
+ * @param type - The work item type name
475
+ * @param fields - Comma-separated list of requested fields
476
+ * @param asOf - AsOf UTC date time string
477
+ * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
478
+ */
479
+ getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
480
+ /**
481
+ * Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.
482
+ *
483
+ * @param id - ID of the work item to be deleted
484
+ * @param project - Project ID or project name
485
+ * @param destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
486
+ */
487
+ deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemTracking.WorkItemDelete>;
488
+ /**
489
+ * Returns a single work item.
490
+ *
491
+ * @param id - The work item id
492
+ * @param project - Project ID or project name
493
+ * @param fields - Comma-separated list of requested fields
494
+ * @param asOf - AsOf UTC date time string
495
+ * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
496
+ */
497
+ getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
498
+ /**
499
+ * Returns a list of work items (Maximum 200)
500
+ *
501
+ * @param ids - The comma-separated list of requested work item ids. (Maximum 200 ids allowed).
502
+ * @param project - Project ID or project name
503
+ * @param fields - Comma-separated list of requested fields
504
+ * @param asOf - AsOf UTC date time string
505
+ * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
506
+ * @param errorPolicy - The flag to control error policy in a bulk get work items request. Possible options are \{Fail, Omit\}.
507
+ */
508
+ getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemTracking.WorkItemExpand, errorPolicy?: WorkItemTracking.WorkItemErrorPolicy): Promise<WorkItemTracking.WorkItem[]>;
509
+ /**
510
+ * Updates a single work item.
511
+ *
512
+ * @param document - The JSON Patch document representing the update
513
+ * @param id - The id of the work item to update
514
+ * @param project - Project ID or project name
515
+ * @param validateOnly - Indicate if you only want to validate the changes without saving the work item
516
+ * @param bypassRules - Do not enforce the work item type rules on this update
517
+ * @param suppressNotifications - Do not fire any notifications for this change
518
+ * @param expand - The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}.
519
+ */
520
+ updateWorkItem(document: WebApi.JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemTracking.WorkItemExpand): Promise<WorkItemTracking.WorkItem>;
521
+ /**
522
+ * Gets work items for a list of work item ids (Maximum 200)
523
+ *
524
+ * @param workItemGetRequest -
525
+ * @param project - Project ID or project name
526
+ */
527
+ getWorkItemsBatch(workItemGetRequest: WorkItemTracking.WorkItemBatchGetRequest, project?: string): Promise<WorkItemTracking.WorkItem[]>;
528
+ /**
529
+ * INTERNAL ONLY: It will be used for My account work experience. Get the work item type state color for multiple projects
530
+ *
531
+ * @param projectNames -
532
+ */
533
+ getWorkItemStateColors(projectNames: string[]): Promise<WorkItemTracking.ProjectWorkItemStateColors[]>;
534
+ /**
535
+ * Returns the next state on the given work item IDs.
536
+ *
537
+ * @param ids - list of work item ids
538
+ * @param action - possible actions. Currently only supports checkin
539
+ */
540
+ getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemTracking.WorkItemNextStateOnTransition[]>;
541
+ /**
542
+ * Get all work item type categories.
543
+ *
544
+ * @param project - Project ID or project name
545
+ */
546
+ getWorkItemTypeCategories(project: string): Promise<WorkItemTracking.WorkItemTypeCategory[]>;
547
+ /**
548
+ * Get specific work item type category by name.
549
+ *
550
+ * @param project - Project ID or project name
551
+ * @param category - The category name
552
+ */
553
+ getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTracking.WorkItemTypeCategory>;
554
+ /**
555
+ * INTERNAL ONLY: It will be used for My account work experience. Get the wit type color for multiple projects
556
+ *
557
+ * @param projectNames -
558
+ */
559
+ getWorkItemTypeColors(projectNames: string[]): Promise<{
560
+ key: string;
561
+ value: WorkItemTracking.WorkItemTypeColor[];
562
+ }[]>;
563
+ /**
564
+ * INTERNAL ONLY: It is used for color and icon providers. Get the wit type color for multiple projects
565
+ *
566
+ * @param projectNames -
567
+ */
568
+ getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{
569
+ key: string;
570
+ value: WorkItemTracking.WorkItemTypeColorAndIcon[];
571
+ }[]>;
572
+ /**
573
+ * Returns a work item type definition.
574
+ *
575
+ * @param project - Project ID or project name
576
+ * @param type - Work item type name
577
+ */
578
+ getWorkItemType(project: string, type: string): Promise<WorkItemTracking.WorkItemType>;
579
+ /**
580
+ * Returns the list of work item types
581
+ *
582
+ * @param project - Project ID or project name
583
+ */
584
+ getWorkItemTypes(project: string): Promise<WorkItemTracking.WorkItemType[]>;
585
+ /**
586
+ * Get a list of fields for a work item type with detailed references.
587
+ *
588
+ * @param project - Project ID or project name
589
+ * @param type - Work item type.
590
+ * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
591
+ */
592
+ getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTracking.WorkItemTypeFieldsExpandLevel): Promise<WorkItemTracking.WorkItemTypeFieldWithReferences[]>;
593
+ /**
594
+ * Get a field for a work item type with detailed references.
595
+ *
596
+ * @param project - Project ID or project name
597
+ * @param type - Work item type.
598
+ * @param field -
599
+ * @param expand - Expand level for the API response. Properties: to include allowedvalues, default value, isRequired etc. as a part of response; None: to skip these properties.
600
+ */
601
+ getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTracking.WorkItemTypeFieldsExpandLevel): Promise<WorkItemTracking.WorkItemTypeFieldWithReferences>;
602
+ /**
603
+ * Returns the state names and colors for a work item type.
604
+ *
605
+ * @param project - Project ID or project name
606
+ * @param type - The state name
607
+ */
608
+ getWorkItemTypeStates(project: string, type: string): Promise<WorkItemTracking.WorkItemStateColor[]>;
609
+ /**
610
+ * Export work item type
611
+ *
612
+ * @param project - Project ID or project name
613
+ * @param type -
614
+ * @param exportGlobalLists -
615
+ */
616
+ exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTracking.WorkItemTypeTemplate>;
617
+ /**
618
+ * Add/updates a work item type
619
+ *
620
+ * @param updateModel -
621
+ * @param project - Project ID or project name
622
+ */
623
+ updateWorkItemTypeDefinition(updateModel: WorkItemTracking.WorkItemTypeTemplateUpdateModel, project?: string): Promise<WorkItemTracking.ProvisioningResult>;
624
+ }