@makeplane/plane-node-sdk 0.2.11 → 0.2.13

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 (325) hide show
  1. package/README.md +17 -1
  2. package/dist/api/BaseResource.d.ts +1 -1
  3. package/dist/api/BaseResource.d.ts.map +1 -1
  4. package/dist/api/BaseResource.js +18 -2
  5. package/dist/api/BaseResource.js.map +1 -1
  6. package/dist/api/Collections/Members.d.ts +31 -0
  7. package/dist/api/Collections/Members.d.ts.map +1 -0
  8. package/dist/api/Collections/Members.js +44 -0
  9. package/dist/api/Collections/Members.js.map +1 -0
  10. package/dist/api/Collections/Pages.d.ts +40 -0
  11. package/dist/api/Collections/Pages.d.ts.map +1 -0
  12. package/dist/api/Collections/Pages.js +55 -0
  13. package/dist/api/Collections/Pages.js.map +1 -0
  14. package/dist/api/Collections/index.d.ts +41 -0
  15. package/dist/api/Collections/index.d.ts.map +1 -0
  16. package/dist/api/Collections/index.js +57 -0
  17. package/dist/api/Collections/index.js.map +1 -0
  18. package/dist/api/Customers/Properties.d.ts +10 -1
  19. package/dist/api/Customers/Properties.d.ts.map +1 -1
  20. package/dist/api/Customers/Properties.js +11 -0
  21. package/dist/api/Customers/Properties.js.map +1 -1
  22. package/dist/api/Customers/index.d.ts +6 -0
  23. package/dist/api/Customers/index.d.ts.map +1 -1
  24. package/dist/api/Customers/index.js +11 -0
  25. package/dist/api/Customers/index.js.map +1 -1
  26. package/dist/api/Cycles.d.ts +12 -4
  27. package/dist/api/Cycles.d.ts.map +1 -1
  28. package/dist/api/Cycles.js +14 -3
  29. package/dist/api/Cycles.js.map +1 -1
  30. package/dist/api/Epics.d.ts +21 -1
  31. package/dist/api/Epics.d.ts.map +1 -1
  32. package/dist/api/Epics.js +30 -0
  33. package/dist/api/Epics.js.map +1 -1
  34. package/dist/api/Estimates.d.ts +50 -0
  35. package/dist/api/Estimates.d.ts.map +1 -0
  36. package/dist/api/Estimates.js +73 -0
  37. package/dist/api/Estimates.js.map +1 -0
  38. package/dist/api/Intake.d.ts +8 -1
  39. package/dist/api/Intake.d.ts.map +1 -1
  40. package/dist/api/Intake.js +9 -0
  41. package/dist/api/Intake.js.map +1 -1
  42. package/dist/api/Modules.d.ts +12 -4
  43. package/dist/api/Modules.d.ts.map +1 -1
  44. package/dist/api/Modules.js +14 -3
  45. package/dist/api/Modules.js.map +1 -1
  46. package/dist/api/Pages.d.ts +56 -1
  47. package/dist/api/Pages.d.ts.map +1 -1
  48. package/dist/api/Pages.js +74 -0
  49. package/dist/api/Pages.js.map +1 -1
  50. package/dist/api/ProjectTemplates/Pages.d.ts +27 -0
  51. package/dist/api/ProjectTemplates/Pages.d.ts.map +1 -0
  52. package/dist/api/ProjectTemplates/Pages.js +40 -0
  53. package/dist/api/ProjectTemplates/Pages.js.map +1 -0
  54. package/dist/api/ProjectTemplates/WorkItems.d.ts +27 -0
  55. package/dist/api/ProjectTemplates/WorkItems.d.ts.map +1 -0
  56. package/dist/api/ProjectTemplates/WorkItems.js +40 -0
  57. package/dist/api/ProjectTemplates/WorkItems.js.map +1 -0
  58. package/dist/api/ProjectTemplates/index.d.ts +14 -0
  59. package/dist/api/ProjectTemplates/index.d.ts.map +1 -0
  60. package/dist/api/ProjectTemplates/index.js +19 -0
  61. package/dist/api/ProjectTemplates/index.js.map +1 -0
  62. package/dist/api/Projects.d.ts +15 -4
  63. package/dist/api/Projects.d.ts.map +1 -1
  64. package/dist/api/Projects.js +18 -3
  65. package/dist/api/Projects.js.map +1 -1
  66. package/dist/api/Releases/Changelog.d.ts +19 -0
  67. package/dist/api/Releases/Changelog.d.ts.map +1 -0
  68. package/dist/api/Releases/Changelog.js +27 -0
  69. package/dist/api/Releases/Changelog.js.map +1 -0
  70. package/dist/api/Releases/Comments.d.ts +31 -0
  71. package/dist/api/Releases/Comments.d.ts.map +1 -0
  72. package/dist/api/Releases/Comments.js +46 -0
  73. package/dist/api/Releases/Comments.js.map +1 -0
  74. package/dist/api/Releases/ItemLabels.d.ts +23 -0
  75. package/dist/api/Releases/ItemLabels.d.ts.map +1 -0
  76. package/dist/api/Releases/ItemLabels.js +39 -0
  77. package/dist/api/Releases/ItemLabels.js.map +1 -0
  78. package/dist/api/Releases/Labels.d.ts +16 -0
  79. package/dist/api/Releases/Labels.d.ts.map +1 -0
  80. package/dist/api/Releases/Labels.js +31 -0
  81. package/dist/api/Releases/Labels.js.map +1 -0
  82. package/dist/api/Releases/Links.d.ts +31 -0
  83. package/dist/api/Releases/Links.d.ts.map +1 -0
  84. package/dist/api/Releases/Links.js +46 -0
  85. package/dist/api/Releases/Links.js.map +1 -0
  86. package/dist/api/Releases/Tags.d.ts +16 -0
  87. package/dist/api/Releases/Tags.d.ts.map +1 -0
  88. package/dist/api/Releases/Tags.js +31 -0
  89. package/dist/api/Releases/Tags.js.map +1 -0
  90. package/dist/api/Releases/WorkItems.d.ts +23 -0
  91. package/dist/api/Releases/WorkItems.d.ts.map +1 -0
  92. package/dist/api/Releases/WorkItems.js +38 -0
  93. package/dist/api/Releases/WorkItems.js.map +1 -0
  94. package/dist/api/Releases/index.d.ts +31 -0
  95. package/dist/api/Releases/index.d.ts.map +1 -0
  96. package/dist/api/Releases/index.js +46 -0
  97. package/dist/api/Releases/index.js.map +1 -0
  98. package/dist/api/Roles.d.ts +26 -0
  99. package/dist/api/Roles.d.ts.map +1 -0
  100. package/dist/api/Roles.js +33 -0
  101. package/dist/api/Roles.js.map +1 -0
  102. package/dist/api/Users.d.ts +5 -1
  103. package/dist/api/Users.d.ts.map +1 -1
  104. package/dist/api/Users.js +6 -0
  105. package/dist/api/Users.js.map +1 -1
  106. package/dist/api/WorkItemProperties/index.d.ts +30 -0
  107. package/dist/api/WorkItemProperties/index.d.ts.map +1 -1
  108. package/dist/api/WorkItemProperties/index.js +46 -0
  109. package/dist/api/WorkItemProperties/index.js.map +1 -1
  110. package/dist/api/WorkItemRelationDefinitions.d.ts +15 -0
  111. package/dist/api/WorkItemRelationDefinitions.d.ts.map +1 -0
  112. package/dist/api/WorkItemRelationDefinitions.js +33 -0
  113. package/dist/api/WorkItemRelationDefinitions.js.map +1 -0
  114. package/dist/api/WorkItemTypeGovernance/Pins.d.ts +26 -0
  115. package/dist/api/WorkItemTypeGovernance/Pins.d.ts.map +1 -0
  116. package/dist/api/WorkItemTypeGovernance/Pins.js +38 -0
  117. package/dist/api/WorkItemTypeGovernance/Pins.js.map +1 -0
  118. package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts +37 -0
  119. package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts.map +1 -0
  120. package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js +56 -0
  121. package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js.map +1 -0
  122. package/dist/api/WorkItemTypeGovernance/index.d.ts +36 -0
  123. package/dist/api/WorkItemTypeGovernance/index.d.ts.map +1 -0
  124. package/dist/api/WorkItemTypeGovernance/index.js +50 -0
  125. package/dist/api/WorkItemTypeGovernance/index.js.map +1 -0
  126. package/dist/api/WorkItemTypes.d.ts +7 -0
  127. package/dist/api/WorkItemTypes.d.ts.map +1 -1
  128. package/dist/api/WorkItemTypes.js +11 -0
  129. package/dist/api/WorkItemTypes.js.map +1 -1
  130. package/dist/api/WorkItems/CustomRelations.d.ts +29 -0
  131. package/dist/api/WorkItems/CustomRelations.d.ts.map +1 -0
  132. package/dist/api/WorkItems/CustomRelations.js +39 -0
  133. package/dist/api/WorkItems/CustomRelations.js.map +1 -0
  134. package/dist/api/WorkItems/Dependencies.d.ts +24 -0
  135. package/dist/api/WorkItems/Dependencies.d.ts.map +1 -0
  136. package/dist/api/WorkItems/Dependencies.js +34 -0
  137. package/dist/api/WorkItems/Dependencies.js.map +1 -0
  138. package/dist/api/WorkItems/Pages.d.ts +28 -0
  139. package/dist/api/WorkItems/Pages.d.ts.map +1 -0
  140. package/dist/api/WorkItems/Pages.js +39 -0
  141. package/dist/api/WorkItems/Pages.js.map +1 -0
  142. package/dist/api/WorkItems/index.d.ts +65 -2
  143. package/dist/api/WorkItems/index.d.ts.map +1 -1
  144. package/dist/api/WorkItems/index.js +83 -2
  145. package/dist/api/WorkItems/index.js.map +1 -1
  146. package/dist/api/Workflows/Hooks.d.ts +34 -0
  147. package/dist/api/Workflows/Hooks.d.ts.map +1 -0
  148. package/dist/api/Workflows/Hooks.js +52 -0
  149. package/dist/api/Workflows/Hooks.js.map +1 -0
  150. package/dist/api/Workflows/States.d.ts +31 -0
  151. package/dist/api/Workflows/States.d.ts.map +1 -0
  152. package/dist/api/Workflows/States.js +47 -0
  153. package/dist/api/Workflows/States.js.map +1 -0
  154. package/dist/api/Workflows/Transitions.d.ts +32 -0
  155. package/dist/api/Workflows/Transitions.d.ts.map +1 -0
  156. package/dist/api/Workflows/Transitions.js +67 -0
  157. package/dist/api/Workflows/Transitions.js.map +1 -0
  158. package/dist/api/Workflows/index.d.ts +54 -0
  159. package/dist/api/Workflows/index.d.ts.map +1 -0
  160. package/dist/api/Workflows/index.js +71 -0
  161. package/dist/api/Workflows/index.js.map +1 -0
  162. package/dist/api/Workspace.d.ts +16 -3
  163. package/dist/api/Workspace.d.ts.map +1 -1
  164. package/dist/api/Workspace.js +17 -1
  165. package/dist/api/Workspace.js.map +1 -1
  166. package/dist/api/WorkspaceProjectLabels.d.ts +15 -0
  167. package/dist/api/WorkspaceProjectLabels.d.ts.map +1 -0
  168. package/dist/api/WorkspaceProjectLabels.js +28 -0
  169. package/dist/api/WorkspaceProjectLabels.js.map +1 -0
  170. package/dist/api/WorkspaceProjectStates.d.ts +15 -0
  171. package/dist/api/WorkspaceProjectStates.d.ts.map +1 -0
  172. package/dist/api/WorkspaceProjectStates.js +28 -0
  173. package/dist/api/WorkspaceProjectStates.js.map +1 -0
  174. package/dist/api/WorkspaceStates.d.ts +55 -0
  175. package/dist/api/WorkspaceStates.d.ts.map +1 -0
  176. package/dist/api/WorkspaceStates.js +73 -0
  177. package/dist/api/WorkspaceStates.js.map +1 -0
  178. package/dist/api/WorkspaceTemplates/Pages.d.ts +15 -0
  179. package/dist/api/WorkspaceTemplates/Pages.d.ts.map +1 -0
  180. package/dist/api/WorkspaceTemplates/Pages.js +28 -0
  181. package/dist/api/WorkspaceTemplates/Pages.js.map +1 -0
  182. package/dist/api/WorkspaceTemplates/Projects.d.ts +15 -0
  183. package/dist/api/WorkspaceTemplates/Projects.d.ts.map +1 -0
  184. package/dist/api/WorkspaceTemplates/Projects.js +28 -0
  185. package/dist/api/WorkspaceTemplates/Projects.js.map +1 -0
  186. package/dist/api/WorkspaceTemplates/WorkItems.d.ts +15 -0
  187. package/dist/api/WorkspaceTemplates/WorkItems.d.ts.map +1 -0
  188. package/dist/api/WorkspaceTemplates/WorkItems.js +28 -0
  189. package/dist/api/WorkspaceTemplates/WorkItems.js.map +1 -0
  190. package/dist/api/WorkspaceTemplates/index.d.ts +16 -0
  191. package/dist/api/WorkspaceTemplates/index.d.ts.map +1 -0
  192. package/dist/api/WorkspaceTemplates/index.js +21 -0
  193. package/dist/api/WorkspaceTemplates/index.js.map +1 -0
  194. package/dist/api/WorkspaceWorkItemProperties/Options.d.ts +16 -0
  195. package/dist/api/WorkspaceWorkItemProperties/Options.d.ts.map +1 -0
  196. package/dist/api/WorkspaceWorkItemProperties/Options.js +31 -0
  197. package/dist/api/WorkspaceWorkItemProperties/Options.js.map +1 -0
  198. package/dist/api/WorkspaceWorkItemProperties/index.d.ts +18 -0
  199. package/dist/api/WorkspaceWorkItemProperties/index.d.ts.map +1 -0
  200. package/dist/api/WorkspaceWorkItemProperties/index.js +33 -0
  201. package/dist/api/WorkspaceWorkItemProperties/index.js.map +1 -0
  202. package/dist/api/WorkspaceWorkItemTypes/Properties.d.ts +15 -0
  203. package/dist/api/WorkspaceWorkItemTypes/Properties.d.ts.map +1 -0
  204. package/dist/api/WorkspaceWorkItemTypes/Properties.js +25 -0
  205. package/dist/api/WorkspaceWorkItemTypes/Properties.js.map +1 -0
  206. package/dist/api/WorkspaceWorkItemTypes/index.d.ts +18 -0
  207. package/dist/api/WorkspaceWorkItemTypes/index.d.ts.map +1 -0
  208. package/dist/api/WorkspaceWorkItemTypes/index.js +33 -0
  209. package/dist/api/WorkspaceWorkItemTypes/index.js.map +1 -0
  210. package/dist/api/WorkspaceWorkflows/Hooks.d.ts +56 -0
  211. package/dist/api/WorkspaceWorkflows/Hooks.d.ts.map +1 -0
  212. package/dist/api/WorkspaceWorkflows/Hooks.js +65 -0
  213. package/dist/api/WorkspaceWorkflows/Hooks.js.map +1 -0
  214. package/dist/api/WorkspaceWorkflows/States.d.ts +34 -0
  215. package/dist/api/WorkspaceWorkflows/States.d.ts.map +1 -0
  216. package/dist/api/WorkspaceWorkflows/States.js +47 -0
  217. package/dist/api/WorkspaceWorkflows/States.js.map +1 -0
  218. package/dist/api/WorkspaceWorkflows/Transitions.d.ts +31 -0
  219. package/dist/api/WorkspaceWorkflows/Transitions.d.ts.map +1 -0
  220. package/dist/api/WorkspaceWorkflows/Transitions.js +46 -0
  221. package/dist/api/WorkspaceWorkflows/Transitions.js.map +1 -0
  222. package/dist/api/WorkspaceWorkflows/index.d.ts +67 -0
  223. package/dist/api/WorkspaceWorkflows/index.d.ts.map +1 -0
  224. package/dist/api/WorkspaceWorkflows/index.js +73 -0
  225. package/dist/api/WorkspaceWorkflows/index.js.map +1 -0
  226. package/dist/client/plane-client.d.ts +30 -2
  227. package/dist/client/plane-client.d.ts.map +1 -1
  228. package/dist/client/plane-client.js +30 -2
  229. package/dist/client/plane-client.js.map +1 -1
  230. package/dist/index.d.ts +42 -1
  231. package/dist/index.d.ts.map +1 -1
  232. package/dist/index.js +86 -3
  233. package/dist/index.js.map +1 -1
  234. package/dist/models/Collection.d.ts +147 -0
  235. package/dist/models/Collection.d.ts.map +1 -0
  236. package/dist/models/Collection.js +19 -0
  237. package/dist/models/Collection.js.map +1 -0
  238. package/dist/models/Customer.d.ts +9 -0
  239. package/dist/models/Customer.d.ts.map +1 -1
  240. package/dist/models/Cycle.d.ts +25 -0
  241. package/dist/models/Cycle.d.ts.map +1 -1
  242. package/dist/models/Epic.d.ts +54 -0
  243. package/dist/models/Epic.d.ts.map +1 -1
  244. package/dist/models/Estimate.d.ts +72 -0
  245. package/dist/models/Estimate.d.ts.map +1 -0
  246. package/dist/models/Estimate.js +7 -0
  247. package/dist/models/Estimate.js.map +1 -0
  248. package/dist/models/Initiative.d.ts +4 -2
  249. package/dist/models/Initiative.d.ts.map +1 -1
  250. package/dist/models/Intake.d.ts +8 -0
  251. package/dist/models/Intake.d.ts.map +1 -1
  252. package/dist/models/Member.d.ts +54 -0
  253. package/dist/models/Member.d.ts.map +1 -0
  254. package/dist/models/Member.js +3 -0
  255. package/dist/models/Member.js.map +1 -0
  256. package/dist/models/Module.d.ts +21 -0
  257. package/dist/models/Module.d.ts.map +1 -1
  258. package/dist/models/Page.d.ts +27 -1
  259. package/dist/models/Page.d.ts.map +1 -1
  260. package/dist/models/Project.d.ts +27 -0
  261. package/dist/models/Project.d.ts.map +1 -1
  262. package/dist/models/ProjectTemplate.d.ts +25 -0
  263. package/dist/models/ProjectTemplate.d.ts.map +1 -0
  264. package/dist/models/ProjectTemplate.js +3 -0
  265. package/dist/models/ProjectTemplate.js.map +1 -0
  266. package/dist/models/Release.d.ts +157 -0
  267. package/dist/models/Release.d.ts.map +1 -0
  268. package/dist/models/Release.js +3 -0
  269. package/dist/models/Release.js.map +1 -0
  270. package/dist/models/Role.d.ts +31 -0
  271. package/dist/models/Role.d.ts.map +1 -0
  272. package/dist/models/Role.js +11 -0
  273. package/dist/models/Role.js.map +1 -0
  274. package/dist/models/State.d.ts +31 -0
  275. package/dist/models/State.d.ts.map +1 -1
  276. package/dist/models/User.d.ts +23 -0
  277. package/dist/models/User.d.ts.map +1 -1
  278. package/dist/models/WorkItem.d.ts +102 -0
  279. package/dist/models/WorkItem.d.ts.map +1 -1
  280. package/dist/models/WorkItemPage.d.ts +37 -0
  281. package/dist/models/WorkItemPage.d.ts.map +1 -0
  282. package/dist/models/WorkItemPage.js +3 -0
  283. package/dist/models/WorkItemPage.js.map +1 -0
  284. package/dist/models/WorkItemRelationDefinition.d.ts +21 -0
  285. package/dist/models/WorkItemRelationDefinition.d.ts.map +1 -0
  286. package/dist/models/WorkItemRelationDefinition.js +3 -0
  287. package/dist/models/WorkItemRelationDefinition.js.map +1 -0
  288. package/dist/models/WorkItemType.d.ts +6 -0
  289. package/dist/models/WorkItemType.d.ts.map +1 -1
  290. package/dist/models/WorkItemTypeGovernance.d.ts +130 -0
  291. package/dist/models/WorkItemTypeGovernance.d.ts.map +1 -0
  292. package/dist/models/WorkItemTypeGovernance.js +3 -0
  293. package/dist/models/WorkItemTypeGovernance.js.map +1 -0
  294. package/dist/models/Workflow.d.ts +92 -0
  295. package/dist/models/Workflow.d.ts.map +1 -0
  296. package/dist/models/Workflow.js +3 -0
  297. package/dist/models/Workflow.js.map +1 -0
  298. package/dist/models/WorkspaceFeatures.d.ts +18 -7
  299. package/dist/models/WorkspaceFeatures.d.ts.map +1 -1
  300. package/dist/models/WorkspaceProjectLabel.d.ts +13 -0
  301. package/dist/models/WorkspaceProjectLabel.d.ts.map +1 -0
  302. package/dist/models/WorkspaceProjectLabel.js +3 -0
  303. package/dist/models/WorkspaceProjectLabel.js.map +1 -0
  304. package/dist/models/WorkspaceProjectState.d.ts +16 -0
  305. package/dist/models/WorkspaceProjectState.d.ts.map +1 -0
  306. package/dist/models/WorkspaceProjectState.js +3 -0
  307. package/dist/models/WorkspaceProjectState.js.map +1 -0
  308. package/dist/models/WorkspaceTemplate.d.ts +35 -0
  309. package/dist/models/WorkspaceTemplate.d.ts.map +1 -0
  310. package/dist/models/WorkspaceTemplate.js +3 -0
  311. package/dist/models/WorkspaceTemplate.js.map +1 -0
  312. package/dist/models/WorkspaceWorkflow.d.ts +145 -0
  313. package/dist/models/WorkspaceWorkflow.d.ts.map +1 -0
  314. package/dist/models/WorkspaceWorkflow.js +3 -0
  315. package/dist/models/WorkspaceWorkflow.js.map +1 -0
  316. package/dist/models/index.d.ts +14 -0
  317. package/dist/models/index.d.ts.map +1 -1
  318. package/dist/models/index.js +14 -0
  319. package/dist/models/index.js.map +1 -1
  320. package/dist/types.bundle.d.ts +3042 -539
  321. package/package.json +4 -10
  322. package/dist/api/Members.d.ts +0 -56
  323. package/dist/api/Members.d.ts.map +0 -1
  324. package/dist/api/Members.js +0 -45
  325. package/dist/api/Members.js.map +0 -1
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.WorkItems = void 0;
4
+ exports.prepareWorkItemParams = prepareWorkItemParams;
4
5
  const BaseResource_1 = require("../BaseResource");
