azure-devops-extension-api 4.269.1 → 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 (694) 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 -712
  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 -1245
  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 -169
  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 -3888
  171. package/Git/Git.js +830 -817
  172. package/Git/Git.min.js +1 -1
  173. package/Git/GitClient.d.ts +1468 -1454
  174. package/Git/GitClient.js +3892 -4313
  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 -241
  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 -3764
  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 -2124
  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 +33 -0
  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/ESRPClientLogs0305214508957.json +0 -1
@@ -1,2124 +1,2158 @@
1
- import * as WebApi from "../WebApi/WebApi";
2
- export interface AccountMyWorkResult {
3
- /**
4
- * True, when length of WorkItemDetails is same as the limit
5
- */
6
- querySizeLimitExceeded: boolean;
7
- /**
8
- * WorkItem Details
9
- */
10
- workItemDetails: AccountWorkWorkItemModel[];
11
- }
12
- /**
13
- * Represents Work Item Recent Activity
14
- */
15
- export interface AccountRecentActivityWorkItemModel extends AccountRecentActivityWorkItemModelBase {
16
- /**
17
- * Assigned To
18
- */
19
- assignedTo: string;
20
- }
21
- /**
22
- * Represents Work Item Recent Activity
23
- */
24
- export interface AccountRecentActivityWorkItemModel2 extends AccountRecentActivityWorkItemModelBase {
25
- /**
26
- * Assigned To
27
- */
28
- assignedTo: WebApi.IdentityRef;
29
- }
30
- /**
31
- * Represents Work Item Recent Activity
32
- */
33
- export interface AccountRecentActivityWorkItemModelBase {
34
- /**
35
- * Date of the last Activity by the user
36
- */
37
- activityDate: Date;
38
- /**
39
- * Type of the activity
40
- */
41
- activityType: WorkItemRecentActivityType;
42
- /**
43
- * Last changed date of the work item
44
- */
45
- changedDate: Date;
46
- /**
47
- * Work Item Id
48
- */
49
- id: number;
50
- /**
51
- * TeamFoundationId of the user this activity belongs to
52
- */
53
- identityId: string;
54
- /**
55
- * State of the work item
56
- */
57
- state: string;
58
- /**
59
- * Team project the work item belongs to
60
- */
61
- teamProject: string;
62
- /**
63
- * Title of the work item
64
- */
65
- title: string;
66
- /**
67
- * Type of Work Item
68
- */
69
- workItemType: string;
70
- }
71
- /**
72
- * Represents Recent Mention Work Item
73
- */
74
- export interface AccountRecentMentionWorkItemModel {
75
- /**
76
- * Assigned To
77
- */
78
- assignedTo: string;
79
- /**
80
- * Work Item Id
81
- */
82
- id: number;
83
- /**
84
- * Latest date that the user were mentioned
85
- */
86
- mentionedDateField: Date;
87
- /**
88
- * State of the work item
89
- */
90
- state: string;
91
- /**
92
- * Team project the work item belongs to
93
- */
94
- teamProject: string;
95
- /**
96
- * Title of the work item
97
- */
98
- title: string;
99
- /**
100
- * Type of Work Item
101
- */
102
- workItemType: string;
103
- }
104
- export interface AccountWorkWorkItemModel {
105
- assignedTo: string;
106
- changedDate: Date;
107
- id: number;
108
- state: string;
109
- teamProject: string;
110
- title: string;
111
- workItemType: string;
112
- }
113
- /**
114
- * Contains criteria for querying work items based on artifact URI.
115
- */
116
- export interface ArtifactUriQuery {
117
- /**
118
- * List of artifact URIs to use for querying work items.
119
- */
120
- artifactUris: string[];
121
- }
122
- /**
123
- * Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI.
124
- */
125
- export interface ArtifactUriQueryResult {
126
- /**
127
- * A Dictionary that maps a list of work item references to the given list of artifact URI.
128
- */
129
- artifactUrisQueryResult: {
130
- [key: string]: WorkItemReference[];
131
- };
132
- }
133
- export interface AttachmentReference {
134
- id: string;
135
- url: string;
136
- }
137
- /**
138
- * Flag to control error policy in a batch classification nodes get request.
139
- */
140
- export declare enum ClassificationNodesErrorPolicy {
141
- Fail = 1,
142
- Omit = 2
143
- }
144
- /**
145
- * Comment on a Work Item.
146
- */
147
- export interface Comment extends WorkItemTrackingResource {
148
- /**
149
- * IdentityRef of the creator of the comment.
150
- */
151
- createdBy: WebApi.IdentityRef;
152
- /**
153
- * The creation date of the comment.
154
- */
155
- createdDate: Date;
156
- /**
157
- * Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
158
- */
159
- createdOnBehalfDate: Date;
160
- /**
161
- * Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
162
- */
163
- createdOnBehalfOf: WebApi.IdentityRef;
164
- /**
165
- * Represents the possible types for the comment format.
166
- */
167
- format: CommentFormat;
168
- /**
169
- * The id assigned to the comment.
170
- */
171
- id: number;
172
- /**
173
- * Indicates if the comment has been deleted.
174
- */
175
- isDeleted: boolean;
176
- /**
177
- * The mentions of the comment.
178
- */
179
- mentions: CommentMention[];
180
- /**
181
- * IdentityRef of the user who last modified the comment.
182
- */
183
- modifiedBy: WebApi.IdentityRef;
184
- /**
185
- * The last modification date of the comment.
186
- */
187
- modifiedDate: Date;
188
- /**
189
- * The reactions of the comment.
190
- */
191
- reactions: CommentReaction[];
192
- /**
193
- * The text of the comment in HTML format.
194
- */
195
- renderedText: string;
196
- /**
197
- * The text of the comment.
198
- */
199
- text: string;
200
- /**
201
- * The current version of the comment.
202
- */
203
- version: number;
204
- /**
205
- * The id of the work item this comment belongs to.
206
- */
207
- workItemId: number;
208
- }
209
- /**
210
- * Represents a request to create a work item comment.
211
- */
212
- export interface CommentCreate {
213
- /**
214
- * The text of the comment.
215
- */
216
- text: string;
217
- }
218
- /**
219
- * Specifies the additional data retrieval options for work item comments.
220
- */
221
- export declare enum CommentExpandOptions {
222
- None = 0,
223
- /**
224
- * Include comment reactions.
225
- */
226
- Reactions = 1,
227
- /**
228
- * Include the rendered text (html) in addition to MD text.
229
- */
230
- RenderedText = 8,
231
- /**
232
- * If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes.
233
- */
234
- RenderedTextOnly = 16,
235
- All = -17
236
- }
237
- /**
238
- * Represents the possible types for the comment format. Should be in sync with WorkItemCommentFormat.cs
239
- */
240
- export declare enum CommentFormat {
241
- Markdown = 0,
242
- Html = 1
243
- }
244
- /**
245
- * Represents a list of work item comments.
246
- */
247
- export interface CommentList extends WorkItemTrackingResource {
248
- /**
249
- * List of comments in the current batch.
250
- */
251
- comments: Comment[];
252
- /**
253
- * A string token that can be used to retrieving next page of comments if available. Otherwise null.
254
- */
255
- continuationToken: string;
256
- /**
257
- * The count of comments in the current batch.
258
- */
259
- count: number;
260
- /**
261
- * Uri to the next page of comments if it is available. Otherwise null.
262
- */
263
- nextPage: string;
264
- /**
265
- * Total count of comments on a work item.
266
- */
267
- totalCount: number;
268
- }
269
- export interface CommentMention extends WorkItemTrackingResource {
270
- /**
271
- * The artifact portion of the parsed text. (i.e. the work item's id)
272
- */
273
- artifactId: string;
274
- /**
275
- * The type the parser assigned to the mention. (i.e. person, work item, etc)
276
- */
277
- artifactType: string;
278
- /**
279
- * The comment id of the mention.
280
- */
281
- commentId: number;
282
- /**
283
- * The resolved target of the mention. An example of this could be a user's tfid
284
- */
285
- targetId: string;
286
- }
287
- /**
288
- * Contains information about work item comment reaction for a particular reaction type.
289
- */
290
- export interface CommentReaction extends WorkItemTrackingResource {
291
- /**
292
- * The id of the comment this reaction belongs to.
293
- */
294
- commentId: number;
295
- /**
296
- * Total number of reactions for the CommentReactionType.
297
- */
298
- count: number;
299
- /**
300
- * Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment).
301
- */
302
- isCurrentUserEngaged: boolean;
303
- /**
304
- * Type of the reaction.
305
- */
306
- type: CommentReactionType;
307
- }
308
- /**
309
- * Represents different reaction types for a work item comment.
310
- */
311
- export declare enum CommentReactionType {
312
- Like = 0,
313
- Dislike = 1,
314
- Heart = 2,
315
- Hooray = 3,
316
- Smile = 4,
317
- Confused = 5
318
- }
319
- export declare enum CommentSortOrder {
320
- /**
321
- * The results will be sorted in Ascending order.
322
- */
323
- Asc = 1,
324
- /**
325
- * The results will be sorted in Descending order.
326
- */
327
- Desc = 2
328
- }
329
- /**
330
- * Represents a request to update a work item comment.
331
- */
332
- export interface CommentUpdate {
333
- /**
334
- * The updated text of the comment.
335
- */
336
- text: string;
337
- }
338
- /**
339
- * Represents a specific version of a comment on a work item.
340
- */
341
- export interface CommentVersion extends WorkItemTrackingResource {
342
- /**
343
- * IdentityRef of the creator of the comment.
344
- */
345
- createdBy: WebApi.IdentityRef;
346
- /**
347
- * The creation date of the comment.
348
- */
349
- createdDate: Date;
350
- /**
351
- * Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
352
- */
353
- createdOnBehalfDate: Date;
354
- /**
355
- * Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
356
- */
357
- createdOnBehalfOf: WebApi.IdentityRef;
358
- /**
359
- * The id assigned to the comment.
360
- */
361
- id: number;
362
- /**
363
- * Indicates if the comment has been deleted at this version.
364
- */
365
- isDeleted: boolean;
366
- /**
367
- * IdentityRef of the user who modified the comment at this version.
368
- */
369
- modifiedBy: WebApi.IdentityRef;
370
- /**
371
- * The modification date of the comment for this version.
372
- */
373
- modifiedDate: Date;
374
- /**
375
- * The rendered content of the comment at this version.
376
- */
377
- renderedText: string;
378
- /**
379
- * The text of the comment at this version.
380
- */
381
- text: string;
382
- /**
383
- * The version number.
384
- */
385
- version: number;
386
- }
387
- /**
388
- * Describes permanently deleted attachment and work items that had links to this attachment.
389
- */
390
- export interface DestroyedAttachment {
391
- /**
392
- * Work items with attachment references that have been marked as deleted.
393
- */
394
- affectedWorkItems: WorkItemReference[];
395
- /**
396
- * Permanently deleted attachment.
397
- */
398
- attachment: AttachmentReference;
399
- }
400
- export interface EmailRecipients {
401
- /**
402
- * Plaintext email addresses.
403
- */
404
- emailAddresses: string[];
405
- /**
406
- * TfIds
407
- */
408
- tfIds: string[];
409
- /**
410
- * Unresolved entity ids
411
- */
412
- unresolvedEntityIds: string[];
413
- }
414
- export interface ExternalDeployment {
415
- artifactId: string;
416
- createdBy: string;
417
- description: string;
418
- displayName: string;
419
- environment: ExternalEnvironment;
420
- group: string;
421
- pipeline: ExternalPipeline;
422
- relatedWorkItemIds: number[];
423
- runId: number;
424
- sequenceNumber: number;
425
- status: string;
426
- statusDate: Date;
427
- url: string;
428
- }
429
- export interface ExternalEnvironment {
430
- displayName: string;
431
- id: number;
432
- type: string;
433
- }
434
- export interface ExternalPipeline {
435
- displayName: string;
436
- id: number;
437
- url: string;
438
- }
439
- /**
440
- * Describes a list of dependent fields for a rule.
441
- */
442
- export interface FieldDependentRule extends WorkItemTrackingResource {
443
- /**
444
- * The dependent fields.
445
- */
446
- dependentFields: WorkItemFieldReference[];
447
- }
448
- /**
449
- * Enum for field types.
450
- */
451
- export declare enum FieldType {
452
- /**
453
- * String field type.
454
- */
455
- String = 0,
456
- /**
457
- * Integer field type.
458
- */
459
- Integer = 1,
460
- /**
461
- * Datetime field type.
462
- */
463
- DateTime = 2,
464
- /**
465
- * Plain text field type.
466
- */
467
- PlainText = 3,
468
- /**
469
- * HTML (Multiline) field type.
470
- */
471
- Html = 4,
472
- /**
473
- * Treepath field type.
474
- */
475
- TreePath = 5,
476
- /**
477
- * History field type.
478
- */
479
- History = 6,
480
- /**
481
- * Double field type.
482
- */
483
- Double = 7,
484
- /**
485
- * Guid field type.
486
- */
487
- Guid = 8,
488
- /**
489
- * Boolean field type.
490
- */
491
- Boolean = 9,
492
- /**
493
- * Identity field type.
494
- */
495
- Identity = 10,
496
- /**
497
- * String picklist field type. When creating a string picklist field from REST API, use "String" FieldType.
498
- */
499
- PicklistString = 11,
500
- /**
501
- * Integer picklist field type. When creating a integer picklist field from REST API, use "Integer" FieldType.
502
- */
503
- PicklistInteger = 12,
504
- /**
505
- * Double picklist field type. When creating a double picklist field from REST API, use "Double" FieldType.
506
- */
507
- PicklistDouble = 13
508
- }
509
- /**
510
- * Describes an update request for a work item field.
511
- */
512
- export interface FieldUpdate {
513
- /**
514
- * Indicates whether the user wants to restore the field.
515
- */
516
- isDeleted: boolean;
517
- /**
518
- * Indicates whether the user wants to lock the field.
519
- */
520
- isLocked: boolean;
521
- }
522
- /**
523
- * Enum for field usages.
524
- */
525
- export declare enum FieldUsage {
526
- /**
527
- * Empty usage.
528
- */
529
- None = 0,
530
- /**
531
- * Work item field usage.
532
- */
533
- WorkItem = 1,
534
- /**
535
- * Work item link field usage.
536
- */
537
- WorkItemLink = 2,
538
- /**
539
- * Treenode field usage.
540
- */
541
- Tree = 3,
542
- /**
543
- * Work Item Type Extension usage.
544
- */
545
- WorkItemTypeExtension = 4
546
- }
547
- /**
548
- * Flag to expand types of fields.
549
- */
550
- export declare enum GetFieldsExpand {
551
- /**
552
- * Default behavior.
553
- */
554
- None = 0,
555
- /**
556
- * Adds extension fields to the response.
557
- */
558
- ExtensionFields = 1,
559
- /**
560
- * Includes fields that have been deleted.
561
- */
562
- IncludeDeleted = 2
563
- }
564
- /**
565
- * Describes Github connection.
566
- */
567
- export interface GitHubConnectionModel {
568
- /**
569
- * Github connection authorization type (f. e. PAT, OAuth)
570
- */
571
- authorizationType: string;
572
- /**
573
- * Github connection created by
574
- */
575
- createdBy: WebApi.IdentityRef;
576
- /**
577
- * Github connection id
578
- */
579
- id: string;
580
- /**
581
- * Whether current Github connection is valid or not
582
- */
583
- isConnectionValid: boolean;
584
- /**
585
- * Github connection name (should contain organization/user name)
586
- */
587
- name: string;
588
- }
589
- /**
590
- * Describes Github connection's repo.
591
- */
592
- export interface GitHubConnectionRepoModel {
593
- /**
594
- * Error message
595
- */
596
- errorMessage: string;
597
- /**
598
- * Repository web url
599
- */
600
- gitHubRepositoryUrl: string;
601
- }
602
- /**
603
- * Describes Github connection's repo bulk request
604
- */
605
- export interface GitHubConnectionReposBatchRequest {
606
- /**
607
- * Requested repos urls
608
- */
609
- gitHubRepositoryUrls: GitHubConnectionRepoModel[];
610
- /**
611
- * Operation type (f. e. add, remove)
612
- */
613
- operationType: string;
614
- }
615
- /**
616
- * Describes a reference to an identity.
617
- */
618
- export interface IdentityReference extends WebApi.IdentityRef {
619
- /**
620
- * Gets or sets the identifier of the identity.
621
- */
622
- id: string;
623
- /**
624
- * Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version
625
- */
626
- name: string;
627
- }
628
- /**
629
- * Format for multiline field selected by the last edit user.
630
- */
631
- export declare enum LargeTextCustomHtmlFormat {
632
- /**
633
- * Markdown format for text content.
634
- */
635
- Markdown = 0,
636
- /**
637
- * HTML format for text content.
638
- */
639
- Html = 1
640
- }
641
- /**
642
- * Link description.
643
- */
644
- export interface Link {
645
- /**
646
- * Collection of link attributes.
647
- */
648
- attributes: {
649
- [key: string]: any;
650
- };
651
- /**
652
- * Relation type.
653
- */
654
- rel: string;
655
- /**
656
- * Link url.
657
- */
658
- url: string;
659
- }
660
- /**
661
- * The link query mode which determines the behavior of the query.
662
- */
663
- export declare enum LinkQueryMode {
664
- /**
665
- * Returns flat list of work items.
666
- */
667
- WorkItems = 0,
668
- /**
669
- * Returns work items where the source, target, and link criteria are all satisfied.
670
- */
671
- LinksOneHopMustContain = 1,
672
- /**
673
- * Returns work items that satisfy the source and link criteria, even if no linked work item satisfies the target criteria.
674
- */
675
- LinksOneHopMayContain = 2,
676
- /**
677
- * Returns work items that satisfy the source, only if no linked work item satisfies the link and target criteria.
678
- */
679
- LinksOneHopDoesNotContain = 3,
680
- LinksRecursiveMustContain = 4,
681
- /**
682
- * Returns work items a hierarchy of work items that by default satisfy the source
683
- */
684
- LinksRecursiveMayContain = 5,
685
- LinksRecursiveDoesNotContain = 6
686
- }
687
- export declare enum LogicalOperation {
688
- NONE = 0,
689
- AND = 1,
690
- OR = 2
691
- }
692
- export interface MailMessage {
693
- /**
694
- * The mail body in HTML format.
695
- */
696
- body: string;
697
- /**
698
- * CC recipients.
699
- */
700
- cc: EmailRecipients;
701
- /**
702
- * The in-reply-to header value
703
- */
704
- inReplyTo: string;
705
- /**
706
- * The Message Id value
707
- */
708
- messageId: string;
709
- /**
710
- * Reply To recipients.
711
- */
712
- replyTo: EmailRecipients;
713
- /**
714
- * The mail subject.
715
- */
716
- subject: string;
717
- /**
718
- * To recipients
719
- */
720
- to: EmailRecipients;
721
- }
722
- /**
723
- * Stores process ID.
724
- */
725
- export interface ProcessIdModel {
726
- /**
727
- * The ID of the process.
728
- */
729
- typeId: string;
730
- }
731
- /**
732
- * Stores project ID and its process ID.
733
- */
734
- export interface ProcessMigrationResultModel {
735
- /**
736
- * The ID of the process.
737
- */
738
- processId: string;
739
- /**
740
- * The ID of the project.
741
- */
742
- projectId: string;
743
- }
744
- /**
745
- * Project work item type state colors
746
- */
747
- export interface ProjectWorkItemStateColors {
748
- /**
749
- * Project name
750
- */
751
- projectName: string;
752
- /**
753
- * State colors for all work item type in a project
754
- */
755
- workItemTypeStateColors: WorkItemTypeStateColors[];
756
- }
757
- /**
758
- * Enumerates the possible provisioning actions that can be triggered on process template update.
759
- */
760
- export declare enum ProvisioningActionType {
761
- Import = 0,
762
- Validate = 1
763
- }
764
- /**
765
- * Result of an update work item type XML update operation.
766
- */
767
- export interface ProvisioningResult {
768
- /**
769
- * Details about of the provisioning import events.
770
- */
771
- provisioningImportEvents: string[];
772
- }
773
- /**
774
- * Describes a request to get a list of queries
775
- */
776
- export interface QueryBatchGetRequest {
777
- /**
778
- * The expand parameters for queries. Possible options are \{ None, Wiql, Clauses, All, Minimal \}
779
- */
780
- $expand: QueryExpand;
781
- /**
782
- * The flag to control error policy in a query batch request. Possible options are \{ Fail, Omit \}.
783
- */
784
- errorPolicy: QueryErrorPolicy;
785
- /**
786
- * The requested query ids
787
- */
788
- ids: string[];
789
- }
790
- /**
791
- * Enum to control error policy in a query batch request.
792
- */
793
- export declare enum QueryErrorPolicy {
794
- Fail = 1,
795
- Omit = 2
796
- }
797
- /**
798
- * Determines which set of additional query properties to display
799
- */
800
- export declare enum QueryExpand {
801
- /**
802
- * Expands Columns, Links and ChangeInfo
803
- */
804
- None = 0,
805
- /**
806
- * Expands Columns, Links, ChangeInfo and WIQL text
807
- */
808
- Wiql = 1,
809
- /**
810
- * Expands Columns, Links, ChangeInfo, WIQL text and clauses
811
- */
812
- Clauses = 2,
813
- /**
814
- * Expands all properties
815
- */
816
- All = 3,
817
- /**
818
- * Displays minimal properties and the WIQL text
819
- */
820
- Minimal = 4
821
- }
822
- /**
823
- * Represents an item in the work item query hierarchy. This can be either a query or a folder.
824
- */
825
- export interface QueryHierarchyItem extends WorkItemTrackingResource {
826
- /**
827
- * The child query items inside a query folder.
828
- */
829
- children: QueryHierarchyItem[];
830
- /**
831
- * The clauses for a flat query.
832
- */
833
- clauses: WorkItemQueryClause;
834
- /**
835
- * The columns of the query.
836
- */
837
- columns: WorkItemFieldReference[];
838
- /**
839
- * The identity who created the query item.
840
- */
841
- createdBy: IdentityReference;
842
- /**
843
- * When the query item was created.
844
- */
845
- createdDate: Date;
846
- /**
847
- * The link query mode.
848
- */
849
- filterOptions: LinkQueryMode;
850
- /**
851
- * If this is a query folder, indicates if it contains any children.
852
- */
853
- hasChildren: boolean;
854
- /**
855
- * The id of the query item.
856
- */
857
- id: string;
858
- /**
859
- * Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it.
860
- */
861
- isDeleted: boolean;
862
- /**
863
- * Indicates if this is a query folder or a query.
864
- */
865
- isFolder: boolean;
866
- /**
867
- * Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path.
868
- */
869
- isInvalidSyntax: boolean;
870
- /**
871
- * Indicates if this query item is public or private.
872
- */
873
- isPublic: boolean;
874
- /**
875
- * The identity who last ran the query.
876
- */
877
- lastExecutedBy: IdentityReference;
878
- /**
879
- * When the query was last run.
880
- */
881
- lastExecutedDate: Date;
882
- /**
883
- * The identity who last modified the query item.
884
- */
885
- lastModifiedBy: IdentityReference;
886
- /**
887
- * When the query item was last modified.
888
- */
889
- lastModifiedDate: Date;
890
- /**
891
- * The link query clause.
892
- */
893
- linkClauses: WorkItemQueryClause;
894
- /**
895
- * The name of the query item.
896
- */
897
- name: string;
898
- /**
899
- * The path of the query item.
900
- */
901
- path: string;
902
- /**
903
- * The recursion option for use in a tree query.
904
- */
905
- queryRecursionOption: QueryRecursionOption;
906
- /**
907
- * The type of query.
908
- */
909
- queryType: QueryType;
910
- /**
911
- * The sort columns of the query.
912
- */
913
- sortColumns: WorkItemQuerySortColumn[];
914
- /**
915
- * The source clauses in a tree or one-hop link query.
916
- */
917
- sourceClauses: WorkItemQueryClause;
918
- /**
919
- * The target clauses in a tree or one-hop link query.
920
- */
921
- targetClauses: WorkItemQueryClause;
922
- /**
923
- * The WIQL text of the query
924
- */
925
- wiql: string;
926
- }
927
- export interface QueryHierarchyItemsResult {
928
- /**
929
- * The count of items.
930
- */
931
- count: number;
932
- /**
933
- * Indicates if the max return limit was hit but there are still more items
934
- */
935
- hasMore: boolean;
936
- /**
937
- * The list of items
938
- */
939
- value: QueryHierarchyItem[];
940
- }
941
- export declare enum QueryOption {
942
- Doing = 1,
943
- Done = 2,
944
- Followed = 3
945
- }
946
- /**
947
- * Determines whether a tree query matches parents or children first.
948
- */
949
- export declare enum QueryRecursionOption {
950
- /**
951
- * Returns work items that satisfy the source, even if no linked work item satisfies the target and link criteria.
952
- */
953
- ParentFirst = 0,
954
- /**
955
- * Returns work items that satisfy the target criteria, even if no work item satisfies the source and link criteria.
956
- */
957
- ChildFirst = 1
958
- }
959
- /**
960
- * The query result type
961
- */
962
- export declare enum QueryResultType {
963
- /**
964
- * A list of work items (for flat queries).
965
- */
966
- WorkItem = 1,
967
- /**
968
- * A list of work item links (for OneHop and Tree queries).
969
- */
970
- WorkItemLink = 2
971
- }
972
- /**
973
- * The type of query.
974
- */
975
- export declare enum QueryType {
976
- /**
977
- * Gets a flat list of work items.
978
- */
979
- Flat = 1,
980
- /**
981
- * Gets a tree of work items showing their link hierarchy.
982
- */
983
- Tree = 2,
984
- /**
985
- * Gets a list of work items and their direct links.
986
- */
987
- OneHop = 3
988
- }
989
- /**
990
- * The reporting revision expand level.
991
- */
992
- export declare enum ReportingRevisionsExpand {
993
- /**
994
- * Default behavior.
995
- */
996
- None = 0,
997
- /**
998
- * Add fields to the response.
999
- */
1000
- Fields = 1
1001
- }
1002
- export interface ReportingWorkItemLinksBatch extends StreamedBatch<WorkItemRelation> {
1003
- }
1004
- export interface ReportingWorkItemRevisionsBatch extends StreamedBatch<WorkItem> {
1005
- }
1006
- /**
1007
- * The class represents the reporting work item revision filer.
1008
- */
1009
- export interface ReportingWorkItemRevisionsFilter {
1010
- /**
1011
- * A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
1012
- */
1013
- fields: string[];
1014
- /**
1015
- * Include deleted work item in the result.
1016
- */
1017
- includeDeleted: boolean;
1018
- /**
1019
- * Return an identity reference instead of a string value for identity fields.
1020
- */
1021
- includeIdentityRef: boolean;
1022
- /**
1023
- * Include only the latest version of a work item, skipping over all previous revisions of the work item.
1024
- */
1025
- includeLatestOnly: boolean;
1026
- /**
1027
- * Include tag reference instead of string value for System.Tags field
1028
- */
1029
- includeTagRef: boolean;
1030
- /**
1031
- * 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.
1032
- */
1033
- types: string[];
1034
- }
1035
- export interface SendMailBody {
1036
- fields: string[];
1037
- ids: number[];
1038
- message: MailMessage;
1039
- persistenceId: string;
1040
- projectId: string;
1041
- sortFields: string[];
1042
- tempQueryId: string;
1043
- wiql: string;
1044
- }
1045
- /**
1046
- * The class describes reporting work item revision batch.
1047
- */
1048
- export interface StreamedBatch<T> {
1049
- /**
1050
- * ContinuationToken acts as a waterMark. Used while querying large results.
1051
- */
1052
- continuationToken: string;
1053
- /**
1054
- * Returns 'true' if it's last batch, 'false' otherwise.
1055
- */
1056
- isLastBatch: boolean;
1057
- /**
1058
- * The next link for the work item.
1059
- */
1060
- nextLink: string;
1061
- /**
1062
- * Values such as rel, sourceId, TargetId, ChangedDate, isActive.
1063
- */
1064
- values: T[];
1065
- }
1066
- /**
1067
- * Enumerates types of supported xml templates used for customization.
1068
- */
1069
- export declare enum TemplateType {
1070
- WorkItemType = 0,
1071
- GlobalWorkflow = 1
1072
- }
1073
- /**
1074
- * Describes a request to create a temporary query
1075
- */
1076
- export interface TemporaryQueryRequestModel extends WorkItemTrackingResource {
1077
- /**
1078
- * The WIQL text of the temporary query
1079
- */
1080
- wiql: string;
1081
- }
1082
- /**
1083
- * The result of a temporary query creation.
1084
- */
1085
- export interface TemporaryQueryResponseModel {
1086
- /**
1087
- * The id of the temporary query item.
1088
- */
1089
- id: string;
1090
- }
1091
- /**
1092
- * Types of tree node structures.
1093
- */
1094
- export declare enum TreeNodeStructureType {
1095
- /**
1096
- * Area type.
1097
- */
1098
- Area = 0,
1099
- /**
1100
- * Iteration type.
1101
- */
1102
- Iteration = 1
1103
- }
1104
- /**
1105
- * Types of tree structures groups.
1106
- */
1107
- export declare enum TreeStructureGroup {
1108
- Areas = 0,
1109
- Iterations = 1
1110
- }
1111
- /**
1112
- * Describes an update request for a work item field.
1113
- */
1114
- export interface UpdateWorkItemField {
1115
- /**
1116
- * Indicates whether the user wants to restore the field.
1117
- */
1118
- isDeleted: boolean;
1119
- }
1120
- /**
1121
- * A WIQL query
1122
- */
1123
- export interface Wiql {
1124
- /**
1125
- * The text of the WIQL query
1126
- */
1127
- query: string;
1128
- }
1129
- /**
1130
- * A work artifact link describes an outbound artifact link type.
1131
- */
1132
- export interface WorkArtifactLink {
1133
- /**
1134
- * Target artifact type.
1135
- */
1136
- artifactType: string;
1137
- /**
1138
- * Outbound link type.
1139
- */
1140
- linkType: string;
1141
- /**
1142
- * Target tool type.
1143
- */
1144
- toolType: string;
1145
- }
1146
- /**
1147
- * Describes a work item.
1148
- */
1149
- export interface WorkItem extends WorkItemTrackingResource {
1150
- /**
1151
- * Reference to a specific version of the comment added/edited/deleted in this revision.
1152
- */
1153
- commentVersionRef: WorkItemCommentVersionRef;
1154
- /**
1155
- * Map of field and values for the work item.
1156
- */
1157
- fields: {
1158
- [key: string]: any;
1159
- };
1160
- /**
1161
- * The work item ID.
1162
- */
1163
- id: number;
1164
- /**
1165
- * Dictionary describing the Format for multiline fields selected by the last edit user.
1166
- */
1167
- multilineFieldsFormat: {
1168
- [key: string]: LargeTextCustomHtmlFormat;
1169
- };
1170
- /**
1171
- * Relations of the work item.
1172
- */
1173
- relations: WorkItemRelation[];
1174
- /**
1175
- * Revision number of the work item.
1176
- */
1177
- rev: number;
1178
- }
1179
- /**
1180
- * Describes a request to get a set of work items
1181
- */
1182
- export interface WorkItemBatchGetRequest {
1183
- /**
1184
- * The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}
1185
- */
1186
- $expand: WorkItemExpand;
1187
- /**
1188
- * AsOf UTC date time string
1189
- */
1190
- asOf: Date;
1191
- /**
1192
- * The flag to control error policy in a bulk get work items request. Possible options are \{Fail, Omit\}.
1193
- */
1194
- errorPolicy: WorkItemErrorPolicy;
1195
- /**
1196
- * The requested fields
1197
- */
1198
- fields: string[];
1199
- /**
1200
- * The requested work item ids
1201
- */
1202
- ids: number[];
1203
- }
1204
- /**
1205
- * Defines a classification node for work item tracking.
1206
- */
1207
- export interface WorkItemClassificationNode extends WorkItemTrackingResource {
1208
- /**
1209
- * Dictionary that has node attributes like start/finish date for iteration nodes.
1210
- */
1211
- attributes: {
1212
- [key: string]: any;
1213
- };
1214
- /**
1215
- * List of child nodes fetched.
1216
- */
1217
- children: WorkItemClassificationNode[];
1218
- /**
1219
- * Flag that indicates if the classification node has any child nodes.
1220
- */
1221
- hasChildren: boolean;
1222
- /**
1223
- * Integer ID of the classification node.
1224
- */
1225
- id: number;
1226
- /**
1227
- * GUID ID of the classification node.
1228
- */
1229
- identifier: string;
1230
- /**
1231
- * Name of the classification node.
1232
- */
1233
- name: string;
1234
- /**
1235
- * Path of the classification node.
1236
- */
1237
- path: string;
1238
- /**
1239
- * Node structure type.
1240
- */
1241
- structureType: TreeNodeStructureType;
1242
- }
1243
- /**
1244
- * Comment on Work Item
1245
- */
1246
- export interface WorkItemComment extends WorkItemTrackingResource {
1247
- /**
1248
- * Represents the possible types for the comment format.
1249
- */
1250
- format: CommentFormat;
1251
- /**
1252
- * The text of the comment in HTML format.
1253
- */
1254
- renderedText: string;
1255
- /**
1256
- * Identity of user who added the comment.
1257
- */
1258
- revisedBy: IdentityReference;
1259
- /**
1260
- * The date of comment.
1261
- */
1262
- revisedDate: Date;
1263
- /**
1264
- * The work item revision number.
1265
- */
1266
- revision: number;
1267
- /**
1268
- * The text of the comment.
1269
- */
1270
- text: string;
1271
- }
1272
- /**
1273
- * Collection of comments.
1274
- */
1275
- export interface WorkItemComments extends WorkItemTrackingResource {
1276
- /**
1277
- * Comments collection.
1278
- */
1279
- comments: WorkItemComment[];
1280
- /**
1281
- * The count of comments.
1282
- */
1283
- count: number;
1284
- /**
1285
- * Count of comments from the revision.
1286
- */
1287
- fromRevisionCount: number;
1288
- /**
1289
- * Total count of comments.
1290
- */
1291
- totalCount: number;
1292
- }
1293
- /**
1294
- * Represents the reference to a specific version of a comment on a Work Item.
1295
- */
1296
- export interface WorkItemCommentVersionRef extends WorkItemTrackingResourceReference {
1297
- /**
1298
- * The id assigned to the comment.
1299
- */
1300
- commentId: number;
1301
- /**
1302
- * [Internal] The work item revision where this comment was originally added.
1303
- */
1304
- createdInRevision: number;
1305
- /**
1306
- * [Internal] Specifies whether comment was deleted.
1307
- */
1308
- isDeleted: boolean;
1309
- /**
1310
- * [Internal] The text of the comment.
1311
- */
1312
- text: string;
1313
- /**
1314
- * The version number.
1315
- */
1316
- version: number;
1317
- }
1318
- /**
1319
- * Full deleted work item object. Includes the work item itself.
1320
- */
1321
- export interface WorkItemDelete extends WorkItemDeleteReference {
1322
- /**
1323
- * The work item object that was deleted.
1324
- */
1325
- resource: WorkItem;
1326
- }
1327
- /**
1328
- * Describes response to delete a set of work items.
1329
- */
1330
- export interface WorkItemDeleteBatch {
1331
- /**
1332
- * List of results for each work item
1333
- */
1334
- results: WorkItemDelete[];
1335
- }
1336
- /**
1337
- * Describes a request to delete a set of work items
1338
- */
1339
- export interface WorkItemDeleteBatchRequest {
1340
- /**
1341
- * Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
1342
- */
1343
- destroy: boolean;
1344
- /**
1345
- * The requested work item ids
1346
- */
1347
- ids: number[];
1348
- /**
1349
- * Optional parameter, if set to true, notifications will be disabled.
1350
- */
1351
- skipNotifications: boolean;
1352
- }
1353
- /**
1354
- * Reference to a deleted work item.
1355
- */
1356
- export interface WorkItemDeleteReference {
1357
- /**
1358
- * The HTTP status code for work item operation in a batch request.
1359
- */
1360
- code: number;
1361
- /**
1362
- * The user who deleted the work item type.
1363
- */
1364
- deletedBy: string;
1365
- /**
1366
- * The work item deletion date.
1367
- */
1368
- deletedDate: string;
1369
- /**
1370
- * Work item ID.
1371
- */
1372
- id: number;
1373
- /**
1374
- * The exception message for work item operation in a batch request.
1375
- */
1376
- message: string;
1377
- /**
1378
- * Name or title of the work item.
1379
- */
1380
- name: string;
1381
- /**
1382
- * Parent project of the deleted work item.
1383
- */
1384
- project: string;
1385
- /**
1386
- * Type of work item.
1387
- */
1388
- type: string;
1389
- /**
1390
- * REST API URL of the resource
1391
- */
1392
- url: string;
1393
- }
1394
- /**
1395
- * Shallow Reference to a deleted work item.
1396
- */
1397
- export interface WorkItemDeleteShallowReference {
1398
- /**
1399
- * Work item ID.
1400
- */
1401
- id: number;
1402
- /**
1403
- * REST API URL of the resource
1404
- */
1405
- url: string;
1406
- }
1407
- /**
1408
- * Describes an update request for a deleted work item.
1409
- */
1410
- export interface WorkItemDeleteUpdate {
1411
- /**
1412
- * Sets a value indicating whether this work item is deleted.
1413
- */
1414
- isDeleted: boolean;
1415
- }
1416
- /**
1417
- * Enum to control error policy in a bulk get work items request.
1418
- */
1419
- export declare enum WorkItemErrorPolicy {
1420
- /**
1421
- * Fail work error policy.
1422
- */
1423
- Fail = 1,
1424
- /**
1425
- * Omit work error policy.
1426
- */
1427
- Omit = 2
1428
- }
1429
- /**
1430
- * Flag to control payload properties from get work item command.
1431
- */
1432
- export declare enum WorkItemExpand {
1433
- /**
1434
- * Default behavior.
1435
- */
1436
- None = 0,
1437
- /**
1438
- * Relations work item expand.
1439
- */
1440
- Relations = 1,
1441
- /**
1442
- * Fields work item expand.
1443
- */
1444
- Fields = 2,
1445
- /**
1446
- * Links work item expand.
1447
- */
1448
- Links = 3,
1449
- /**
1450
- * Expands all.
1451
- */
1452
- All = 4
1453
- }
1454
- /**
1455
- * Describes a field on a work item and it's properties specific to that work item type.
1456
- */
1457
- export interface WorkItemField extends WorkItemTrackingResource {
1458
- /**
1459
- * Indicates whether the field is sortable in server queries.
1460
- */
1461
- canSortBy: boolean;
1462
- /**
1463
- * The description of the field.
1464
- */
1465
- description: string;
1466
- /**
1467
- * Indicates whether this field is deleted.
1468
- */
1469
- isDeleted: boolean;
1470
- /**
1471
- * Indicates whether this field is an identity field.
1472
- */
1473
- isIdentity: boolean;
1474
- /**
1475
- * Indicates whether this instance is picklist.
1476
- */
1477
- isPicklist: boolean;
1478
- /**
1479
- * Indicates whether this instance is a suggested picklist .
1480
- */
1481
- isPicklistSuggested: boolean;
1482
- /**
1483
- * Indicates whether the field can be queried in the server.
1484
- */
1485
- isQueryable: boolean;
1486
- /**
1487
- * The name of the field.
1488
- */
1489
- name: string;
1490
- /**
1491
- * If this field is picklist, the identifier of the picklist associated, otherwise null
1492
- */
1493
- picklistId: string;
1494
- /**
1495
- * Indicates whether the field is [read only].
1496
- */
1497
- readOnly: boolean;
1498
- /**
1499
- * The reference name of the field.
1500
- */
1501
- referenceName: string;
1502
- /**
1503
- * The supported operations on this field.
1504
- */
1505
- supportedOperations: WorkItemFieldOperation[];
1506
- /**
1507
- * The type of the field.
1508
- */
1509
- type: FieldType;
1510
- /**
1511
- * The usage of the field.
1512
- */
1513
- usage: FieldUsage;
1514
- }
1515
- /**
1516
- * Describes a field on a work item and it's properties specific to that work item type.
1517
- */
1518
- export interface WorkItemField2 extends WorkItemField {
1519
- /**
1520
- * Indicates whether this field is marked as locked for editing.
1521
- */
1522
- isLocked: boolean;
1523
- }
1524
- /**
1525
- * Describes the list of allowed values of the field.
1526
- */
1527
- export interface WorkItemFieldAllowedValues {
1528
- /**
1529
- * The list of field allowed values.
1530
- */
1531
- allowedValues: string[];
1532
- /**
1533
- * Name of the field.
1534
- */
1535
- fieldName: string;
1536
- }
1537
- /**
1538
- * Describes a work item field operation.
1539
- */
1540
- export interface WorkItemFieldOperation {
1541
- /**
1542
- * Friendly name of the operation.
1543
- */
1544
- name: string;
1545
- /**
1546
- * Reference name of the operation.
1547
- */
1548
- referenceName: string;
1549
- }
1550
- /**
1551
- * Reference to a field in a work item
1552
- */
1553
- export interface WorkItemFieldReference {
1554
- /**
1555
- * The friendly name of the field.
1556
- */
1557
- name: string;
1558
- /**
1559
- * The reference name of the field.
1560
- */
1561
- referenceName: string;
1562
- /**
1563
- * The REST URL of the resource.
1564
- */
1565
- url: string;
1566
- }
1567
- /**
1568
- * Describes an update to a work item field.
1569
- */
1570
- export interface WorkItemFieldUpdate {
1571
- /**
1572
- * The new value of the field.
1573
- */
1574
- newValue: any;
1575
- /**
1576
- * The old value of the field.
1577
- */
1578
- oldValue: any;
1579
- }
1580
- export interface WorkItemHistory extends WorkItemTrackingResource {
1581
- rev: number;
1582
- revisedBy: IdentityReference;
1583
- revisedDate: Date;
1584
- value: string;
1585
- }
1586
- /**
1587
- * Reference to a work item icon.
1588
- */
1589
- export interface WorkItemIcon {
1590
- /**
1591
- * The identifier of the icon.
1592
- */
1593
- id: string;
1594
- /**
1595
- * The REST URL of the resource.
1596
- */
1597
- url: string;
1598
- }
1599
- /**
1600
- * A link between two work items.
1601
- */
1602
- export interface WorkItemLink {
1603
- /**
1604
- * The type of link.
1605
- */
1606
- rel: string;
1607
- /**
1608
- * The source work item.
1609
- */
1610
- source: WorkItemReference;
1611
- /**
1612
- * The target work item.
1613
- */
1614
- target: WorkItemReference;
1615
- }
1616
- /**
1617
- * Describes the next state for a work item.
1618
- */
1619
- export interface WorkItemNextStateOnTransition {
1620
- /**
1621
- * Error code if there is no next state transition possible.
1622
- */
1623
- errorCode: string;
1624
- /**
1625
- * Work item ID.
1626
- */
1627
- id: number;
1628
- /**
1629
- * Error message if there is no next state transition possible.
1630
- */
1631
- message: string;
1632
- /**
1633
- * Name of the next state on transition.
1634
- */
1635
- stateOnTransition: string;
1636
- }
1637
- /**
1638
- * Represents a clause in a work item query. This shows the structure of a work item query.
1639
- */
1640
- export interface WorkItemQueryClause {
1641
- /**
1642
- * Child clauses if the current clause is a logical operator
1643
- */
1644
- clauses: WorkItemQueryClause[];
1645
- /**
1646
- * Field associated with condition
1647
- */
1648
- field: WorkItemFieldReference;
1649
- /**
1650
- * Right side of the condition when a field to field comparison
1651
- */
1652
- fieldValue: WorkItemFieldReference;
1653
- /**
1654
- * Determines if this is a field to field comparison
1655
- */
1656
- isFieldValue: boolean;
1657
- /**
1658
- * Logical operator separating the condition clause
1659
- */
1660
- logicalOperator: LogicalOperation;
1661
- /**
1662
- * The field operator
1663
- */
1664
- operator: WorkItemFieldOperation;
1665
- /**
1666
- * Right side of the condition when a field to value comparison
1667
- */
1668
- value: string;
1669
- }
1670
- /**
1671
- * The result of a work item query.
1672
- */
1673
- export interface WorkItemQueryResult {
1674
- /**
1675
- * The date the query was run in the context of.
1676
- */
1677
- asOf: Date;
1678
- /**
1679
- * The columns of the query.
1680
- */
1681
- columns: WorkItemFieldReference[];
1682
- /**
1683
- * The result type
1684
- */
1685
- queryResultType: QueryResultType;
1686
- /**
1687
- * The type of the query
1688
- */
1689
- queryType: QueryType;
1690
- /**
1691
- * The sort columns of the query.
1692
- */
1693
- sortColumns: WorkItemQuerySortColumn[];
1694
- /**
1695
- * The work item links returned by the query.
1696
- */
1697
- workItemRelations: WorkItemLink[];
1698
- /**
1699
- * The work items returned by the query.
1700
- */
1701
- workItems: WorkItemReference[];
1702
- }
1703
- /**
1704
- * A sort column.
1705
- */
1706
- export interface WorkItemQuerySortColumn {
1707
- /**
1708
- * The direction to sort by.
1709
- */
1710
- descending: boolean;
1711
- /**
1712
- * A work item field.
1713
- */
1714
- field: WorkItemFieldReference;
1715
- }
1716
- /**
1717
- * Type of the activity
1718
- */
1719
- export declare enum WorkItemRecentActivityType {
1720
- Visited = 0,
1721
- Edited = 1,
1722
- Deleted = 2,
1723
- Restored = 3
1724
- }
1725
- /**
1726
- * Contains reference to a work item.
1727
- */
1728
- export interface WorkItemReference {
1729
- /**
1730
- * Work item ID.
1731
- */
1732
- id: number;
1733
- /**
1734
- * REST API URL of the resource
1735
- */
1736
- url: string;
1737
- }
1738
- export interface WorkItemRelation extends Link {
1739
- }
1740
- /**
1741
- * Represents the work item type relation type.
1742
- */
1743
- export interface WorkItemRelationType extends WorkItemTrackingReference {
1744
- /**
1745
- * The collection of relation type attributes.
1746
- */
1747
- attributes: {
1748
- [key: string]: any;
1749
- };
1750
- }
1751
- /**
1752
- * Describes updates to a work item's relations.
1753
- */
1754
- export interface WorkItemRelationUpdates {
1755
- /**
1756
- * List of newly added relations.
1757
- */
1758
- added: WorkItemRelation[];
1759
- /**
1760
- * List of removed relations.
1761
- */
1762
- removed: WorkItemRelation[];
1763
- /**
1764
- * List of updated relations.
1765
- */
1766
- updated: WorkItemRelation[];
1767
- }
1768
- /**
1769
- * Work item type state name, color and state category
1770
- */
1771
- export interface WorkItemStateColor {
1772
- /**
1773
- * Category of state
1774
- */
1775
- category: string;
1776
- /**
1777
- * Color value
1778
- */
1779
- color: string;
1780
- /**
1781
- * Work item type state name
1782
- */
1783
- name: string;
1784
- }
1785
- /**
1786
- * Describes a state transition in a work item.
1787
- */
1788
- export interface WorkItemStateTransition {
1789
- /**
1790
- * Gets a list of actions needed to transition to that state.
1791
- */
1792
- actions: string[];
1793
- /**
1794
- * Name of the next state.
1795
- */
1796
- to: string;
1797
- }
1798
- export interface WorkItemTagDefinition {
1799
- id: string;
1800
- lastUpdated: Date;
1801
- name: string;
1802
- url: string;
1803
- }
1804
- /**
1805
- * Describes a work item template.
1806
- */
1807
- export interface WorkItemTemplate extends WorkItemTemplateReference {
1808
- /**
1809
- * Mapping of field and its templated value.
1810
- */
1811
- fields: {
1812
- [key: string]: string;
1813
- };
1814
- }
1815
- /**
1816
- * Describes a shallow reference to a work item template.
1817
- */
1818
- export interface WorkItemTemplateReference extends WorkItemTrackingResource {
1819
- /**
1820
- * The description of the work item template.
1821
- */
1822
- description: string;
1823
- /**
1824
- * The identifier of the work item template.
1825
- */
1826
- id: string;
1827
- /**
1828
- * The name of the work item template.
1829
- */
1830
- name: string;
1831
- /**
1832
- * The name of the work item type.
1833
- */
1834
- workItemTypeName: string;
1835
- }
1836
- export interface WorkItemTrackingReference extends WorkItemTrackingResource {
1837
- /**
1838
- * The name.
1839
- */
1840
- name: string;
1841
- /**
1842
- * The reference name.
1843
- */
1844
- referenceName: string;
1845
- }
1846
- /**
1847
- * Base class for WIT REST resources.
1848
- */
1849
- export interface WorkItemTrackingResource extends WorkItemTrackingResourceReference {
1850
- /**
1851
- * Link references to related REST resources.
1852
- */
1853
- _links: any;
1854
- }
1855
- /**
1856
- * Base class for work item tracking resource references.
1857
- */
1858
- export interface WorkItemTrackingResourceReference {
1859
- /**
1860
- * REST URL for the resource.
1861
- */
1862
- url: string;
1863
- }
1864
- /**
1865
- * Describes a work item type.
1866
- */
1867
- export interface WorkItemType extends WorkItemTrackingResource {
1868
- /**
1869
- * The color.
1870
- */
1871
- color: string;
1872
- /**
1873
- * The description of the work item type.
1874
- */
1875
- description: string;
1876
- /**
1877
- * The fields that exist on the work item type.
1878
- */
1879
- fieldInstances: WorkItemTypeFieldInstance[];
1880
- /**
1881
- * The fields that exist on the work item type.
1882
- */
1883
- fields: WorkItemTypeFieldInstance[];
1884
- /**
1885
- * The icon of the work item type.
1886
- */
1887
- icon: WorkItemIcon;
1888
- /**
1889
- * True if work item type is disabled
1890
- */
1891
- isDisabled: boolean;
1892
- /**
1893
- * Gets the name of the work item type.
1894
- */
1895
- name: string;
1896
- /**
1897
- * The reference name of the work item type.
1898
- */
1899
- referenceName: string;
1900
- /**
1901
- * Gets state information for the work item type.
1902
- */
1903
- states: WorkItemStateColor[];
1904
- /**
1905
- * Gets the various state transition mappings in the work item type.
1906
- */
1907
- transitions: {
1908
- [key: string]: WorkItemStateTransition[];
1909
- };
1910
- /**
1911
- * The XML form.
1912
- */
1913
- xmlForm: string;
1914
- }
1915
- /**
1916
- * Describes a work item type category.
1917
- */
1918
- export interface WorkItemTypeCategory extends WorkItemTrackingResource {
1919
- /**
1920
- * Gets or sets the default type of the work item.
1921
- */
1922
- defaultWorkItemType: WorkItemTypeReference;
1923
- /**
1924
- * The name of the category.
1925
- */
1926
- name: string;
1927
- /**
1928
- * The reference name of the category.
1929
- */
1930
- referenceName: string;
1931
- /**
1932
- * The work item types that belong to the category.
1933
- */
1934
- workItemTypes: WorkItemTypeReference[];
1935
- }
1936
- /**
1937
- * Describes a work item type's colors.
1938
- */
1939
- export interface WorkItemTypeColor {
1940
- /**
1941
- * Gets or sets the color of the primary.
1942
- */
1943
- primaryColor: string;
1944
- /**
1945
- * Gets or sets the color of the secondary.
1946
- */
1947
- secondaryColor: string;
1948
- /**
1949
- * The name of the work item type.
1950
- */
1951
- workItemTypeName: string;
1952
- }
1953
- /**
1954
- * Describes work item type name, its icon and color.
1955
- */
1956
- export interface WorkItemTypeColorAndIcon {
1957
- /**
1958
- * The color of the work item type in hex format.
1959
- */
1960
- color: string;
1961
- /**
1962
- * The work item type icon.
1963
- */
1964
- icon: string;
1965
- /**
1966
- * Indicates if the work item is disabled in the process.
1967
- */
1968
- isDisabled: boolean;
1969
- /**
1970
- * The name of the work item type.
1971
- */
1972
- workItemTypeName: string;
1973
- }
1974
- /**
1975
- * Field instance of a work item type.
1976
- */
1977
- export interface WorkItemTypeFieldInstance extends WorkItemTypeFieldInstanceBase {
1978
- /**
1979
- * The list of field allowed values.
1980
- */
1981
- allowedValues: string[];
1982
- /**
1983
- * Represents the default value of the field.
1984
- */
1985
- defaultValue: string;
1986
- }
1987
- /**
1988
- * Base field instance for workItemType fields.
1989
- */
1990
- export interface WorkItemTypeFieldInstanceBase extends WorkItemFieldReference {
1991
- /**
1992
- * Indicates whether field value is always required.
1993
- */
1994
- alwaysRequired: boolean;
1995
- /**
1996
- * The list of dependent fields.
1997
- */
1998
- dependentFields: WorkItemFieldReference[];
1999
- /**
2000
- * Gets the help text for the field.
2001
- */
2002
- helpText: string;
2003
- }
2004
- /**
2005
- * Expand options for the work item field(s) request.
2006
- */
2007
- export declare enum WorkItemTypeFieldsExpandLevel {
2008
- /**
2009
- * Includes only basic properties of the field.
2010
- */
2011
- None = 0,
2012
- /**
2013
- * Includes allowed values for the field.
2014
- */
2015
- AllowedValues = 1,
2016
- /**
2017
- * Includes dependent fields of the field.
2018
- */
2019
- DependentFields = 2,
2020
- /**
2021
- * Includes allowed values and dependent fields of the field.
2022
- */
2023
- All = 3
2024
- }
2025
- /**
2026
- * Field Instance of a workItemype with detailed references.
2027
- */
2028
- export interface WorkItemTypeFieldWithReferences extends WorkItemTypeFieldInstanceBase {
2029
- /**
2030
- * The list of field allowed values.
2031
- */
2032
- allowedValues: any[];
2033
- /**
2034
- * Represents the default value of the field.
2035
- */
2036
- defaultValue: any;
2037
- }
2038
- /**
2039
- * Reference to a work item type.
2040
- */
2041
- export interface WorkItemTypeReference extends WorkItemTrackingResourceReference {
2042
- /**
2043
- * Name of the work item type.
2044
- */
2045
- name: string;
2046
- }
2047
- /**
2048
- * State colors for a work item type
2049
- */
2050
- export interface WorkItemTypeStateColors {
2051
- /**
2052
- * Work item type state colors
2053
- */
2054
- stateColors: WorkItemStateColor[];
2055
- /**
2056
- * Work item type name
2057
- */
2058
- workItemTypeName: string;
2059
- }
2060
- /**
2061
- * Describes a work item type template.
2062
- */
2063
- export interface WorkItemTypeTemplate {
2064
- /**
2065
- * XML template in string format.
2066
- */
2067
- template: string;
2068
- }
2069
- /**
2070
- * Describes a update work item type template request body.
2071
- */
2072
- export interface WorkItemTypeTemplateUpdateModel {
2073
- /**
2074
- * Describes the type of the action for the update request.
2075
- */
2076
- actionType: ProvisioningActionType;
2077
- /**
2078
- * Methodology to which the template belongs, eg. Agile, Scrum, CMMI.
2079
- */
2080
- methodology: string;
2081
- /**
2082
- * String representation of the work item type template.
2083
- */
2084
- template: string;
2085
- /**
2086
- * The type of the template described in the request body.
2087
- */
2088
- templateType: TemplateType;
2089
- }
2090
- /**
2091
- * Describes an update to a work item.
2092
- */
2093
- export interface WorkItemUpdate extends WorkItemTrackingResource {
2094
- /**
2095
- * List of updates to fields.
2096
- */
2097
- fields: {
2098
- [key: string]: WorkItemFieldUpdate;
2099
- };
2100
- /**
2101
- * ID of update.
2102
- */
2103
- id: number;
2104
- /**
2105
- * List of updates to relations.
2106
- */
2107
- relations: WorkItemRelationUpdates;
2108
- /**
2109
- * The revision number of work item update.
2110
- */
2111
- rev: number;
2112
- /**
2113
- * Identity for the work item update.
2114
- */
2115
- revisedBy: IdentityReference;
2116
- /**
2117
- * The work item updates revision date.
2118
- */
2119
- revisedDate: Date;
2120
- /**
2121
- * The work item ID.
2122
- */
2123
- workItemId: number;
2124
- }
1
+ import * as WebApi from "../WebApi/WebApi";
2
+ export interface AccountMyWorkResult {
3
+ /**
4
+ * True, when length of WorkItemDetails is same as the limit
5
+ */
6
+ querySizeLimitExceeded: boolean;
7
+ /**
8
+ * WorkItem Details
9
+ */
10
+ workItemDetails: AccountWorkWorkItemModel[];
11
+ }
12
+ /**
13
+ * Represents Work Item Recent Activity
14
+ */
15
+ export interface AccountRecentActivityWorkItemModel extends AccountRecentActivityWorkItemModelBase {
16
+ /**
17
+ * Assigned To
18
+ */
19
+ assignedTo: string;
20
+ }
21
+ /**
22
+ * Represents Work Item Recent Activity
23
+ */
24
+ export interface AccountRecentActivityWorkItemModel2 extends AccountRecentActivityWorkItemModelBase {
25
+ /**
26
+ * Assigned To
27
+ */
28
+ assignedTo: WebApi.IdentityRef;
29
+ }
30
+ /**
31
+ * Represents Work Item Recent Activity
32
+ */
33
+ export interface AccountRecentActivityWorkItemModelBase {
34
+ /**
35
+ * Date of the last Activity by the user
36
+ */
37
+ activityDate: Date;
38
+ /**
39
+ * Type of the activity
40
+ */
41
+ activityType: WorkItemRecentActivityType;
42
+ /**
43
+ * Last changed date of the work item
44
+ */
45
+ changedDate: Date;
46
+ /**
47
+ * Work Item Id
48
+ */
49
+ id: number;
50
+ /**
51
+ * TeamFoundationId of the user this activity belongs to
52
+ */
53
+ identityId: string;
54
+ /**
55
+ * State of the work item
56
+ */
57
+ state: string;
58
+ /**
59
+ * Team project the work item belongs to
60
+ */
61
+ teamProject: string;
62
+ /**
63
+ * Title of the work item
64
+ */
65
+ title: string;
66
+ /**
67
+ * Type of Work Item
68
+ */
69
+ workItemType: string;
70
+ }
71
+ /**
72
+ * Represents Recent Mention Work Item
73
+ */
74
+ export interface AccountRecentMentionWorkItemModel {
75
+ /**
76
+ * Assigned To
77
+ */
78
+ assignedTo: string;
79
+ /**
80
+ * Work Item Id
81
+ */
82
+ id: number;
83
+ /**
84
+ * Latest date that the user were mentioned
85
+ */
86
+ mentionedDateField: Date;
87
+ /**
88
+ * State of the work item
89
+ */
90
+ state: string;
91
+ /**
92
+ * Team project the work item belongs to
93
+ */
94
+ teamProject: string;
95
+ /**
96
+ * Title of the work item
97
+ */
98
+ title: string;
99
+ /**
100
+ * Type of Work Item
101
+ */
102
+ workItemType: string;
103
+ }
104
+ export interface AccountWorkWorkItemModel {
105
+ assignedTo: string;
106
+ changedDate: Date;
107
+ id: number;
108
+ state: string;
109
+ teamProject: string;
110
+ title: string;
111
+ workItemType: string;
112
+ }
113
+ /**
114
+ * Contains criteria for querying work items based on artifact URI.
115
+ */
116
+ export interface ArtifactUriQuery {
117
+ /**
118
+ * List of artifact URIs to use for querying work items.
119
+ */
120
+ artifactUris: string[];
121
+ }
122
+ /**
123
+ * Defines result of artifact URI query on work items. Contains mapping of work item IDs to artifact URI.
124
+ */
125
+ export interface ArtifactUriQueryResult {
126
+ /**
127
+ * A Dictionary that maps a list of work item references to the given list of artifact URI.
128
+ */
129
+ artifactUrisQueryResult: {
130
+ [key: string]: WorkItemReference[];
131
+ };
132
+ }
133
+ export interface AttachmentReference {
134
+ id: string;
135
+ url: string;
136
+ }
137
+ /**
138
+ * Flag to control error policy in a batch classification nodes get request.
139
+ */
140
+ export declare enum ClassificationNodesErrorPolicy {
141
+ Fail = 1,
142
+ Omit = 2
143
+ }
144
+ /**
145
+ * Comment on a Work Item.
146
+ */
147
+ export interface Comment extends WorkItemTrackingResource {
148
+ /**
149
+ * IdentityRef of the creator of the comment.
150
+ */
151
+ createdBy: WebApi.IdentityRef;
152
+ /**
153
+ * The creation date of the comment.
154
+ */
155
+ createdDate: Date;
156
+ /**
157
+ * Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
158
+ */
159
+ createdOnBehalfDate: Date;
160
+ /**
161
+ * Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
162
+ */
163
+ createdOnBehalfOf: WebApi.IdentityRef;
164
+ /**
165
+ * Represents the possible types for the comment format.
166
+ */
167
+ format: CommentFormat;
168
+ /**
169
+ * The id assigned to the comment.
170
+ */
171
+ id: number;
172
+ /**
173
+ * Indicates if the comment has been deleted.
174
+ */
175
+ isDeleted: boolean;
176
+ /**
177
+ * The mentions of the comment.
178
+ */
179
+ mentions: CommentMention[];
180
+ /**
181
+ * IdentityRef of the user who last modified the comment.
182
+ */
183
+ modifiedBy: WebApi.IdentityRef;
184
+ /**
185
+ * The last modification date of the comment.
186
+ */
187
+ modifiedDate: Date;
188
+ /**
189
+ * The reactions of the comment.
190
+ */
191
+ reactions: CommentReaction[];
192
+ /**
193
+ * The text of the comment in HTML format.
194
+ */
195
+ renderedText: string;
196
+ /**
197
+ * The text of the comment.
198
+ */
199
+ text: string;
200
+ /**
201
+ * The current version of the comment.
202
+ */
203
+ version: number;
204
+ /**
205
+ * The id of the work item this comment belongs to.
206
+ */
207
+ workItemId: number;
208
+ }
209
+ /**
210
+ * Represents a request to create a work item comment.
211
+ */
212
+ export interface CommentCreate {
213
+ /**
214
+ * The text of the comment.
215
+ */
216
+ text: string;
217
+ }
218
+ /**
219
+ * Specifies the additional data retrieval options for work item comments.
220
+ */
221
+ export declare enum CommentExpandOptions {
222
+ None = 0,
223
+ /**
224
+ * Include comment reactions.
225
+ */
226
+ Reactions = 1,
227
+ /**
228
+ * Include the rendered text (html) in addition to MD text.
229
+ */
230
+ RenderedText = 8,
231
+ /**
232
+ * If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes.
233
+ */
234
+ RenderedTextOnly = 16,
235
+ All = -17
236
+ }
237
+ /**
238
+ * Represents the possible types for the comment format. Should be in sync with WorkItemCommentFormat.cs
239
+ */
240
+ export declare enum CommentFormat {
241
+ Markdown = 0,
242
+ Html = 1
243
+ }
244
+ /**
245
+ * Represents a list of work item comments.
246
+ */
247
+ export interface CommentList extends WorkItemTrackingResource {
248
+ /**
249
+ * List of comments in the current batch.
250
+ */
251
+ comments: Comment[];
252
+ /**
253
+ * A string token that can be used to retrieving next page of comments if available. Otherwise null.
254
+ */
255
+ continuationToken: string;
256
+ /**
257
+ * The count of comments in the current batch.
258
+ */
259
+ count: number;
260
+ /**
261
+ * Uri to the next page of comments if it is available. Otherwise null.
262
+ */
263
+ nextPage: string;
264
+ /**
265
+ * Total count of comments on a work item.
266
+ */
267
+ totalCount: number;
268
+ }
269
+ export interface CommentMention extends WorkItemTrackingResource {
270
+ /**
271
+ * The artifact portion of the parsed text. (i.e. the work item's id)
272
+ */
273
+ artifactId: string;
274
+ /**
275
+ * The type the parser assigned to the mention. (i.e. person, work item, etc)
276
+ */
277
+ artifactType: string;
278
+ /**
279
+ * The comment id of the mention.
280
+ */
281
+ commentId: number;
282
+ /**
283
+ * The resolved target of the mention. An example of this could be a user's tfid
284
+ */
285
+ targetId: string;
286
+ }
287
+ /**
288
+ * Contains information about work item comment reaction for a particular reaction type.
289
+ */
290
+ export interface CommentReaction extends WorkItemTrackingResource {
291
+ /**
292
+ * The id of the comment this reaction belongs to.
293
+ */
294
+ commentId: number;
295
+ /**
296
+ * Total number of reactions for the CommentReactionType.
297
+ */
298
+ count: number;
299
+ /**
300
+ * Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment).
301
+ */
302
+ isCurrentUserEngaged: boolean;
303
+ /**
304
+ * Type of the reaction.
305
+ */
306
+ type: CommentReactionType;
307
+ }
308
+ /**
309
+ * Represents different reaction types for a work item comment.
310
+ */
311
+ export declare enum CommentReactionType {
312
+ Like = 0,
313
+ Dislike = 1,
314
+ Heart = 2,
315
+ Hooray = 3,
316
+ Smile = 4,
317
+ Confused = 5
318
+ }
319
+ export declare enum CommentSortOrder {
320
+ /**
321
+ * The results will be sorted in Ascending order.
322
+ */
323
+ Asc = 1,
324
+ /**
325
+ * The results will be sorted in Descending order.
326
+ */
327
+ Desc = 2
328
+ }
329
+ /**
330
+ * Represents a request to update a work item comment.
331
+ */
332
+ export interface CommentUpdate {
333
+ /**
334
+ * The updated text of the comment.
335
+ */
336
+ text: string;
337
+ }
338
+ /**
339
+ * Represents a specific version of a comment on a work item.
340
+ */
341
+ export interface CommentVersion extends WorkItemTrackingResource {
342
+ /**
343
+ * IdentityRef of the creator of the comment.
344
+ */
345
+ createdBy: WebApi.IdentityRef;
346
+ /**
347
+ * The creation date of the comment.
348
+ */
349
+ createdDate: Date;
350
+ /**
351
+ * Effective Date/time value for adding the comment. Can be optionally different from CreatedDate.
352
+ */
353
+ createdOnBehalfDate: Date;
354
+ /**
355
+ * Identity on whose behalf this comment has been added. Can be optionally different from CreatedBy.
356
+ */
357
+ createdOnBehalfOf: WebApi.IdentityRef;
358
+ /**
359
+ * The id assigned to the comment.
360
+ */
361
+ id: number;
362
+ /**
363
+ * Indicates if the comment has been deleted at this version.
364
+ */
365
+ isDeleted: boolean;
366
+ /**
367
+ * IdentityRef of the user who modified the comment at this version.
368
+ */
369
+ modifiedBy: WebApi.IdentityRef;
370
+ /**
371
+ * The modification date of the comment for this version.
372
+ */
373
+ modifiedDate: Date;
374
+ /**
375
+ * The rendered content of the comment at this version.
376
+ */
377
+ renderedText: string;
378
+ /**
379
+ * The text of the comment at this version.
380
+ */
381
+ text: string;
382
+ /**
383
+ * The version number.
384
+ */
385
+ version: number;
386
+ }
387
+ /**
388
+ * Describes permanently deleted attachment and work items that had links to this attachment.
389
+ */
390
+ export interface DestroyedAttachment {
391
+ /**
392
+ * Work items with attachment references that have been marked as deleted.
393
+ */
394
+ affectedWorkItems: WorkItemReference[];
395
+ /**
396
+ * Permanently deleted attachment.
397
+ */
398
+ attachment: AttachmentReference;
399
+ }
400
+ export interface EmailRecipients {
401
+ /**
402
+ * Plaintext email addresses.
403
+ */
404
+ emailAddresses: string[];
405
+ /**
406
+ * TfIds
407
+ */
408
+ tfIds: string[];
409
+ /**
410
+ * Unresolved entity ids
411
+ */
412
+ unresolvedEntityIds: string[];
413
+ }
414
+ export interface ExternalDeployment {
415
+ artifactId: string;
416
+ createdBy: string;
417
+ description: string;
418
+ displayName: string;
419
+ environment: ExternalEnvironment;
420
+ group: string;
421
+ pipeline: ExternalPipeline;
422
+ relatedWorkItemIds: number[];
423
+ runId: number;
424
+ sequenceNumber: number;
425
+ status: string;
426
+ statusDate: Date;
427
+ url: string;
428
+ }
429
+ export interface ExternalEnvironment {
430
+ displayName: string;
431
+ id: number;
432
+ type: string;
433
+ }
434
+ export interface ExternalPipeline {
435
+ displayName: string;
436
+ id: number;
437
+ url: string;
438
+ }
439
+ /**
440
+ * Describes a list of dependent fields for a rule.
441
+ */
442
+ export interface FieldDependentRule extends WorkItemTrackingResource {
443
+ /**
444
+ * The dependent fields.
445
+ */
446
+ dependentFields: WorkItemFieldReference[];
447
+ }
448
+ /**
449
+ * Enum for field types.
450
+ */
451
+ export declare enum FieldType {
452
+ /**
453
+ * String field type.
454
+ */
455
+ String = 0,
456
+ /**
457
+ * Integer field type.
458
+ */
459
+ Integer = 1,
460
+ /**
461
+ * Datetime field type.
462
+ */
463
+ DateTime = 2,
464
+ /**
465
+ * Plain text field type.
466
+ */
467
+ PlainText = 3,
468
+ /**
469
+ * HTML (Multiline) field type.
470
+ */
471
+ Html = 4,
472
+ /**
473
+ * Treepath field type.
474
+ */
475
+ TreePath = 5,
476
+ /**
477
+ * History field type.
478
+ */
479
+ History = 6,
480
+ /**
481
+ * Double field type.
482
+ */
483
+ Double = 7,
484
+ /**
485
+ * Guid field type.
486
+ */
487
+ Guid = 8,
488
+ /**
489
+ * Boolean field type.
490
+ */
491
+ Boolean = 9,
492
+ /**
493
+ * Identity field type.
494
+ */
495
+ Identity = 10,
496
+ /**
497
+ * String picklist field type. When creating a string picklist field from REST API, use "String" FieldType.
498
+ */
499
+ PicklistString = 11,
500
+ /**
501
+ * Integer picklist field type. When creating a integer picklist field from REST API, use "Integer" FieldType.
502
+ */
503
+ PicklistInteger = 12,
504
+ /**
505
+ * Double picklist field type. When creating a double picklist field from REST API, use "Double" FieldType.
506
+ */
507
+ PicklistDouble = 13
508
+ }
509
+ /**
510
+ * Describes an update request for a work item field.
511
+ */
512
+ export interface FieldUpdate {
513
+ /**
514
+ * Indicates whether the user wants to restore the field.
515
+ */
516
+ isDeleted: boolean;
517
+ /**
518
+ * Indicates whether the user wants to lock the field.
519
+ */
520
+ isLocked: boolean;
521
+ }
522
+ /**
523
+ * Enum for field usages.
524
+ */
525
+ export declare enum FieldUsage {
526
+ /**
527
+ * Empty usage.
528
+ */
529
+ None = 0,
530
+ /**
531
+ * Work item field usage.
532
+ */
533
+ WorkItem = 1,
534
+ /**
535
+ * Work item link field usage.
536
+ */
537
+ WorkItemLink = 2,
538
+ /**
539
+ * Treenode field usage.
540
+ */
541
+ Tree = 3,
542
+ /**
543
+ * Work Item Type Extension usage.
544
+ */
545
+ WorkItemTypeExtension = 4
546
+ }
547
+ /**
548
+ * Flag to expand types of fields.
549
+ */
550
+ export declare enum GetFieldsExpand {
551
+ /**
552
+ * Default behavior.
553
+ */
554
+ None = 0,
555
+ /**
556
+ * Adds extension fields to the response.
557
+ */
558
+ ExtensionFields = 1,
559
+ /**
560
+ * Includes fields that have been deleted.
561
+ */
562
+ IncludeDeleted = 2
563
+ }
564
+ /**
565
+ * Request model for creating a new GitHub connection. Requires a pre-existing ServiceEndpoint (use the ServiceEndpoint API to create one first).
566
+ */
567
+ export interface GitHubConnectionCreateRequest {
568
+ /**
569
+ * List of GitHub repository URLs to include in the connection. Example: ["https://github.com/owner/repo1", "https://github.com/owner/repo2"]
570
+ */
571
+ gitHubRepositoryUrls: GitHubConnectionRepoModel[];
572
+ /**
573
+ * A fine-grained GH User Token with write access to repositories being added to the connection.
574
+ */
575
+ gitHubUserToken: string;
576
+ /**
577
+ * The ID of an existing service endpoint to use for authentication. Create the ServiceEndpoint first using the ServiceEndpoint API with InstallationToken scheme for Boards connections.
578
+ */
579
+ serviceEndpointId: string;
580
+ }
581
+ /**
582
+ * Response model for GitHub connection creation
583
+ */
584
+ export interface GitHubConnectionCreateResponse {
585
+ /**
586
+ * The created GitHub connection
587
+ */
588
+ connection: GitHubConnectionModel;
589
+ /**
590
+ * Results for each repository that was attempted to be added to the connection. Includes repository URL and any error messages.
591
+ */
592
+ repositoryResults: GitHubConnectionRepoModel[];
593
+ /**
594
+ * The ID of the ServiceEndpoint that was used for this connection
595
+ */
596
+ serviceEndpointId: string;
597
+ }
598
+ /**
599
+ * Describes Github connection.
600
+ */
601
+ export interface GitHubConnectionModel {
602
+ /**
603
+ * Github connection authorization type (f. e. PAT, OAuth)
604
+ */
605
+ authorizationType: string;
606
+ /**
607
+ * Github connection created by
608
+ */
609
+ createdBy: WebApi.IdentityRef;
610
+ /**
611
+ * Github connection id
612
+ */
613
+ id: string;
614
+ /**
615
+ * Whether current Github connection is valid or not
616
+ */
617
+ isConnectionValid: boolean;
618
+ /**
619
+ * Github connection name (should contain organization/user name)
620
+ */
621
+ name: string;
622
+ }
623
+ /**
624
+ * Describes Github connection's repo.
625
+ */
626
+ export interface GitHubConnectionRepoModel {
627
+ /**
628
+ * Error message
629
+ */
630
+ errorMessage: string;
631
+ /**
632
+ * Repository web url
633
+ */
634
+ gitHubRepositoryUrl: string;
635
+ }
636
+ /**
637
+ * Describes Github connection's repo bulk request
638
+ */
639
+ export interface GitHubConnectionReposBatchRequest {
640
+ /**
641
+ * Requested repos urls
642
+ */
643
+ gitHubRepositoryUrls: GitHubConnectionRepoModel[];
644
+ /**
645
+ * Operation type (f. e. add, remove)
646
+ */
647
+ operationType: string;
648
+ }
649
+ /**
650
+ * Describes a reference to an identity.
651
+ */
652
+ export interface IdentityReference extends WebApi.IdentityRef {
653
+ /**
654
+ * Gets or sets the identifier of the identity.
655
+ */
656
+ id: string;
657
+ /**
658
+ * Legacy back-compat property. This has been the WIT specific value from Constants. Will be hidden (but exists) on the client unless they are targeting the newest version
659
+ */
660
+ name: string;
661
+ }
662
+ /**
663
+ * Format for multiline field selected by the last edit user.
664
+ */
665
+ export declare enum LargeTextCustomHtmlFormat {
666
+ /**
667
+ * Markdown format for text content.
668
+ */
669
+ Markdown = 0,
670
+ /**
671
+ * HTML format for text content.
672
+ */
673
+ Html = 1
674
+ }
675
+ /**
676
+ * Link description.
677
+ */
678
+ export interface Link {
679
+ /**
680
+ * Collection of link attributes.
681
+ */
682
+ attributes: {
683
+ [key: string]: any;
684
+ };
685
+ /**
686
+ * Relation type.
687
+ */
688
+ rel: string;
689
+ /**
690
+ * Link url.
691
+ */
692
+ url: string;
693
+ }
694
+ /**
695
+ * The link query mode which determines the behavior of the query.
696
+ */
697
+ export declare enum LinkQueryMode {
698
+ /**
699
+ * Returns flat list of work items.
700
+ */
701
+ WorkItems = 0,
702
+ /**
703
+ * Returns work items where the source, target, and link criteria are all satisfied.
704
+ */
705
+ LinksOneHopMustContain = 1,
706
+ /**
707
+ * Returns work items that satisfy the source and link criteria, even if no linked work item satisfies the target criteria.
708
+ */
709
+ LinksOneHopMayContain = 2,
710
+ /**
711
+ * Returns work items that satisfy the source, only if no linked work item satisfies the link and target criteria.
712
+ */
713
+ LinksOneHopDoesNotContain = 3,
714
+ LinksRecursiveMustContain = 4,
715
+ /**
716
+ * Returns work items a hierarchy of work items that by default satisfy the source
717
+ */
718
+ LinksRecursiveMayContain = 5,
719
+ LinksRecursiveDoesNotContain = 6
720
+ }
721
+ export declare enum LogicalOperation {
722
+ NONE = 0,
723
+ AND = 1,
724
+ OR = 2
725
+ }
726
+ export interface MailMessage {
727
+ /**
728
+ * The mail body in HTML format.
729
+ */
730
+ body: string;
731
+ /**
732
+ * CC recipients.
733
+ */
734
+ cc: EmailRecipients;
735
+ /**
736
+ * The in-reply-to header value
737
+ */
738
+ inReplyTo: string;
739
+ /**
740
+ * The Message Id value
741
+ */
742
+ messageId: string;
743
+ /**
744
+ * Reply To recipients.
745
+ */
746
+ replyTo: EmailRecipients;
747
+ /**
748
+ * The mail subject.
749
+ */
750
+ subject: string;
751
+ /**
752
+ * To recipients
753
+ */
754
+ to: EmailRecipients;
755
+ }
756
+ /**
757
+ * Stores process ID.
758
+ */
759
+ export interface ProcessIdModel {
760
+ /**
761
+ * The ID of the process.
762
+ */
763
+ typeId: string;
764
+ }
765
+ /**
766
+ * Stores project ID and its process ID.
767
+ */
768
+ export interface ProcessMigrationResultModel {
769
+ /**
770
+ * The ID of the process.
771
+ */
772
+ processId: string;
773
+ /**
774
+ * The ID of the project.
775
+ */
776
+ projectId: string;
777
+ }
778
+ /**
779
+ * Project work item type state colors
780
+ */
781
+ export interface ProjectWorkItemStateColors {
782
+ /**
783
+ * Project name
784
+ */
785
+ projectName: string;
786
+ /**
787
+ * State colors for all work item type in a project
788
+ */
789
+ workItemTypeStateColors: WorkItemTypeStateColors[];
790
+ }
791
+ /**
792
+ * Enumerates the possible provisioning actions that can be triggered on process template update.
793
+ */
794
+ export declare enum ProvisioningActionType {
795
+ Import = 0,
796
+ Validate = 1
797
+ }
798
+ /**
799
+ * Result of an update work item type XML update operation.
800
+ */
801
+ export interface ProvisioningResult {
802
+ /**
803
+ * Details about of the provisioning import events.
804
+ */
805
+ provisioningImportEvents: string[];
806
+ }
807
+ /**
808
+ * Describes a request to get a list of queries
809
+ */
810
+ export interface QueryBatchGetRequest {
811
+ /**
812
+ * The expand parameters for queries. Possible options are \{ None, Wiql, Clauses, All, Minimal \}
813
+ */
814
+ $expand: QueryExpand;
815
+ /**
816
+ * The flag to control error policy in a query batch request. Possible options are \{ Fail, Omit \}.
817
+ */
818
+ errorPolicy: QueryErrorPolicy;
819
+ /**
820
+ * The requested query ids
821
+ */
822
+ ids: string[];
823
+ }
824
+ /**
825
+ * Enum to control error policy in a query batch request.
826
+ */
827
+ export declare enum QueryErrorPolicy {
828
+ Fail = 1,
829
+ Omit = 2
830
+ }
831
+ /**
832
+ * Determines which set of additional query properties to display
833
+ */
834
+ export declare enum QueryExpand {
835
+ /**
836
+ * Expands Columns, Links and ChangeInfo
837
+ */
838
+ None = 0,
839
+ /**
840
+ * Expands Columns, Links, ChangeInfo and WIQL text
841
+ */
842
+ Wiql = 1,
843
+ /**
844
+ * Expands Columns, Links, ChangeInfo, WIQL text and clauses
845
+ */
846
+ Clauses = 2,
847
+ /**
848
+ * Expands all properties
849
+ */
850
+ All = 3,
851
+ /**
852
+ * Displays minimal properties and the WIQL text
853
+ */
854
+ Minimal = 4
855
+ }
856
+ /**
857
+ * Represents an item in the work item query hierarchy. This can be either a query or a folder.
858
+ */
859
+ export interface QueryHierarchyItem extends WorkItemTrackingResource {
860
+ /**
861
+ * The child query items inside a query folder.
862
+ */
863
+ children: QueryHierarchyItem[];
864
+ /**
865
+ * The clauses for a flat query.
866
+ */
867
+ clauses: WorkItemQueryClause;
868
+ /**
869
+ * The columns of the query.
870
+ */
871
+ columns: WorkItemFieldReference[];
872
+ /**
873
+ * The identity who created the query item.
874
+ */
875
+ createdBy: IdentityReference;
876
+ /**
877
+ * When the query item was created.
878
+ */
879
+ createdDate: Date;
880
+ /**
881
+ * The link query mode.
882
+ */
883
+ filterOptions: LinkQueryMode;
884
+ /**
885
+ * If this is a query folder, indicates if it contains any children.
886
+ */
887
+ hasChildren: boolean;
888
+ /**
889
+ * The id of the query item.
890
+ */
891
+ id: string;
892
+ /**
893
+ * Indicates if this query item is deleted. Setting this to false on a deleted query item will undelete it. Undeleting a query or folder will not bring back the permission changes that were previously applied to it.
894
+ */
895
+ isDeleted: boolean;
896
+ /**
897
+ * Indicates if this is a query folder or a query.
898
+ */
899
+ isFolder: boolean;
900
+ /**
901
+ * Indicates if the WIQL of this query is invalid. This could be due to invalid syntax or a no longer valid area/iteration path.
902
+ */
903
+ isInvalidSyntax: boolean;
904
+ /**
905
+ * Indicates if this query item is public or private.
906
+ */
907
+ isPublic: boolean;
908
+ /**
909
+ * The identity who last ran the query.
910
+ */
911
+ lastExecutedBy: IdentityReference;
912
+ /**
913
+ * When the query was last run.
914
+ */
915
+ lastExecutedDate: Date;
916
+ /**
917
+ * The identity who last modified the query item.
918
+ */
919
+ lastModifiedBy: IdentityReference;
920
+ /**
921
+ * When the query item was last modified.
922
+ */
923
+ lastModifiedDate: Date;
924
+ /**
925
+ * The link query clause.
926
+ */
927
+ linkClauses: WorkItemQueryClause;
928
+ /**
929
+ * The name of the query item.
930
+ */
931
+ name: string;
932
+ /**
933
+ * The path of the query item.
934
+ */
935
+ path: string;
936
+ /**
937
+ * The recursion option for use in a tree query.
938
+ */
939
+ queryRecursionOption: QueryRecursionOption;
940
+ /**
941
+ * The type of query.
942
+ */
943
+ queryType: QueryType;
944
+ /**
945
+ * The sort columns of the query.
946
+ */
947
+ sortColumns: WorkItemQuerySortColumn[];
948
+ /**
949
+ * The source clauses in a tree or one-hop link query.
950
+ */
951
+ sourceClauses: WorkItemQueryClause;
952
+ /**
953
+ * The target clauses in a tree or one-hop link query.
954
+ */
955
+ targetClauses: WorkItemQueryClause;
956
+ /**
957
+ * The WIQL text of the query
958
+ */
959
+ wiql: string;
960
+ }
961
+ export interface QueryHierarchyItemsResult {
962
+ /**
963
+ * The count of items.
964
+ */
965
+ count: number;
966
+ /**
967
+ * Indicates if the max return limit was hit but there are still more items
968
+ */
969
+ hasMore: boolean;
970
+ /**
971
+ * The list of items
972
+ */
973
+ value: QueryHierarchyItem[];
974
+ }
975
+ export declare enum QueryOption {
976
+ Doing = 1,
977
+ Done = 2,
978
+ Followed = 3
979
+ }
980
+ /**
981
+ * Determines whether a tree query matches parents or children first.
982
+ */
983
+ export declare enum QueryRecursionOption {
984
+ /**
985
+ * Returns work items that satisfy the source, even if no linked work item satisfies the target and link criteria.
986
+ */
987
+ ParentFirst = 0,
988
+ /**
989
+ * Returns work items that satisfy the target criteria, even if no work item satisfies the source and link criteria.
990
+ */
991
+ ChildFirst = 1
992
+ }
993
+ /**
994
+ * The query result type
995
+ */
996
+ export declare enum QueryResultType {
997
+ /**
998
+ * A list of work items (for flat queries).
999
+ */
1000
+ WorkItem = 1,
1001
+ /**
1002
+ * A list of work item links (for OneHop and Tree queries).
1003
+ */
1004
+ WorkItemLink = 2
1005
+ }
1006
+ /**
1007
+ * The type of query.
1008
+ */
1009
+ export declare enum QueryType {
1010
+ /**
1011
+ * Gets a flat list of work items.
1012
+ */
1013
+ Flat = 1,
1014
+ /**
1015
+ * Gets a tree of work items showing their link hierarchy.
1016
+ */
1017
+ Tree = 2,
1018
+ /**
1019
+ * Gets a list of work items and their direct links.
1020
+ */
1021
+ OneHop = 3
1022
+ }
1023
+ /**
1024
+ * The reporting revision expand level.
1025
+ */
1026
+ export declare enum ReportingRevisionsExpand {
1027
+ /**
1028
+ * Default behavior.
1029
+ */
1030
+ None = 0,
1031
+ /**
1032
+ * Add fields to the response.
1033
+ */
1034
+ Fields = 1
1035
+ }
1036
+ export interface ReportingWorkItemLinksBatch extends StreamedBatch<WorkItemRelation> {
1037
+ }
1038
+ export interface ReportingWorkItemRevisionsBatch extends StreamedBatch<WorkItem> {
1039
+ }
1040
+ /**
1041
+ * The class represents the reporting work item revision filer.
1042
+ */
1043
+ export interface ReportingWorkItemRevisionsFilter {
1044
+ /**
1045
+ * A list of fields to return in work item revisions. Omit this parameter to get all reportable fields.
1046
+ */
1047
+ fields: string[];
1048
+ /**
1049
+ * Include deleted work item in the result.
1050
+ */
1051
+ includeDeleted: boolean;
1052
+ /**
1053
+ * Return an identity reference instead of a string value for identity fields.
1054
+ */
1055
+ includeIdentityRef: boolean;
1056
+ /**
1057
+ * Include only the latest version of a work item, skipping over all previous revisions of the work item.
1058
+ */
1059
+ includeLatestOnly: boolean;
1060
+ /**
1061
+ * Include tag reference instead of string value for System.Tags field
1062
+ */
1063
+ includeTagRef: boolean;
1064
+ /**
1065
+ * 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.
1066
+ */
1067
+ types: string[];
1068
+ }
1069
+ export interface SendMailBody {
1070
+ fields: string[];
1071
+ ids: number[];
1072
+ message: MailMessage;
1073
+ persistenceId: string;
1074
+ projectId: string;
1075
+ sortFields: string[];
1076
+ tempQueryId: string;
1077
+ wiql: string;
1078
+ }
1079
+ /**
1080
+ * The class describes reporting work item revision batch.
1081
+ */
1082
+ export interface StreamedBatch<T> {
1083
+ /**
1084
+ * ContinuationToken acts as a waterMark. Used while querying large results.
1085
+ */
1086
+ continuationToken: string;
1087
+ /**
1088
+ * Returns 'true' if it's last batch, 'false' otherwise.
1089
+ */
1090
+ isLastBatch: boolean;
1091
+ /**
1092
+ * The next link for the work item.
1093
+ */
1094
+ nextLink: string;
1095
+ /**
1096
+ * Values such as rel, sourceId, TargetId, ChangedDate, isActive.
1097
+ */
1098
+ values: T[];
1099
+ }
1100
+ /**
1101
+ * Enumerates types of supported xml templates used for customization.
1102
+ */
1103
+ export declare enum TemplateType {
1104
+ WorkItemType = 0,
1105
+ GlobalWorkflow = 1
1106
+ }
1107
+ /**
1108
+ * Describes a request to create a temporary query
1109
+ */
1110
+ export interface TemporaryQueryRequestModel extends WorkItemTrackingResource {
1111
+ /**
1112
+ * The WIQL text of the temporary query
1113
+ */
1114
+ wiql: string;
1115
+ }
1116
+ /**
1117
+ * The result of a temporary query creation.
1118
+ */
1119
+ export interface TemporaryQueryResponseModel {
1120
+ /**
1121
+ * The id of the temporary query item.
1122
+ */
1123
+ id: string;
1124
+ }
1125
+ /**
1126
+ * Types of tree node structures.
1127
+ */
1128
+ export declare enum TreeNodeStructureType {
1129
+ /**
1130
+ * Area type.
1131
+ */
1132
+ Area = 0,
1133
+ /**
1134
+ * Iteration type.
1135
+ */
1136
+ Iteration = 1
1137
+ }
1138
+ /**
1139
+ * Types of tree structures groups.
1140
+ */
1141
+ export declare enum TreeStructureGroup {
1142
+ Areas = 0,
1143
+ Iterations = 1
1144
+ }
1145
+ /**
1146
+ * Describes an update request for a work item field.
1147
+ */
1148
+ export interface UpdateWorkItemField {
1149
+ /**
1150
+ * Indicates whether the user wants to restore the field.
1151
+ */
1152
+ isDeleted: boolean;
1153
+ }
1154
+ /**
1155
+ * A WIQL query
1156
+ */
1157
+ export interface Wiql {
1158
+ /**
1159
+ * The text of the WIQL query
1160
+ */
1161
+ query: string;
1162
+ }
1163
+ /**
1164
+ * A work artifact link describes an outbound artifact link type.
1165
+ */
1166
+ export interface WorkArtifactLink {
1167
+ /**
1168
+ * Target artifact type.
1169
+ */
1170
+ artifactType: string;
1171
+ /**
1172
+ * Outbound link type.
1173
+ */
1174
+ linkType: string;
1175
+ /**
1176
+ * Target tool type.
1177
+ */
1178
+ toolType: string;
1179
+ }
1180
+ /**
1181
+ * Describes a work item.
1182
+ */
1183
+ export interface WorkItem extends WorkItemTrackingResource {
1184
+ /**
1185
+ * Reference to a specific version of the comment added/edited/deleted in this revision.
1186
+ */
1187
+ commentVersionRef: WorkItemCommentVersionRef;
1188
+ /**
1189
+ * Map of field and values for the work item.
1190
+ */
1191
+ fields: {
1192
+ [key: string]: any;
1193
+ };
1194
+ /**
1195
+ * The work item ID.
1196
+ */
1197
+ id: number;
1198
+ /**
1199
+ * Dictionary describing the Format for multiline fields selected by the last edit user.
1200
+ */
1201
+ multilineFieldsFormat: {
1202
+ [key: string]: LargeTextCustomHtmlFormat;
1203
+ };
1204
+ /**
1205
+ * Relations of the work item.
1206
+ */
1207
+ relations: WorkItemRelation[];
1208
+ /**
1209
+ * Revision number of the work item.
1210
+ */
1211
+ rev: number;
1212
+ }
1213
+ /**
1214
+ * Describes a request to get a set of work items
1215
+ */
1216
+ export interface WorkItemBatchGetRequest {
1217
+ /**
1218
+ * The expand parameters for work item attributes. Possible options are \{ None, Relations, Fields, Links, All \}
1219
+ */
1220
+ $expand: WorkItemExpand;
1221
+ /**
1222
+ * AsOf UTC date time string
1223
+ */
1224
+ asOf: Date;
1225
+ /**
1226
+ * The flag to control error policy in a bulk get work items request. Possible options are \{Fail, Omit\}.
1227
+ */
1228
+ errorPolicy: WorkItemErrorPolicy;
1229
+ /**
1230
+ * The requested fields
1231
+ */
1232
+ fields: string[];
1233
+ /**
1234
+ * The requested work item ids
1235
+ */
1236
+ ids: number[];
1237
+ }
1238
+ /**
1239
+ * Defines a classification node for work item tracking.
1240
+ */
1241
+ export interface WorkItemClassificationNode extends WorkItemTrackingResource {
1242
+ /**
1243
+ * Dictionary that has node attributes like start/finish date for iteration nodes.
1244
+ */
1245
+ attributes: {
1246
+ [key: string]: any;
1247
+ };
1248
+ /**
1249
+ * List of child nodes fetched.
1250
+ */
1251
+ children: WorkItemClassificationNode[];
1252
+ /**
1253
+ * Flag that indicates if the classification node has any child nodes.
1254
+ */
1255
+ hasChildren: boolean;
1256
+ /**
1257
+ * Integer ID of the classification node.
1258
+ */
1259
+ id: number;
1260
+ /**
1261
+ * GUID ID of the classification node.
1262
+ */
1263
+ identifier: string;
1264
+ /**
1265
+ * Name of the classification node.
1266
+ */
1267
+ name: string;
1268
+ /**
1269
+ * Path of the classification node.
1270
+ */
1271
+ path: string;
1272
+ /**
1273
+ * Node structure type.
1274
+ */
1275
+ structureType: TreeNodeStructureType;
1276
+ }
1277
+ /**
1278
+ * Comment on Work Item
1279
+ */
1280
+ export interface WorkItemComment extends WorkItemTrackingResource {
1281
+ /**
1282
+ * Represents the possible types for the comment format.
1283
+ */
1284
+ format: CommentFormat;
1285
+ /**
1286
+ * The text of the comment in HTML format.
1287
+ */
1288
+ renderedText: string;
1289
+ /**
1290
+ * Identity of user who added the comment.
1291
+ */
1292
+ revisedBy: IdentityReference;
1293
+ /**
1294
+ * The date of comment.
1295
+ */
1296
+ revisedDate: Date;
1297
+ /**
1298
+ * The work item revision number.
1299
+ */
1300
+ revision: number;
1301
+ /**
1302
+ * The text of the comment.
1303
+ */
1304
+ text: string;
1305
+ }
1306
+ /**
1307
+ * Collection of comments.
1308
+ */
1309
+ export interface WorkItemComments extends WorkItemTrackingResource {
1310
+ /**
1311
+ * Comments collection.
1312
+ */
1313
+ comments: WorkItemComment[];
1314
+ /**
1315
+ * The count of comments.
1316
+ */
1317
+ count: number;
1318
+ /**
1319
+ * Count of comments from the revision.
1320
+ */
1321
+ fromRevisionCount: number;
1322
+ /**
1323
+ * Total count of comments.
1324
+ */
1325
+ totalCount: number;
1326
+ }
1327
+ /**
1328
+ * Represents the reference to a specific version of a comment on a Work Item.
1329
+ */
1330
+ export interface WorkItemCommentVersionRef extends WorkItemTrackingResourceReference {
1331
+ /**
1332
+ * The id assigned to the comment.
1333
+ */
1334
+ commentId: number;
1335
+ /**
1336
+ * [Internal] The work item revision where this comment was originally added.
1337
+ */
1338
+ createdInRevision: number;
1339
+ /**
1340
+ * [Internal] Specifies whether comment was deleted.
1341
+ */
1342
+ isDeleted: boolean;
1343
+ /**
1344
+ * [Internal] The text of the comment.
1345
+ */
1346
+ text: string;
1347
+ /**
1348
+ * The version number.
1349
+ */
1350
+ version: number;
1351
+ }
1352
+ /**
1353
+ * Full deleted work item object. Includes the work item itself.
1354
+ */
1355
+ export interface WorkItemDelete extends WorkItemDeleteReference {
1356
+ /**
1357
+ * The work item object that was deleted.
1358
+ */
1359
+ resource: WorkItem;
1360
+ }
1361
+ /**
1362
+ * Describes response to delete a set of work items.
1363
+ */
1364
+ export interface WorkItemDeleteBatch {
1365
+ /**
1366
+ * List of results for each work item
1367
+ */
1368
+ results: WorkItemDelete[];
1369
+ }
1370
+ /**
1371
+ * Describes a request to delete a set of work items
1372
+ */
1373
+ export interface WorkItemDeleteBatchRequest {
1374
+ /**
1375
+ * Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
1376
+ */
1377
+ destroy: boolean;
1378
+ /**
1379
+ * The requested work item ids
1380
+ */
1381
+ ids: number[];
1382
+ /**
1383
+ * Optional parameter, if set to true, notifications will be disabled.
1384
+ */
1385
+ skipNotifications: boolean;
1386
+ }
1387
+ /**
1388
+ * Reference to a deleted work item.
1389
+ */
1390
+ export interface WorkItemDeleteReference {
1391
+ /**
1392
+ * The HTTP status code for work item operation in a batch request.
1393
+ */
1394
+ code: number;
1395
+ /**
1396
+ * The user who deleted the work item type.
1397
+ */
1398
+ deletedBy: string;
1399
+ /**
1400
+ * The work item deletion date.
1401
+ */
1402
+ deletedDate: string;
1403
+ /**
1404
+ * Work item ID.
1405
+ */
1406
+ id: number;
1407
+ /**
1408
+ * The exception message for work item operation in a batch request.
1409
+ */
1410
+ message: string;
1411
+ /**
1412
+ * Name or title of the work item.
1413
+ */
1414
+ name: string;
1415
+ /**
1416
+ * Parent project of the deleted work item.
1417
+ */
1418
+ project: string;
1419
+ /**
1420
+ * Type of work item.
1421
+ */
1422
+ type: string;
1423
+ /**
1424
+ * REST API URL of the resource
1425
+ */
1426
+ url: string;
1427
+ }
1428
+ /**
1429
+ * Shallow Reference to a deleted work item.
1430
+ */
1431
+ export interface WorkItemDeleteShallowReference {
1432
+ /**
1433
+ * Work item ID.
1434
+ */
1435
+ id: number;
1436
+ /**
1437
+ * REST API URL of the resource
1438
+ */
1439
+ url: string;
1440
+ }
1441
+ /**
1442
+ * Describes an update request for a deleted work item.
1443
+ */
1444
+ export interface WorkItemDeleteUpdate {
1445
+ /**
1446
+ * Sets a value indicating whether this work item is deleted.
1447
+ */
1448
+ isDeleted: boolean;
1449
+ }
1450
+ /**
1451
+ * Enum to control error policy in a bulk get work items request.
1452
+ */
1453
+ export declare enum WorkItemErrorPolicy {
1454
+ /**
1455
+ * Fail work error policy.
1456
+ */
1457
+ Fail = 1,
1458
+ /**
1459
+ * Omit work error policy.
1460
+ */
1461
+ Omit = 2
1462
+ }
1463
+ /**
1464
+ * Flag to control payload properties from get work item command.
1465
+ */
1466
+ export declare enum WorkItemExpand {
1467
+ /**
1468
+ * Default behavior.
1469
+ */
1470
+ None = 0,
1471
+ /**
1472
+ * Relations work item expand.
1473
+ */
1474
+ Relations = 1,
1475
+ /**
1476
+ * Fields work item expand.
1477
+ */
1478
+ Fields = 2,
1479
+ /**
1480
+ * Links work item expand.
1481
+ */
1482
+ Links = 3,
1483
+ /**
1484
+ * Expands all.
1485
+ */
1486
+ All = 4
1487
+ }
1488
+ /**
1489
+ * Describes a field on a work item and it's properties specific to that work item type.
1490
+ */
1491
+ export interface WorkItemField extends WorkItemTrackingResource {
1492
+ /**
1493
+ * Indicates whether the field is sortable in server queries.
1494
+ */
1495
+ canSortBy: boolean;
1496
+ /**
1497
+ * The description of the field.
1498
+ */
1499
+ description: string;
1500
+ /**
1501
+ * Indicates whether this field is deleted.
1502
+ */
1503
+ isDeleted: boolean;
1504
+ /**
1505
+ * Indicates whether this field is an identity field.
1506
+ */
1507
+ isIdentity: boolean;
1508
+ /**
1509
+ * Indicates whether this instance is picklist.
1510
+ */
1511
+ isPicklist: boolean;
1512
+ /**
1513
+ * Indicates whether this instance is a suggested picklist .
1514
+ */
1515
+ isPicklistSuggested: boolean;
1516
+ /**
1517
+ * Indicates whether the field can be queried in the server.
1518
+ */
1519
+ isQueryable: boolean;
1520
+ /**
1521
+ * The name of the field.
1522
+ */
1523
+ name: string;
1524
+ /**
1525
+ * If this field is picklist, the identifier of the picklist associated, otherwise null
1526
+ */
1527
+ picklistId: string;
1528
+ /**
1529
+ * Indicates whether the field is [read only].
1530
+ */
1531
+ readOnly: boolean;
1532
+ /**
1533
+ * The reference name of the field.
1534
+ */
1535
+ referenceName: string;
1536
+ /**
1537
+ * The supported operations on this field.
1538
+ */
1539
+ supportedOperations: WorkItemFieldOperation[];
1540
+ /**
1541
+ * The type of the field.
1542
+ */
1543
+ type: FieldType;
1544
+ /**
1545
+ * The usage of the field.
1546
+ */
1547
+ usage: FieldUsage;
1548
+ }
1549
+ /**
1550
+ * Describes a field on a work item and it's properties specific to that work item type.
1551
+ */
1552
+ export interface WorkItemField2 extends WorkItemField {
1553
+ /**
1554
+ * Indicates whether this field is marked as locked for editing.
1555
+ */
1556
+ isLocked: boolean;
1557
+ }
1558
+ /**
1559
+ * Describes the list of allowed values of the field.
1560
+ */
1561
+ export interface WorkItemFieldAllowedValues {
1562
+ /**
1563
+ * The list of field allowed values.
1564
+ */
1565
+ allowedValues: string[];
1566
+ /**
1567
+ * Name of the field.
1568
+ */
1569
+ fieldName: string;
1570
+ }
1571
+ /**
1572
+ * Describes a work item field operation.
1573
+ */
1574
+ export interface WorkItemFieldOperation {
1575
+ /**
1576
+ * Friendly name of the operation.
1577
+ */
1578
+ name: string;
1579
+ /**
1580
+ * Reference name of the operation.
1581
+ */
1582
+ referenceName: string;
1583
+ }
1584
+ /**
1585
+ * Reference to a field in a work item
1586
+ */
1587
+ export interface WorkItemFieldReference {
1588
+ /**
1589
+ * The friendly name of the field.
1590
+ */
1591
+ name: string;
1592
+ /**
1593
+ * The reference name of the field.
1594
+ */
1595
+ referenceName: string;
1596
+ /**
1597
+ * The REST URL of the resource.
1598
+ */
1599
+ url: string;
1600
+ }
1601
+ /**
1602
+ * Describes an update to a work item field.
1603
+ */
1604
+ export interface WorkItemFieldUpdate {
1605
+ /**
1606
+ * The new value of the field.
1607
+ */
1608
+ newValue: any;
1609
+ /**
1610
+ * The old value of the field.
1611
+ */
1612
+ oldValue: any;
1613
+ }
1614
+ export interface WorkItemHistory extends WorkItemTrackingResource {
1615
+ rev: number;
1616
+ revisedBy: IdentityReference;
1617
+ revisedDate: Date;
1618
+ value: string;
1619
+ }
1620
+ /**
1621
+ * Reference to a work item icon.
1622
+ */
1623
+ export interface WorkItemIcon {
1624
+ /**
1625
+ * The identifier of the icon.
1626
+ */
1627
+ id: string;
1628
+ /**
1629
+ * The REST URL of the resource.
1630
+ */
1631
+ url: string;
1632
+ }
1633
+ /**
1634
+ * A link between two work items.
1635
+ */
1636
+ export interface WorkItemLink {
1637
+ /**
1638
+ * The type of link.
1639
+ */
1640
+ rel: string;
1641
+ /**
1642
+ * The source work item.
1643
+ */
1644
+ source: WorkItemReference;
1645
+ /**
1646
+ * The target work item.
1647
+ */
1648
+ target: WorkItemReference;
1649
+ }
1650
+ /**
1651
+ * Describes the next state for a work item.
1652
+ */
1653
+ export interface WorkItemNextStateOnTransition {
1654
+ /**
1655
+ * Error code if there is no next state transition possible.
1656
+ */
1657
+ errorCode: string;
1658
+ /**
1659
+ * Work item ID.
1660
+ */
1661
+ id: number;
1662
+ /**
1663
+ * Error message if there is no next state transition possible.
1664
+ */
1665
+ message: string;
1666
+ /**
1667
+ * Name of the next state on transition.
1668
+ */
1669
+ stateOnTransition: string;
1670
+ }
1671
+ /**
1672
+ * Represents a clause in a work item query. This shows the structure of a work item query.
1673
+ */
1674
+ export interface WorkItemQueryClause {
1675
+ /**
1676
+ * Child clauses if the current clause is a logical operator
1677
+ */
1678
+ clauses: WorkItemQueryClause[];
1679
+ /**
1680
+ * Field associated with condition
1681
+ */
1682
+ field: WorkItemFieldReference;
1683
+ /**
1684
+ * Right side of the condition when a field to field comparison
1685
+ */
1686
+ fieldValue: WorkItemFieldReference;
1687
+ /**
1688
+ * Determines if this is a field to field comparison
1689
+ */
1690
+ isFieldValue: boolean;
1691
+ /**
1692
+ * Logical operator separating the condition clause
1693
+ */
1694
+ logicalOperator: LogicalOperation;
1695
+ /**
1696
+ * The field operator
1697
+ */
1698
+ operator: WorkItemFieldOperation;
1699
+ /**
1700
+ * Right side of the condition when a field to value comparison
1701
+ */
1702
+ value: string;
1703
+ }
1704
+ /**
1705
+ * The result of a work item query.
1706
+ */
1707
+ export interface WorkItemQueryResult {
1708
+ /**
1709
+ * The date the query was run in the context of.
1710
+ */
1711
+ asOf: Date;
1712
+ /**
1713
+ * The columns of the query.
1714
+ */
1715
+ columns: WorkItemFieldReference[];
1716
+ /**
1717
+ * The result type
1718
+ */
1719
+ queryResultType: QueryResultType;
1720
+ /**
1721
+ * The type of the query
1722
+ */
1723
+ queryType: QueryType;
1724
+ /**
1725
+ * The sort columns of the query.
1726
+ */
1727
+ sortColumns: WorkItemQuerySortColumn[];
1728
+ /**
1729
+ * The work item links returned by the query.
1730
+ */
1731
+ workItemRelations: WorkItemLink[];
1732
+ /**
1733
+ * The work items returned by the query.
1734
+ */
1735
+ workItems: WorkItemReference[];
1736
+ }
1737
+ /**
1738
+ * A sort column.
1739
+ */
1740
+ export interface WorkItemQuerySortColumn {
1741
+ /**
1742
+ * The direction to sort by.
1743
+ */
1744
+ descending: boolean;
1745
+ /**
1746
+ * A work item field.
1747
+ */
1748
+ field: WorkItemFieldReference;
1749
+ }
1750
+ /**
1751
+ * Type of the activity
1752
+ */
1753
+ export declare enum WorkItemRecentActivityType {
1754
+ Visited = 0,
1755
+ Edited = 1,
1756
+ Deleted = 2,
1757
+ Restored = 3
1758
+ }
1759
+ /**
1760
+ * Contains reference to a work item.
1761
+ */
1762
+ export interface WorkItemReference {
1763
+ /**
1764
+ * Work item ID.
1765
+ */
1766
+ id: number;
1767
+ /**
1768
+ * REST API URL of the resource
1769
+ */
1770
+ url: string;
1771
+ }
1772
+ export interface WorkItemRelation extends Link {
1773
+ }
1774
+ /**
1775
+ * Represents the work item type relation type.
1776
+ */
1777
+ export interface WorkItemRelationType extends WorkItemTrackingReference {
1778
+ /**
1779
+ * The collection of relation type attributes.
1780
+ */
1781
+ attributes: {
1782
+ [key: string]: any;
1783
+ };
1784
+ }
1785
+ /**
1786
+ * Describes updates to a work item's relations.
1787
+ */
1788
+ export interface WorkItemRelationUpdates {
1789
+ /**
1790
+ * List of newly added relations.
1791
+ */
1792
+ added: WorkItemRelation[];
1793
+ /**
1794
+ * List of removed relations.
1795
+ */
1796
+ removed: WorkItemRelation[];
1797
+ /**
1798
+ * List of updated relations.
1799
+ */
1800
+ updated: WorkItemRelation[];
1801
+ }
1802
+ /**
1803
+ * Work item type state name, color and state category
1804
+ */
1805
+ export interface WorkItemStateColor {
1806
+ /**
1807
+ * Category of state
1808
+ */
1809
+ category: string;
1810
+ /**
1811
+ * Color value
1812
+ */
1813
+ color: string;
1814
+ /**
1815
+ * Work item type state name
1816
+ */
1817
+ name: string;
1818
+ }
1819
+ /**
1820
+ * Describes a state transition in a work item.
1821
+ */
1822
+ export interface WorkItemStateTransition {
1823
+ /**
1824
+ * Gets a list of actions needed to transition to that state.
1825
+ */
1826
+ actions: string[];
1827
+ /**
1828
+ * Name of the next state.
1829
+ */
1830
+ to: string;
1831
+ }
1832
+ export interface WorkItemTagDefinition {
1833
+ id: string;
1834
+ lastUpdated: Date;
1835
+ name: string;
1836
+ url: string;
1837
+ }
1838
+ /**
1839
+ * Describes a work item template.
1840
+ */
1841
+ export interface WorkItemTemplate extends WorkItemTemplateReference {
1842
+ /**
1843
+ * Mapping of field and its templated value.
1844
+ */
1845
+ fields: {
1846
+ [key: string]: string;
1847
+ };
1848
+ }
1849
+ /**
1850
+ * Describes a shallow reference to a work item template.
1851
+ */
1852
+ export interface WorkItemTemplateReference extends WorkItemTrackingResource {
1853
+ /**
1854
+ * The description of the work item template.
1855
+ */
1856
+ description: string;
1857
+ /**
1858
+ * The identifier of the work item template.
1859
+ */
1860
+ id: string;
1861
+ /**
1862
+ * The name of the work item template.
1863
+ */
1864
+ name: string;
1865
+ /**
1866
+ * The name of the work item type.
1867
+ */
1868
+ workItemTypeName: string;
1869
+ }
1870
+ export interface WorkItemTrackingReference extends WorkItemTrackingResource {
1871
+ /**
1872
+ * The name.
1873
+ */
1874
+ name: string;
1875
+ /**
1876
+ * The reference name.
1877
+ */
1878
+ referenceName: string;
1879
+ }
1880
+ /**
1881
+ * Base class for WIT REST resources.
1882
+ */
1883
+ export interface WorkItemTrackingResource extends WorkItemTrackingResourceReference {
1884
+ /**
1885
+ * Link references to related REST resources.
1886
+ */
1887
+ _links: any;
1888
+ }
1889
+ /**
1890
+ * Base class for work item tracking resource references.
1891
+ */
1892
+ export interface WorkItemTrackingResourceReference {
1893
+ /**
1894
+ * REST URL for the resource.
1895
+ */
1896
+ url: string;
1897
+ }
1898
+ /**
1899
+ * Describes a work item type.
1900
+ */
1901
+ export interface WorkItemType extends WorkItemTrackingResource {
1902
+ /**
1903
+ * The color.
1904
+ */
1905
+ color: string;
1906
+ /**
1907
+ * The description of the work item type.
1908
+ */
1909
+ description: string;
1910
+ /**
1911
+ * The fields that exist on the work item type.
1912
+ */
1913
+ fieldInstances: WorkItemTypeFieldInstance[];
1914
+ /**
1915
+ * The fields that exist on the work item type.
1916
+ */
1917
+ fields: WorkItemTypeFieldInstance[];
1918
+ /**
1919
+ * The icon of the work item type.
1920
+ */
1921
+ icon: WorkItemIcon;
1922
+ /**
1923
+ * True if work item type is disabled
1924
+ */
1925
+ isDisabled: boolean;
1926
+ /**
1927
+ * Gets the name of the work item type.
1928
+ */
1929
+ name: string;
1930
+ /**
1931
+ * The reference name of the work item type.
1932
+ */
1933
+ referenceName: string;
1934
+ /**
1935
+ * Gets state information for the work item type.
1936
+ */
1937
+ states: WorkItemStateColor[];
1938
+ /**
1939
+ * Gets the various state transition mappings in the work item type.
1940
+ */
1941
+ transitions: {
1942
+ [key: string]: WorkItemStateTransition[];
1943
+ };
1944
+ /**
1945
+ * The XML form.
1946
+ */
1947
+ xmlForm: string;
1948
+ }
1949
+ /**
1950
+ * Describes a work item type category.
1951
+ */
1952
+ export interface WorkItemTypeCategory extends WorkItemTrackingResource {
1953
+ /**
1954
+ * Gets or sets the default type of the work item.
1955
+ */
1956
+ defaultWorkItemType: WorkItemTypeReference;
1957
+ /**
1958
+ * The name of the category.
1959
+ */
1960
+ name: string;
1961
+ /**
1962
+ * The reference name of the category.
1963
+ */
1964
+ referenceName: string;
1965
+ /**
1966
+ * The work item types that belong to the category.
1967
+ */
1968
+ workItemTypes: WorkItemTypeReference[];
1969
+ }
1970
+ /**
1971
+ * Describes a work item type's colors.
1972
+ */
1973
+ export interface WorkItemTypeColor {
1974
+ /**
1975
+ * Gets or sets the color of the primary.
1976
+ */
1977
+ primaryColor: string;
1978
+ /**
1979
+ * Gets or sets the color of the secondary.
1980
+ */
1981
+ secondaryColor: string;
1982
+ /**
1983
+ * The name of the work item type.
1984
+ */
1985
+ workItemTypeName: string;
1986
+ }
1987
+ /**
1988
+ * Describes work item type name, its icon and color.
1989
+ */
1990
+ export interface WorkItemTypeColorAndIcon {
1991
+ /**
1992
+ * The color of the work item type in hex format.
1993
+ */
1994
+ color: string;
1995
+ /**
1996
+ * The work item type icon.
1997
+ */
1998
+ icon: string;
1999
+ /**
2000
+ * Indicates if the work item is disabled in the process.
2001
+ */
2002
+ isDisabled: boolean;
2003
+ /**
2004
+ * The name of the work item type.
2005
+ */
2006
+ workItemTypeName: string;
2007
+ }
2008
+ /**
2009
+ * Field instance of a work item type.
2010
+ */
2011
+ export interface WorkItemTypeFieldInstance extends WorkItemTypeFieldInstanceBase {
2012
+ /**
2013
+ * The list of field allowed values.
2014
+ */
2015
+ allowedValues: string[];
2016
+ /**
2017
+ * Represents the default value of the field.
2018
+ */
2019
+ defaultValue: string;
2020
+ }
2021
+ /**
2022
+ * Base field instance for workItemType fields.
2023
+ */
2024
+ export interface WorkItemTypeFieldInstanceBase extends WorkItemFieldReference {
2025
+ /**
2026
+ * Indicates whether field value is always required.
2027
+ */
2028
+ alwaysRequired: boolean;
2029
+ /**
2030
+ * The list of dependent fields.
2031
+ */
2032
+ dependentFields: WorkItemFieldReference[];
2033
+ /**
2034
+ * Gets the help text for the field.
2035
+ */
2036
+ helpText: string;
2037
+ }
2038
+ /**
2039
+ * Expand options for the work item field(s) request.
2040
+ */
2041
+ export declare enum WorkItemTypeFieldsExpandLevel {
2042
+ /**
2043
+ * Includes only basic properties of the field.
2044
+ */
2045
+ None = 0,
2046
+ /**
2047
+ * Includes allowed values for the field.
2048
+ */
2049
+ AllowedValues = 1,
2050
+ /**
2051
+ * Includes dependent fields of the field.
2052
+ */
2053
+ DependentFields = 2,
2054
+ /**
2055
+ * Includes allowed values and dependent fields of the field.
2056
+ */
2057
+ All = 3
2058
+ }
2059
+ /**
2060
+ * Field Instance of a workItemype with detailed references.
2061
+ */
2062
+ export interface WorkItemTypeFieldWithReferences extends WorkItemTypeFieldInstanceBase {
2063
+ /**
2064
+ * The list of field allowed values.
2065
+ */
2066
+ allowedValues: any[];
2067
+ /**
2068
+ * Represents the default value of the field.
2069
+ */
2070
+ defaultValue: any;
2071
+ }
2072
+ /**
2073
+ * Reference to a work item type.
2074
+ */
2075
+ export interface WorkItemTypeReference extends WorkItemTrackingResourceReference {
2076
+ /**
2077
+ * Name of the work item type.
2078
+ */
2079
+ name: string;
2080
+ }
2081
+ /**
2082
+ * State colors for a work item type
2083
+ */
2084
+ export interface WorkItemTypeStateColors {
2085
+ /**
2086
+ * Work item type state colors
2087
+ */
2088
+ stateColors: WorkItemStateColor[];
2089
+ /**
2090
+ * Work item type name
2091
+ */
2092
+ workItemTypeName: string;
2093
+ }
2094
+ /**
2095
+ * Describes a work item type template.
2096
+ */
2097
+ export interface WorkItemTypeTemplate {
2098
+ /**
2099
+ * XML template in string format.
2100
+ */
2101
+ template: string;
2102
+ }
2103
+ /**
2104
+ * Describes a update work item type template request body.
2105
+ */
2106
+ export interface WorkItemTypeTemplateUpdateModel {
2107
+ /**
2108
+ * Describes the type of the action for the update request.
2109
+ */
2110
+ actionType: ProvisioningActionType;
2111
+ /**
2112
+ * Methodology to which the template belongs, eg. Agile, Scrum, CMMI.
2113
+ */
2114
+ methodology: string;
2115
+ /**
2116
+ * String representation of the work item type template.
2117
+ */
2118
+ template: string;
2119
+ /**
2120
+ * The type of the template described in the request body.
2121
+ */
2122
+ templateType: TemplateType;
2123
+ }
2124
+ /**
2125
+ * Describes an update to a work item.
2126
+ */
2127
+ export interface WorkItemUpdate extends WorkItemTrackingResource {
2128
+ /**
2129
+ * List of updates to fields.
2130
+ */
2131
+ fields: {
2132
+ [key: string]: WorkItemFieldUpdate;
2133
+ };
2134
+ /**
2135
+ * ID of update.
2136
+ */
2137
+ id: number;
2138
+ /**
2139
+ * List of updates to relations.
2140
+ */
2141
+ relations: WorkItemRelationUpdates;
2142
+ /**
2143
+ * The revision number of work item update.
2144
+ */
2145
+ rev: number;
2146
+ /**
2147
+ * Identity for the work item update.
2148
+ */
2149
+ revisedBy: IdentityReference;
2150
+ /**
2151
+ * The work item updates revision date.
2152
+ */
2153
+ revisedDate: Date;
2154
+ /**
2155
+ * The work item ID.
2156
+ */
2157
+ workItemId: number;
2158
+ }