5
6
  const Links_1 = require("../Links");
6
7
  const Relations_1 = require("./Relations");
@@ -8,6 +9,28 @@ const Attachments_1 = require("./Attachments");
8
9
  const Comments_1 = require("./Comments");
9
10
  const Activities_1 = require("./Activities");
10
11
  const WorkLogs_1 = require("./WorkLogs");
12
+ const Dependencies_1 = require("./Dependencies");
13
+ const CustomRelations_1 = require("./CustomRelations");
14
+ const Pages_1 = require("./Pages");
15
+ /**
16
+ * Prepare query params for work-item list endpoints.
17
+ *
18
+ * The backend's `filters=` query parameter expects a JSON-encoded string, not
19
+ * an exploded object — so we stringify it here before letting axios URL-encode
20
+ * the result into a single query value. Everything else passes through
21
+ * unchanged.
22
+ *
23
+ * Exported for reuse from sibling resources (Cycles, Modules) that list work
24
+ * items.
25
+ */
26
+ function prepareWorkItemParams(params) {
27
+ if (!params)
28
+ return undefined;
29
+ if (params.filters === undefined)
30
+ return params;
31
+ const { filters, ...rest } = params;
32
+ return { ...rest, filters: JSON.stringify(filters) };
33
+ }
11
34
  /**
12
35
  * WorkItems API resource
13
36
  * Handles all work item (issue) related operations
@@ -21,6 +44,9 @@ class WorkItems extends BaseResource_1.BaseResource {
21
44
  this.comments = new Comments_1.Comments(config);
22
45
  this.activities = new Activities_1.Activities(config);
23
46
  this.workLogs = new WorkLogs_1.WorkLogs(config);
47
+ this.dependencies = new Dependencies_1.Dependencies(config);
48
+ this.customRelations = new CustomRelations_1.CustomRelations(config);
49
+ this.pages = new Pages_1.Pages(config);
24
50
  }
25
51
  /**
26
52
  * Create a new work item
@@ -49,10 +75,65 @@ class WorkItems extends BaseResource_1.BaseResource {
49
75
  return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/`);
50
76
  }
51
77
  /**
52
- * List work items with optional filtering
78
+ * List work items in a project with optional filtering.
79
+ *
80
+ * Supports rich filtering via `filters` (a structured object, JSON-encoded
81
+ * into a single `filters=` query param) and `pql` (Plane Query Language).
82
+ *
83
+ * @example
84
+ * ```ts
85
+ * await client.workItems.list("my-workspace", "project-id", {
86
+ * filters: { and: [{ priority: "urgent" }, { state_group__in: ["unstarted", "started"] }] },
87
+ * order_by: "-created_at",
88
+ * per_page: 50,
89
+ * });
90
+ * ```
53
91
  */
54
92
  async list(workspaceSlug, projectId, params) {
55
- return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/`, params);
93
+ return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/`, prepareWorkItemParams(params));
94
+ }
95
+ /**
96
+ * List work items across an entire workspace.
97
+ *
98
+ * Returns a paginated envelope of work items the caller can view, spanning
99
+ * every project in the workspace (per-project authorization is honored
100
+ * server-side). Supports the same `filters` and `pql` query params as
101
+ * {@link WorkItems.list}, plus `order_by`, `cursor`, `per_page`, `fields`,
102
+ * and `expand`.
103
+ */
104
+ async listWorkspace(workspaceSlug, params) {
105
+ return this.get(`/workspaces/${workspaceSlug}/work-items/`, prepareWorkItemParams(params));
106
+ }
107
+ /**
108
+ * Return the count of work items across an entire workspace.
109
+ *
110
+ * Supports `filters`, `pql`, `group_by`, and `sub_group_by` query params.
111
+ * `grouped_counts` keys are raw ORM field values: UUID strings for FK/M2M
112
+ * dimensions, plain strings for `priority` / `state__group`, ISO-date strings
113
+ * for `target_date` / `start_date`. "None" is used for empty values.
114
+ */
115
+ async countWorkspace(workspaceSlug, params) {
116
+ return this.get(`/workspaces/${workspaceSlug}/work-items/count/`, params);
117
+ }
118
+ /**
119
+ * List archived work items in a project.
120
+ * Supports the same `filters` and `pql` query parameters as list().
121
+ */
122
+ async listArchived(workspaceSlug, projectId, params) {
123
+ return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/archived-work-items/`, prepareWorkItemParams(params));
124
+ }
125
+ /**
126
+ * Archive a work item.
127
+ * Only work items in a completed or cancelled state can be archived.
128
+ */
129
+ async archive(workspaceSlug, projectId, workItemId) {
130
+ await this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/archive/`, {});
131
+ }
132
+ /**
133
+ * Unarchive a work item — restore it to active status.
134
+ */
135
+ async unarchive(workspaceSlug, projectId, workItemId) {
136
+ return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/unarchive/`);
56
137
  }
57
138
  // Implementation
58
139
  async retrieveByIdentifier(workspaceSlug, identifier, expand) {
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAc/C,oCAAiC;AACjC,2CAAwC;AACxC,+CAA4C;AAC5C,yCAAsC;AACtC,6CAA0C;AAC1C,yCAAsC;AAEtC;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAQzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAA8B;QACnF,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,EAAE,cAAc,CAAC,CAAC;IAC/G,CAAC;IAYD;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAAE;YAC3G,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,cAA8B;QAE9B,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAC9E,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,cAAc,EAChE,MAAM,CACP,CAAC;IACJ,CAAC;IAWD,iBAAiB;IACjB,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,eAAe,UAAU,GAAG,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,KAAa,EAAE,SAAkB,EAAE,MAAY;QACjF,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,qBAAqB,EAAE;YACjF,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,IAA4B;QACtE,OAAO,IAAI,CAAC,IAAI,CAAyB,eAAe,aAAa,8BAA8B,EAAE,IAAI,CAAC,CAAC;IAC7G,CAAC;CACF;AA7HD,8BA6HC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":";;;AAqCA,sDAKC;AA1CD,kDAA+C;AAgB/C,oCAAiC;AACjC,2CAAwC;AACxC,+CAA4C;AAC5C,yCAAsC;AACtC,6CAA0C;AAC1C,yCAAsC;AACtC,iDAA8C;AAC9C,uDAAoD;AACpD,mCAAgC;AAEhC;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CAAC,MAA4B;IAChE,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,MAAiC,CAAC;IAC3E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACpC,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAWzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAA8B;QACnF,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,EAAE,cAAc,CAAC,CAAC;IAC/G,CAAC;IAYD;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAAE;YAC3G,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,cAA8B;QAE9B,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAC9E,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,cAAc,EAChE,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,MAA4B;QACrE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,EAC1C,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,MAA4B;QACtE,OAAO,IAAI,CAAC,GAAG,CAAwB,eAAe,aAAa,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,uBAAuB,EACzE,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACxE,MAAM,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,WAAW,EAAE,EAAE,CAAC,CAAC;IACpH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QAC1E,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,aAAa,CAAC,CAAC;IACnH,CAAC;IAWD,iBAAiB;IACjB,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,eAAe,UAAU,GAAG,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,KAAa,EAAE,SAAkB,EAAE,MAAY;QACjF,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,qBAAqB,EAAE;YACjF,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,IAA4B;QACtE,OAAO,IAAI,CAAC,IAAI,CAAyB,eAAe,aAAa,8BAA8B,EAAE,IAAI,CAAC,CAAC;IAC7G,CAAC;CACF;AAzMD,8BAyMC"}
@@ -0,0 +1,34 @@
1
+ import { BaseResource } from "../BaseResource";
2
+ import { Configuration } from "../../Configuration";
3
+ import { CreateWorkflowTransitionHook, UpdateWorkflowTransitionHook, WorkflowTransitionHook } from "../../models/Workflow";
4
+ /**
5
+ * WorkflowTransitionHooks sub-resource
6
+ * Manages hooks attached to project workflow transitions
7
+ */
8
+ export declare class Hooks extends BaseResource {
9
+ constructor(config: Configuration);
10
+ private basePath;
11
+ /**
12
+ * List hooks on a workflow transition
13
+ */
14
+ list(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<WorkflowTransitionHook[]>;
15
+ /**
16
+ * Create a hook on a workflow transition.
17
+ * For send_webhook handlers the one-shot `secret_plaintext` is included in
18
+ * the response of this call only.
19
+ */
20
+ create(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, data: CreateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
21
+ /**
22
+ * Retrieve a hook by ID
23
+ */
24
+ retrieve(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
25
+ /**
26
+ * Update a hook (`phase` and `handler_name` are immutable)
27
+ */
28
+ update(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string, data: UpdateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
29
+ /**
30
+ * Delete a hook
31
+ */
32
+ del(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, hookId: string): Promise<void>;
33
+ }
34
+ //# sourceMappingURL=Hooks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Hooks.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/Hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAIjC,OAAO,CAAC,QAAQ;IAOhB;;OAEG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAOpC;;;;OAIG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;IAMlC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;OAEG;IACG,GAAG,CACP,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,IAAI,CAAC;CAGjB"}
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Hooks = void 0;
4
+ const BaseResource_1 = require("../BaseResource");
5
+ /**
6
+ * WorkflowTransitionHooks sub-resource
7
+ * Manages hooks attached to project workflow transitions
8
+ */
9
+ class Hooks extends BaseResource_1.BaseResource {
10
+ constructor(config) {
11
+ super(config);
12
+ }
13
+ basePath(workspaceSlug, projectId, workflowId, transitionId) {
14
+ return (`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}` +
15
+ `/state-transitions/${transitionId}/hooks`);
16
+ }
17
+ /**
18
+ * List hooks on a workflow transition
19
+ */
20
+ async list(workspaceSlug, projectId, workflowId, transitionId) {
21
+ const data = await this.get(`${this.basePath(workspaceSlug, projectId, workflowId, transitionId)}/`);
22
+ return Array.isArray(data) ? data : data.results;
23
+ }
24
+ /**
25
+ * Create a hook on a workflow transition.
26
+ * For send_webhook handlers the one-shot `secret_plaintext` is included in
27
+ * the response of this call only.
28
+ */
29
+ async create(workspaceSlug, projectId, workflowId, transitionId, data) {
30
+ return this.post(`${this.basePath(workspaceSlug, projectId, workflowId, transitionId)}/`, data);
31
+ }
32
+ /**
33
+ * Retrieve a hook by ID
34
+ */
35
+ async retrieve(workspaceSlug, projectId, workflowId, transitionId, hookId) {
36
+ return this.get(`${this.basePath(workspaceSlug, projectId, workflowId, transitionId)}/${hookId}/`);
37
+ }
38
+ /**
39
+ * Update a hook (`phase` and `handler_name` are immutable)
40
+ */
41
+ async update(workspaceSlug, projectId, workflowId, transitionId, hookId, data) {
42
+ return this.patch(`${this.basePath(workspaceSlug, projectId, workflowId, transitionId)}/${hookId}/`, data);
43
+ }
44
+ /**
45
+ * Delete a hook
46
+ */
47
+ async del(workspaceSlug, projectId, workflowId, transitionId, hookId) {
48
+ return this.httpDelete(`${this.basePath(workspaceSlug, projectId, workflowId, transitionId)}/${hookId}/`);
49
+ }
50
+ }
51
+ exports.Hooks = Hooks;
52
+ //# sourceMappingURL=Hooks.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Hooks.js","sourceRoot":"","sources":["../../../src/api/Workflows/Hooks.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAQ/C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEO,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,YAAoB;QACjG,OAAO,CACL,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,EAAE;YAC5E,sBAAsB,YAAY,QAAQ,CAC3C,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,CACxE,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,IAAkC;QAElC,OAAO,IAAI,CAAC,IAAI,CACd,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,EACvE,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CACb,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,CAClF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,MAAc,EACd,IAAkC;QAElC,OAAO,IAAI,CAAC,KAAK,CACf,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,EACjF,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;IAC5G,CAAC;CACF;AAzFD,sBAyFC"}
@@ -0,0 +1,31 @@
1
+ import { BaseResource } from "../BaseResource";
2
+ import { Configuration } from "../../Configuration";
3
+ import { AttachWorkflowStates, UpdateWorkflowState, WorkflowState } from "../../models/Workflow";
4
+ /**
5
+ * WorkflowStates sub-resource
6
+ * Manages state attachments on a workflow
7
+ */
8
+ export declare class States extends BaseResource {
9
+ constructor(config: Configuration);
10
+ /**
11
+ * List the states attached to a workflow
12
+ */
13
+ list(workspaceSlug: string, projectId: string, workflowId: string): Promise<WorkflowState[]>;
14
+ /**
15
+ * Attach states to a workflow
16
+ */
17
+ attach(workspaceSlug: string, projectId: string, workflowId: string, data: AttachWorkflowStates): Promise<void>;
18
+ /**
19
+ * Update a state's membership row (type, allow_issue_creation, is_default)
20
+ */
21
+ update(workspaceSlug: string, projectId: string, workflowId: string, stateId: string, data: UpdateWorkflowState): Promise<WorkflowState | null>;
22
+ /**
23
+ * Detach a state from a workflow
24
+ */
25
+ detach(workspaceSlug: string, projectId: string, workflowId: string, stateId: string): Promise<void>;
26
+ /**
27
+ * Transfer work items off a state and remove it from the workflow
28
+ */
29
+ transfer(workspaceSlug: string, projectId: string, workflowId: string, stateId: string, newStateId: string): Promise<void>;
30
+ }
31
+ //# sourceMappingURL=States.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"States.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/States.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEjG;;;GAGG;AACH,qBAAa,MAAO,SAAQ,YAAY;gBAC1B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAOlG;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAQhC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1G;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;CAMjB"}
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.States = void 0;
4
+ const BaseResource_1 = require("../BaseResource");
5
+ /**
6
+ * WorkflowStates sub-resource
7
+ * Manages state attachments on a workflow
8
+ */
9
+ class States extends BaseResource_1.BaseResource {
10
+ constructor(config) {
11
+ super(config);
12
+ }
13
+ /**
14
+ * List the states attached to a workflow
15
+ */
16
+ async list(workspaceSlug, projectId, workflowId) {
17
+ const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/`);
18
+ return Array.isArray(data) ? data : data.results;
19
+ }
20
+ /**
21
+ * Attach states to a workflow
22
+ */
23
+ async attach(workspaceSlug, projectId, workflowId, data) {
24
+ return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/`, data);
25
+ }
26
+ /**
27
+ * Update a state's membership row (type, allow_issue_creation, is_default)
28
+ */
29
+ async update(workspaceSlug, projectId, workflowId, stateId, data) {
30
+ const response = await this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/${stateId}/`, data);
31
+ return response ?? null;
32
+ }
33
+ /**
34
+ * Detach a state from a workflow
35
+ */
36
+ async detach(workspaceSlug, projectId, workflowId, stateId) {
37
+ return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/${stateId}/`);
38
+ }
39
+ /**
40
+ * Transfer work items off a state and remove it from the workflow
41
+ */
42
+ async transfer(workspaceSlug, projectId, workflowId, stateId, newStateId) {
43
+ return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/${stateId}/transfer/`, { new_state_id: newStateId });
44
+ }
45
+ }
46
+ exports.States = States;
47
+ //# sourceMappingURL=States.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"States.js","sourceRoot":"","sources":["../../../src/api/Workflows/States.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAI/C;;;GAGG;AACH,MAAa,MAAO,SAAQ,2BAAY;IACtC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACrE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,UAAU,CACrF,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,IAA0B;QAE1B,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,UAAU,EAAE,IAAI,CAAC,CAAC;IACrH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,OAAe,EACf,IAAyB;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,WAAW,OAAO,GAAG,EAC/F,IAAI,CACL,CAAC;QACF,OAAO,QAAQ,IAAI,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,OAAe;QACxF,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,WAAW,OAAO,GAAG,CAChG,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,OAAe,EACf,UAAkB;QAElB,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,WAAW,OAAO,YAAY,EACxG,EAAE,YAAY,EAAE,UAAU,EAAE,CAC7B,CAAC;IACJ,CAAC;CACF;AApED,wBAoEC"}
@@ -0,0 +1,32 @@
1
+ import { BaseResource } from "../BaseResource";
2
+ import { Configuration } from "../../Configuration";
3
+ import { CreateWorkflowTransition, UpdateWorkflowTransition, WorkflowTransition } from "../../models/Workflow";
4
+ /**
5
+ * WorkflowTransitions sub-resource
6
+ * Manages state transitions within a workflow
7
+ */
8
+ export declare class Transitions extends BaseResource {
9
+ constructor(config: Configuration);
10
+ /**
11
+ * List all state transitions for a workflow
12
+ */
13
+ list(workspaceSlug: string, projectId: string, workflowId: string): Promise<WorkflowTransition[]>;
14
+ /**
15
+ * Retrieve a workflow state transition by ID
16
+ */
17
+ retrieve(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<WorkflowTransition>;
18
+ /**
19
+ * Create a state transition for a workflow.
20
+ * Returns null if the transition already exists (HTTP 400 "already exists").
21
+ */
22
+ create(workspaceSlug: string, projectId: string, workflowId: string, data: CreateWorkflowTransition): Promise<WorkflowTransition | null>;
23
+ /**
24
+ * Update a workflow state transition
25
+ */
26
+ update(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, data: UpdateWorkflowTransition): Promise<WorkflowTransition>;
27
+ /**
28
+ * Delete a workflow state transition
29
+ */
30
+ del(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<void>;
31
+ }
32
+ //# sourceMappingURL=Transitions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Transitions.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/Transitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE/G;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAOvG;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,kBAAkB,CAAC;IAM9B;;;OAGG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IA0BrC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,kBAAkB,CAAC;IAO9B;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAK7G"}
@@ -0,0 +1,67 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Transitions = void 0;
4
+ const BaseResource_1 = require("../BaseResource");
5
+ const errors_1 = require("../../errors");
6
+ /**
7
+ * WorkflowTransitions sub-resource
8
+ * Manages state transitions within a workflow
9
+ */
10
+ class Transitions extends BaseResource_1.BaseResource {
11
+ constructor(config) {
12
+ super(config);
13
+ }
14
+ /**
15
+ * List all state transitions for a workflow
16
+ */
17
+ async list(workspaceSlug, projectId, workflowId) {
18
+ const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/`);
19
+ return Array.isArray(data) ? data : data.results;
20
+ }
21
+ /**
22
+ * Retrieve a workflow state transition by ID
23
+ */
24
+ async retrieve(workspaceSlug, projectId, workflowId, transitionId) {
25
+ return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/${transitionId}/`);
26
+ }
27
+ /**
28
+ * Create a state transition for a workflow.
29
+ * Returns null if the transition already exists (HTTP 400 "already exists").
30
+ */
31
+ async create(workspaceSlug, projectId, workflowId, data) {
32
+ try {
33
+ return await this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/`, data);
34
+ }
35
+ catch (error) {
36
+ if (error instanceof errors_1.HttpError && error.statusCode === 400) {
37
+ const response = error.response;
38
+ const body = typeof response === "string"
39
+ ? response.toLowerCase()
40
+ : typeof response === "object" &&
41
+ response !== null &&
42
+ "detail" in response &&
43
+ typeof response.detail === "string"
44
+ ? response.detail.toLowerCase()
45
+ : "";
46
+ if (body.includes("already exists")) {
47
+ return null;
48
+ }
49
+ }
50
+ throw error;
51
+ }
52
+ }
53
+ /**
54
+ * Update a workflow state transition
55
+ */
56
+ async update(workspaceSlug, projectId, workflowId, transitionId, data) {
57
+ return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/${transitionId}/`, data);
58
+ }
59
+ /**
60
+ * Delete a workflow state transition
61
+ */
62
+ async del(workspaceSlug, projectId, workflowId, transitionId) {
63
+ return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/${transitionId}/`);
64
+ }
65
+ }
66
+ exports.Transitions = Transitions;
67
+ //# sourceMappingURL=Transitions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Transitions.js","sourceRoot":"","sources":["../../../src/api/Workflows/Transitions.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAE/C,yCAAyC;AAGzC;;;GAGG;AACH,MAAa,WAAY,SAAQ,2BAAY;IAC3C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACrE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,qBAAqB,CAChG,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB;QAEpB,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,sBAAsB,YAAY,GAAG,CAChH,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,IAA8B;QAE9B,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,qBAAqB,EAC/F,IAAI,CACL,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,kBAAS,IAAI,KAAK,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3D,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAmB,CAAC;gBAC3C,MAAM,IAAI,GACR,OAAO,QAAQ,KAAK,QAAQ;oBAC1B,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxB,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ;wBAC1B,QAAQ,KAAK,IAAI;wBACjB,QAAQ,IAAI,QAAQ;wBACpB,OAAQ,QAAgC,CAAC,MAAM,KAAK,QAAQ;wBAC9D,CAAC,CAAE,QAA+B,CAAC,MAAM,CAAC,WAAW,EAAE;wBACvD,CAAC,CAAC,EAAE,CAAC;gBACX,IAAI,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACpC,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,IAA8B;QAE9B,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,sBAAsB,YAAY,GAAG,EAC/G,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,YAAoB;QAC1F,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,sBAAsB,YAAY,GAAG,CAChH,CAAC;IACJ,CAAC;CACF;AAxFD,kCAwFC"}
@@ -0,0 +1,54 @@
1
+ import { BaseResource } from "../BaseResource";
2
+ import { Configuration } from "../../Configuration";
3
+ import { CreateWorkflow, SubmitWorkItemApproval, UpdateWorkflow, WorkItemApprovalResult, Workflow, WorkflowActivity } from "../../models/Workflow";
4
+ import { States } from "./States";
5
+ import { Transitions } from "./Transitions";
6
+ import { Hooks } from "./Hooks";
7
+ export type ListWorkflowActivitiesParams = {
8
+ created_at__gt?: string;
9
+ };
10
+ /**
11
+ * Workflows API resource
12
+ * Handles project workflow operations and exposes states/transitions/hooks
13
+ * sub-resources.
14
+ *
15
+ * Under workspace governance, workflows are managed at the workspace level
16
+ * (see `WorkspaceWorkflows`) and project-scoped writes respond 400 with code
17
+ * `workspace_managed`.
18
+ */
19
+ export declare class Workflows extends BaseResource {
20
+ states: States;
21
+ transitions: Transitions;
22
+ hooks: Hooks;
23
+ constructor(config: Configuration);
24
+ /**
25
+ * List all workflows for a project
26
+ */
27
+ list(workspaceSlug: string, projectId: string): Promise<Workflow[]>;
28
+ /**
29
+ * Create a new workflow for a project
30
+ */
31
+ create(workspaceSlug: string, projectId: string, data: CreateWorkflow): Promise<Workflow>;
32
+ /**
33
+ * Retrieve a workflow by ID
34
+ */
35
+ retrieve(workspaceSlug: string, projectId: string, workflowId: string): Promise<Workflow>;
36
+ /**
37
+ * Update a workflow by ID
38
+ */
39
+ update(workspaceSlug: string, projectId: string, workflowId: string, data: UpdateWorkflow): Promise<Workflow>;
40
+ /**
41
+ * Delete a workflow by ID.
42
+ * The default workflow cannot be deleted.
43
+ */
44
+ delete(workspaceSlug: string, projectId: string, workflowId: string): Promise<void>;
45
+ /**
46
+ * List the workflow's activity/audit entries
47
+ */
48
+ activities(workspaceSlug: string, projectId: string, workflowId: string, params?: ListWorkflowActivitiesParams): Promise<WorkflowActivity[]>;
49
+ /**
50
+ * Approve or reject a work item's pending workflow transition
51
+ */
52
+ submitWorkItemApproval(workspaceSlug: string, projectId: string, workItemId: string, data: SubmitWorkItemApproval): Promise<WorkItemApprovalResult>;
53
+ }
54
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,cAAc,EACd,sBAAsB,EACtB,QAAQ,EACR,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,MAAM,4BAA4B,GAAG;IACzC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,SAAU,SAAQ,YAAY;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;gBAER,MAAM,EAAE,aAAa;IAOjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOzE;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI/F;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI/F;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAInH;;;OAGG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzF;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAQ9B;;OAEG;IACG,sBAAsB,CAC1B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,sBAAsB,CAAC;CAMnC"}
@@ -0,0 +1,71 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Workflows = void 0;
4
+ const BaseResource_1 = require("../BaseResource");
5
+ const States_1 = require("./States");
6
+ const Transitions_1 = require("./Transitions");
7
+ const Hooks_1 = require("./Hooks");
8
+ /**
9
+ * Workflows API resource
10
+ * Handles project workflow operations and exposes states/transitions/hooks
11
+ * sub-resources.
12
+ *
13
+ * Under workspace governance, workflows are managed at the workspace level
14
+ * (see `WorkspaceWorkflows`) and project-scoped writes respond 400 with code
15
+ * `workspace_managed`.
16
+ */
17
+ class Workflows extends BaseResource_1.BaseResource {
18
+ constructor(config) {
19
+ super(config);
20
+ this.states = new States_1.States(config);
21
+ this.transitions = new Transitions_1.Transitions(config);
22
+ this.hooks = new Hooks_1.Hooks(config);
23
+ }
24
+ /**
25
+ * List all workflows for a project
26
+ */
27
+ async list(workspaceSlug, projectId) {
28
+ const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/`);
29
+ return Array.isArray(data) ? data : data.results;
30
+ }
31
+ /**
32
+ * Create a new workflow for a project
33
+ */
34
+ async create(workspaceSlug, projectId, data) {
35
+ return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/`, data);
36
+ }
37
+ /**
38
+ * Retrieve a workflow by ID
39
+ */
40
+ async retrieve(workspaceSlug, projectId, workflowId) {
41
+ return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/`);
42
+ }
43
+ /**
44
+ * Update a workflow by ID
45
+ */
46
+ async update(workspaceSlug, projectId, workflowId, data) {
47
+ return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/`, data);
48
+ }
49
+ /**
50
+ * Delete a workflow by ID.
51
+ * The default workflow cannot be deleted.
52
+ */
53
+ async delete(workspaceSlug, projectId, workflowId) {
54
+ return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/`);
55
+ }
56
+ /**
57
+ * List the workflow's activity/audit entries
58
+ */
59
+ async activities(workspaceSlug, projectId, workflowId, params) {
60
+ const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/activities/`, params);
61
+ return Array.isArray(data) ? data : data.results;
62
+ }
63
+ /**
64
+ * Approve or reject a work item's pending workflow transition
65
+ */
66
+ async submitWorkItemApproval(workspaceSlug, projectId, workItemId, data) {
67
+ return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/workflow-approval/`, data);
68
+ }
69
+ }
70
+ exports.Workflows = Workflows;
71
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Workflows/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAU/C,qCAAkC;AAClC,+CAA4C;AAC5C,mCAAgC;AAMhC;;;;;;;;GAQG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAKzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,aAAa,CAChE,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,IAAoB;QACzE,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,aAAa,EAAE,IAAI,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACzE,OAAO,IAAI,CAAC,GAAG,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,GAAG,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,IAAoB;QAC7F,OAAO,IAAI,CAAC,KAAK,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,GAAG,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAqC;QAErC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,cAAc,EACxF,MAAM,CACP,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAC1B,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,IAA4B;QAE5B,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,qBAAqB,EAChG,IAAI,CACL,CAAC;IACJ,CAAC;CACF;AAjFD,8BAiFC"}
@@ -1,6 +1,7 @@
1
1
  import { BaseResource } from "./BaseResource";
2
2
  import { Configuration } from "../Configuration";
3
- import { User } from "../models/User";
3
+ import { WorkspaceMember, ListMembersLiteParams, ProjectRoleDistribution } from "../models/Member";
4
+ import { PaginatedResponse } from "../models/common";
4
5
  import { UpdateWorkspaceFeatures, WorkspaceFeatures } from "../models/WorkspaceFeatures";
5
6
  /**
6
7
  * Workspace API resource
@@ -9,9 +10,21 @@ import { UpdateWorkspaceFeatures, WorkspaceFeatures } from "../models/WorkspaceF
9
10
  export declare class Workspace extends BaseResource {
10
11
  constructor(config: Configuration);
11
12
  /**
12
- * Get workspace members
13
+ * Get workspace members with their role information.
13
14
  */
14
- getMembers(workspaceSlug: string): Promise<User[]>;
15
+ getMembers(workspaceSlug: string): Promise<WorkspaceMember[]>;
16
+ /**
17
+ * List workspace members as a paginated "lite" response.
18
+ * Unlike getMembers() (which returns a bare list), this returns a
19
+ * cursor-paginated envelope.
20
+ */
21
+ getMembersLite(workspaceSlug: string, params?: ListMembersLiteParams): Promise<PaginatedResponse<WorkspaceMember>>;
22
+ /**
23
+ * Aggregate count of project members by role across the workspace.
24
+ * Counts span all active (non-archived) projects and include both built-in
25
+ * and custom roles.
26
+ */
27
+ getProjectRoleDistribution(workspaceSlug: string): Promise<ProjectRoleDistribution>;
15
28
  /**
16
29
  * Retrieve workspace features
17
30
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEzF;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;gBAC7B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAIxD;;OAEG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIzE;;OAEG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGjH"}
1
+ {"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AACnG,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEzF;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;gBAC7B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAInE;;;;OAIG;IACG,cAAc,CAClB,aAAa,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAI9C;;;;OAIG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIzE;;OAEG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGjH"}
@@ -11,11 +11,27 @@ class Workspace extends BaseResource_1.BaseResource {
11
11
  super(config);
12
12
  }
13
13
  /**
14
- * Get workspace members
14
+ * Get workspace members with their role information.
15
15
  */
16
16
  async getMembers(workspaceSlug) {
17
17
  return this.get(`/workspaces/${workspaceSlug}/members/`);
18
18
  }
19
+ /**
20
+ * List workspace members as a paginated "lite" response.
21
+ * Unlike getMembers() (which returns a bare list), this returns a
22
+ * cursor-paginated envelope.
23
+ */
24
+ async getMembersLite(workspaceSlug, params) {
25
+ return this.get(`/workspaces/${workspaceSlug}/members-lite/`, params);
26
+ }
27
+ /**
28
+ * Aggregate count of project members by role across the workspace.
29
+ * Counts span all active (non-archived) projects and include both built-in
30
+ * and custom roles.
31
+ */
32
+ async getProjectRoleDistribution(workspaceSlug) {
33
+ return this.get(`/workspaces/${workspaceSlug}/project-role-distribution/`);
34
+ }
19
35
  /**
20
36
  * Retrieve workspace features
21
37
  */
@@ -1 +1 @@
1
- {"version":3,"file":"Workspace.js","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAK9C;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IACzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,aAAqB;QACpC,OAAO,IAAI,CAAC,GAAG,CAAS,eAAe,aAAa,WAAW,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,aAAqB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAoB,eAAe,aAAa,YAAY,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,cAAuC;QACjF,OAAO,IAAI,CAAC,KAAK,CAAoB,eAAe,aAAa,YAAY,EAAE,cAAc,CAAC,CAAC;IACjG,CAAC;CACF;AAzBD,8BAyBC"}
1
+ {"version":3,"file":"Workspace.js","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAM9C;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IACzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,aAAqB;QACpC,OAAO,IAAI,CAAC,GAAG,CAAoB,eAAe,aAAa,WAAW,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAClB,aAAqB,EACrB,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAqC,eAAe,aAAa,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC5G,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,0BAA0B,CAAC,aAAqB;QACpD,OAAO,IAAI,CAAC,GAAG,CAA0B,eAAe,aAAa,6BAA6B,CAAC,CAAC;IACtG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,aAAqB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAoB,eAAe,aAAa,YAAY,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,cAAuC;QACjF,OAAO,IAAI,CAAC,KAAK,CAAoB,eAAe,aAAa,YAAY,EAAE,cAAc,CAAC,CAAC;IACjG,CAAC;CACF;AA9CD,8BA8CC"}