@makeplane/plane-node-sdk 0.2.12 → 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.
- package/README.md +4 -1
- package/dist/api/Pages.d.ts +47 -1
- package/dist/api/Pages.d.ts.map +1 -1
- package/dist/api/Pages.js +62 -0
- package/dist/api/Pages.js.map +1 -1
- package/dist/api/WorkItemTypeGovernance/Pins.d.ts +26 -0
- package/dist/api/WorkItemTypeGovernance/Pins.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/Pins.js +38 -0
- package/dist/api/WorkItemTypeGovernance/Pins.js.map +1 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts +37 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js +56 -0
- package/dist/api/WorkItemTypeGovernance/ProjectWorkflows.js.map +1 -0
- package/dist/api/WorkItemTypeGovernance/index.d.ts +36 -0
- package/dist/api/WorkItemTypeGovernance/index.d.ts.map +1 -0
- package/dist/api/WorkItemTypeGovernance/index.js +50 -0
- package/dist/api/WorkItemTypeGovernance/index.js.map +1 -0
- package/dist/api/Workflows/Hooks.d.ts +34 -0
- package/dist/api/Workflows/Hooks.d.ts.map +1 -0
- package/dist/api/Workflows/Hooks.js +52 -0
- package/dist/api/Workflows/Hooks.js.map +1 -0
- package/dist/api/Workflows/States.d.ts +13 -1
- package/dist/api/Workflows/States.d.ts.map +1 -1
- package/dist/api/Workflows/States.js +20 -0
- package/dist/api/Workflows/States.js.map +1 -1
- package/dist/api/Workflows/Transitions.d.ts +4 -0
- package/dist/api/Workflows/Transitions.d.ts.map +1 -1
- package/dist/api/Workflows/Transitions.js +6 -0
- package/dist/api/Workflows/Transitions.js.map +1 -1
- package/dist/api/Workflows/index.d.ts +29 -2
- package/dist/api/Workflows/index.d.ts.map +1 -1
- package/dist/api/Workflows/index.js +34 -1
- package/dist/api/Workflows/index.js.map +1 -1
- package/dist/api/WorkspaceStates.d.ts +55 -0
- package/dist/api/WorkspaceStates.d.ts.map +1 -0
- package/dist/api/WorkspaceStates.js +73 -0
- package/dist/api/WorkspaceStates.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/Hooks.d.ts +56 -0
- package/dist/api/WorkspaceWorkflows/Hooks.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/Hooks.js +65 -0
- package/dist/api/WorkspaceWorkflows/Hooks.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/States.d.ts +34 -0
- package/dist/api/WorkspaceWorkflows/States.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/States.js +47 -0
- package/dist/api/WorkspaceWorkflows/States.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/Transitions.d.ts +31 -0
- package/dist/api/WorkspaceWorkflows/Transitions.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/Transitions.js +46 -0
- package/dist/api/WorkspaceWorkflows/Transitions.js.map +1 -0
- package/dist/api/WorkspaceWorkflows/index.d.ts +67 -0
- package/dist/api/WorkspaceWorkflows/index.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkflows/index.js +73 -0
- package/dist/api/WorkspaceWorkflows/index.js.map +1 -0
- package/dist/client/plane-client.d.ts +6 -0
- package/dist/client/plane-client.d.ts.map +1 -1
- package/dist/client/plane-client.js +6 -0
- package/dist/client/plane-client.js.map +1 -1
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -2
- package/dist/index.js.map +1 -1
- package/dist/models/Page.d.ts +21 -0
- package/dist/models/Page.d.ts.map +1 -1
- package/dist/models/Project.d.ts +1 -0
- package/dist/models/Project.d.ts.map +1 -1
- package/dist/models/State.d.ts +31 -0
- package/dist/models/State.d.ts.map +1 -1
- package/dist/models/WorkItemTypeGovernance.d.ts +130 -0
- package/dist/models/WorkItemTypeGovernance.d.ts.map +1 -0
- package/dist/models/WorkItemTypeGovernance.js +3 -0
- package/dist/models/WorkItemTypeGovernance.js.map +1 -0
- package/dist/models/Workflow.d.ts +62 -0
- package/dist/models/Workflow.d.ts.map +1 -1
- package/dist/models/WorkspaceFeatures.d.ts +18 -7
- package/dist/models/WorkspaceFeatures.d.ts.map +1 -1
- package/dist/models/WorkspaceWorkflow.d.ts +145 -0
- package/dist/models/WorkspaceWorkflow.d.ts.map +1 -0
- package/dist/models/WorkspaceWorkflow.js +3 -0
- package/dist/models/WorkspaceWorkflow.js.map +1 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +2 -0
- package/dist/models/index.js.map +1 -1
- package/dist/types.bundle.d.ts +835 -8
- package/package.json +1 -1
|
@@ -1 +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,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,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;CACF;
|
|
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"}
|
|
@@ -11,6 +11,10 @@ export declare class Transitions extends BaseResource {
|
|
|
11
11
|
* List all state transitions for a workflow
|
|
12
12
|
*/
|
|
13
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>;
|
|
14
18
|
/**
|
|
15
19
|
* Create a state transition for a workflow.
|
|
16
20
|
* Returns null if the transition already exists (HTTP 400 "already exists").
|
|
@@ -1 +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;;;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"}
|
|
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"}
|
|
@@ -18,6 +18,12 @@ class Transitions extends BaseResource_1.BaseResource {
|
|
|
18
18
|
const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/`);
|
|
19
19
|
return Array.isArray(data) ? data : data.results;
|
|
20
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
|
+
}
|
|
21
27
|
/**
|
|
22
28
|
* Create a state transition for a workflow.
|
|
23
29
|
* Returns null if the transition already exists (HTTP 400 "already exists").
|
|
@@ -1 +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;;;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;
|
|
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"}
|
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
import { BaseResource } from "../BaseResource";
|
|
2
2
|
import { Configuration } from "../../Configuration";
|
|
3
|
-
import { CreateWorkflow, UpdateWorkflow, Workflow } from "../../models/Workflow";
|
|
3
|
+
import { CreateWorkflow, SubmitWorkItemApproval, UpdateWorkflow, WorkItemApprovalResult, Workflow, WorkflowActivity } from "../../models/Workflow";
|
|
4
4
|
import { States } from "./States";
|
|
5
5
|
import { Transitions } from "./Transitions";
|
|
6
|
+
import { Hooks } from "./Hooks";
|
|
7
|
+
export type ListWorkflowActivitiesParams = {
|
|
8
|
+
created_at__gt?: string;
|
|
9
|
+
};
|
|
6
10
|
/**
|
|
7
11
|
* Workflows API resource
|
|
8
|
-
* Handles project workflow operations and exposes states/transitions
|
|
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`.
|
|
9
18
|
*/
|
|
10
19
|
export declare class Workflows extends BaseResource {
|
|
11
20
|
states: States;
|
|
12
21
|
transitions: Transitions;
|
|
22
|
+
hooks: Hooks;
|
|
13
23
|
constructor(config: Configuration);
|
|
14
24
|
/**
|
|
15
25
|
* List all workflows for a project
|
|
@@ -19,9 +29,26 @@ export declare class Workflows extends BaseResource {
|
|
|
19
29
|
* Create a new workflow for a project
|
|
20
30
|
*/
|
|
21
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>;
|
|
22
36
|
/**
|
|
23
37
|
* Update a workflow by ID
|
|
24
38
|
*/
|
|
25
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>;
|
|
26
53
|
}
|
|
27
54
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +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,
|
|
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"}
|
|
@@ -4,15 +4,22 @@ exports.Workflows = void 0;
|
|
|
4
4
|
const BaseResource_1 = require("../BaseResource");
|
|
5
5
|
const States_1 = require("./States");
|
|
6
6
|
const Transitions_1 = require("./Transitions");
|
|
7
|
+
const Hooks_1 = require("./Hooks");
|
|
7
8
|
/**
|
|
8
9
|
* Workflows API resource
|
|
9
|
-
* Handles project workflow operations and exposes states/transitions
|
|
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`.
|
|
10
16
|
*/
|
|
11
17
|
class Workflows extends BaseResource_1.BaseResource {
|
|
12
18
|
constructor(config) {
|
|
13
19
|
super(config);
|
|
14
20
|
this.states = new States_1.States(config);
|
|
15
21
|
this.transitions = new Transitions_1.Transitions(config);
|
|
22
|
+
this.hooks = new Hooks_1.Hooks(config);
|
|
16
23
|
}
|
|
17
24
|
/**
|
|
18
25
|
* List all workflows for a project
|
|
@@ -27,12 +34,38 @@ class Workflows extends BaseResource_1.BaseResource {
|
|
|
27
34
|
async create(workspaceSlug, projectId, data) {
|
|
28
35
|
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/`, data);
|
|
29
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
|
+
}
|
|
30
43
|
/**
|
|
31
44
|
* Update a workflow by ID
|
|
32
45
|
*/
|
|
33
46
|
async update(workspaceSlug, projectId, workflowId, data) {
|
|
34
47
|
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/`, data);
|
|
35
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
|
+
}
|
|
36
69
|
}
|
|
37
70
|
exports.Workflows = Workflows;
|
|
38
71
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Workflows/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;
|
|
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"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { BaseResource } from "./BaseResource";
|
|
2
|
+
import { Configuration } from "../Configuration";
|
|
3
|
+
import { PaginatedResponse } from "../models/common";
|
|
4
|
+
import { CreateWorkspaceState, ListWorkspaceStatesParams, State, UpdateWorkspaceState } from "../models/State";
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceStates API resource
|
|
7
|
+
* Manages workspace-level work-item states.
|
|
8
|
+
*
|
|
9
|
+
* Reads are dual-mode: under workspace governance, `list`/`retrieve` serve
|
|
10
|
+
* the workspace states catalog; in ungoverned workspaces they aggregate the
|
|
11
|
+
* states of every project the caller can access. Writes are only available
|
|
12
|
+
* when the workspace owns states and workflows — otherwise the API responds
|
|
13
|
+
* 400 with code `workspace_not_managed`. Check
|
|
14
|
+
* `Workspace.retrieveFeatures(...).states_owned_by_workspace` to know which
|
|
15
|
+
* mode a workspace is in.
|
|
16
|
+
*
|
|
17
|
+
* Not to be confused with `WorkspaceProjectStates` (`{slug}/project-states/`),
|
|
18
|
+
* which manages project *lifecycle* states.
|
|
19
|
+
*/
|
|
20
|
+
export declare class WorkspaceStates extends BaseResource {
|
|
21
|
+
constructor(config: Configuration);
|
|
22
|
+
/**
|
|
23
|
+
* List states at workspace scope (works in both modes)
|
|
24
|
+
*/
|
|
25
|
+
list(workspaceSlug: string, params?: ListWorkspaceStatesParams): Promise<PaginatedResponse<State>>;
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve a workspace state by its external ID and source
|
|
28
|
+
*/
|
|
29
|
+
retrieveByExternalId(workspaceSlug: string, externalId: string, externalSource: string): Promise<State>;
|
|
30
|
+
/**
|
|
31
|
+
* Create a new workspace (catalog) state.
|
|
32
|
+
* Governed workspaces only (400 `workspace_not_managed` otherwise).
|
|
33
|
+
* Catalog state names are workspace-unique — a duplicate name responds 409
|
|
34
|
+
* with code `state_name_in_use`.
|
|
35
|
+
*/
|
|
36
|
+
create(workspaceSlug: string, data: CreateWorkspaceState): Promise<State>;
|
|
37
|
+
/**
|
|
38
|
+
* Retrieve a workspace state by ID
|
|
39
|
+
*/
|
|
40
|
+
retrieve(workspaceSlug: string, stateId: string): Promise<State>;
|
|
41
|
+
/**
|
|
42
|
+
* Update a workspace (catalog) state by ID.
|
|
43
|
+
* Governed workspaces only. The triage state cannot be updated, and the
|
|
44
|
+
* `default` flag is managed by the workflow's default state.
|
|
45
|
+
*/
|
|
46
|
+
update(workspaceSlug: string, stateId: string, data: UpdateWorkspaceState): Promise<State>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete a workspace (catalog) state by ID.
|
|
49
|
+
* Governed workspaces only. Deletion is blocked (400) while any workflow
|
|
50
|
+
* chain references the state or any work item still points at it; the
|
|
51
|
+
* triage state is never deletable.
|
|
52
|
+
*/
|
|
53
|
+
delete(workspaceSlug: string, stateId: string): Promise<void>;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=WorkspaceStates.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WorkspaceStates.d.ts","sourceRoot":"","sources":["../../src/api/WorkspaceStates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE/G;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAgB,SAAQ,YAAY;gBACnC,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAIxG;;OAEG;IACG,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAO7G;;;;;OAKG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC;IAI/E;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAItE;;;;OAIG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC;IAIhG;;;;;OAKG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGpE"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WorkspaceStates = void 0;
|
|
4
|
+
const BaseResource_1 = require("./BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceStates API resource
|
|
7
|
+
* Manages workspace-level work-item states.
|
|
8
|
+
*
|
|
9
|
+
* Reads are dual-mode: under workspace governance, `list`/`retrieve` serve
|
|
10
|
+
* the workspace states catalog; in ungoverned workspaces they aggregate the
|
|
11
|
+
* states of every project the caller can access. Writes are only available
|
|
12
|
+
* when the workspace owns states and workflows — otherwise the API responds
|
|
13
|
+
* 400 with code `workspace_not_managed`. Check
|
|
14
|
+
* `Workspace.retrieveFeatures(...).states_owned_by_workspace` to know which
|
|
15
|
+
* mode a workspace is in.
|
|
16
|
+
*
|
|
17
|
+
* Not to be confused with `WorkspaceProjectStates` (`{slug}/project-states/`),
|
|
18
|
+
* which manages project *lifecycle* states.
|
|
19
|
+
*/
|
|
20
|
+
class WorkspaceStates extends BaseResource_1.BaseResource {
|
|
21
|
+
constructor(config) {
|
|
22
|
+
super(config);
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* List states at workspace scope (works in both modes)
|
|
26
|
+
*/
|
|
27
|
+
async list(workspaceSlug, params) {
|
|
28
|
+
return this.get(`/workspaces/${workspaceSlug}/states/`, params);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Retrieve a workspace state by its external ID and source
|
|
32
|
+
*/
|
|
33
|
+
async retrieveByExternalId(workspaceSlug, externalId, externalSource) {
|
|
34
|
+
return this.get(`/workspaces/${workspaceSlug}/states/`, {
|
|
35
|
+
external_id: externalId,
|
|
36
|
+
external_source: externalSource,
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Create a new workspace (catalog) state.
|
|
41
|
+
* Governed workspaces only (400 `workspace_not_managed` otherwise).
|
|
42
|
+
* Catalog state names are workspace-unique — a duplicate name responds 409
|
|
43
|
+
* with code `state_name_in_use`.
|
|
44
|
+
*/
|
|
45
|
+
async create(workspaceSlug, data) {
|
|
46
|
+
return this.post(`/workspaces/${workspaceSlug}/states/`, data);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Retrieve a workspace state by ID
|
|
50
|
+
*/
|
|
51
|
+
async retrieve(workspaceSlug, stateId) {
|
|
52
|
+
return this.get(`/workspaces/${workspaceSlug}/states/${stateId}/`);
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Update a workspace (catalog) state by ID.
|
|
56
|
+
* Governed workspaces only. The triage state cannot be updated, and the
|
|
57
|
+
* `default` flag is managed by the workflow's default state.
|
|
58
|
+
*/
|
|
59
|
+
async update(workspaceSlug, stateId, data) {
|
|
60
|
+
return this.patch(`/workspaces/${workspaceSlug}/states/${stateId}/`, data);
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Delete a workspace (catalog) state by ID.
|
|
64
|
+
* Governed workspaces only. Deletion is blocked (400) while any workflow
|
|
65
|
+
* chain references the state or any work item still points at it; the
|
|
66
|
+
* triage state is never deletable.
|
|
67
|
+
*/
|
|
68
|
+
async delete(workspaceSlug, stateId) {
|
|
69
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/states/${stateId}/`);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
exports.WorkspaceStates = WorkspaceStates;
|
|
73
|
+
//# sourceMappingURL=WorkspaceStates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WorkspaceStates.js","sourceRoot":"","sources":["../../src/api/WorkspaceStates.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAK9C;;;;;;;;;;;;;;GAcG;AACH,MAAa,eAAgB,SAAQ,2BAAY;IAC/C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,MAAkC;QAClE,OAAO,IAAI,CAAC,GAAG,CAA2B,eAAe,aAAa,UAAU,EAAE,MAAM,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CAAC,aAAqB,EAAE,UAAkB,EAAE,cAAsB;QAC1F,OAAO,IAAI,CAAC,GAAG,CAAQ,eAAe,aAAa,UAAU,EAAE;YAC7D,WAAW,EAAE,UAAU;YACvB,eAAe,EAAE,cAAc;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,IAA0B;QAC5D,OAAO,IAAI,CAAC,IAAI,CAAQ,eAAe,aAAa,UAAU,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,OAAe;QACnD,OAAO,IAAI,CAAC,GAAG,CAAQ,eAAe,aAAa,WAAW,OAAO,GAAG,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,OAAe,EAAE,IAA0B;QAC7E,OAAO,IAAI,CAAC,KAAK,CAAQ,eAAe,aAAa,WAAW,OAAO,GAAG,EAAE,IAAI,CAAC,CAAC;IACpF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,OAAe;QACjD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,WAAW,OAAO,GAAG,CAAC,CAAC;IAC5E,CAAC;CACF;AAzDD,0CAyDC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkflowTransitionHook, UpdateWorkflowTransitionHook, WorkflowTransitionHook } from "../../models/Workflow";
|
|
4
|
+
/**
|
|
5
|
+
* One execution history entry for a workflow transition hook
|
|
6
|
+
*/
|
|
7
|
+
export interface WorkflowTransitionHookExecution {
|
|
8
|
+
id: string;
|
|
9
|
+
status: string;
|
|
10
|
+
started_at?: string;
|
|
11
|
+
completed_at?: string;
|
|
12
|
+
input_data?: unknown;
|
|
13
|
+
output_data?: unknown;
|
|
14
|
+
error_message?: string;
|
|
15
|
+
issue_id?: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* WorkspaceWorkflows.hooks sub-resource
|
|
19
|
+
* Manages hooks attached to workspace workflow transitions
|
|
20
|
+
*/
|
|
21
|
+
export declare class Hooks extends BaseResource {
|
|
22
|
+
constructor(config: Configuration);
|
|
23
|
+
private basePath;
|
|
24
|
+
/**
|
|
25
|
+
* List hooks on a workspace workflow transition
|
|
26
|
+
*/
|
|
27
|
+
list(workspaceSlug: string, workflowId: string, transitionId: string): Promise<WorkflowTransitionHook[]>;
|
|
28
|
+
/**
|
|
29
|
+
* Create a hook on a workspace workflow transition.
|
|
30
|
+
* For send_webhook handlers the one-shot `secret_plaintext` is included in
|
|
31
|
+
* the response of this call only.
|
|
32
|
+
*/
|
|
33
|
+
create(workspaceSlug: string, workflowId: string, transitionId: string, data: CreateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
|
|
34
|
+
/**
|
|
35
|
+
* Retrieve a hook by ID
|
|
36
|
+
*/
|
|
37
|
+
retrieve(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
|
|
38
|
+
/**
|
|
39
|
+
* Update a hook (`phase` and `handler_name` are immutable)
|
|
40
|
+
*/
|
|
41
|
+
update(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string, data: UpdateWorkflowTransitionHook): Promise<WorkflowTransitionHook>;
|
|
42
|
+
/**
|
|
43
|
+
* Delete a hook
|
|
44
|
+
*/
|
|
45
|
+
del(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
* Regenerate a send_webhook hook's secret.
|
|
48
|
+
* The new one-shot `secret_plaintext` is included in this response only.
|
|
49
|
+
*/
|
|
50
|
+
regenerateSecret(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHook>;
|
|
51
|
+
/**
|
|
52
|
+
* List a hook's execution history entries
|
|
53
|
+
*/
|
|
54
|
+
executions(workspaceSlug: string, workflowId: string, transitionId: string, hookId: string): Promise<WorkflowTransitionHookExecution[]>;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=Hooks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Hooks.d.ts","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/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;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAIjC,OAAO,CAAC,QAAQ;IAIhB;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAO9G;;;;OAIG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzG;;;OAGG;IACG,gBAAgB,CACpB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,+BAA+B,EAAE,CAAC;CAM9C"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Hooks = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceWorkflows.hooks sub-resource
|
|
7
|
+
* Manages hooks attached to workspace workflow transitions
|
|
8
|
+
*/
|
|
9
|
+
class Hooks extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
basePath(workspaceSlug, workflowId, transitionId) {
|
|
14
|
+
return `/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/${transitionId}/hooks`;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* List hooks on a workspace workflow transition
|
|
18
|
+
*/
|
|
19
|
+
async list(workspaceSlug, workflowId, transitionId) {
|
|
20
|
+
const data = await this.get(`${this.basePath(workspaceSlug, workflowId, transitionId)}/`);
|
|
21
|
+
return Array.isArray(data) ? data : data.results;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Create a hook on a workspace workflow transition.
|
|
25
|
+
* For send_webhook handlers the one-shot `secret_plaintext` is included in
|
|
26
|
+
* the response of this call only.
|
|
27
|
+
*/
|
|
28
|
+
async create(workspaceSlug, workflowId, transitionId, data) {
|
|
29
|
+
return this.post(`${this.basePath(workspaceSlug, workflowId, transitionId)}/`, data);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve a hook by ID
|
|
33
|
+
*/
|
|
34
|
+
async retrieve(workspaceSlug, workflowId, transitionId, hookId) {
|
|
35
|
+
return this.get(`${this.basePath(workspaceSlug, workflowId, transitionId)}/${hookId}/`);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Update a hook (`phase` and `handler_name` are immutable)
|
|
39
|
+
*/
|
|
40
|
+
async update(workspaceSlug, workflowId, transitionId, hookId, data) {
|
|
41
|
+
return this.patch(`${this.basePath(workspaceSlug, workflowId, transitionId)}/${hookId}/`, data);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Delete a hook
|
|
45
|
+
*/
|
|
46
|
+
async del(workspaceSlug, workflowId, transitionId, hookId) {
|
|
47
|
+
return this.httpDelete(`${this.basePath(workspaceSlug, workflowId, transitionId)}/${hookId}/`);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Regenerate a send_webhook hook's secret.
|
|
51
|
+
* The new one-shot `secret_plaintext` is included in this response only.
|
|
52
|
+
*/
|
|
53
|
+
async regenerateSecret(workspaceSlug, workflowId, transitionId, hookId) {
|
|
54
|
+
return this.post(`${this.basePath(workspaceSlug, workflowId, transitionId)}/${hookId}/regenerate-webhook-secret/`, undefined);
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* List a hook's execution history entries
|
|
58
|
+
*/
|
|
59
|
+
async executions(workspaceSlug, workflowId, transitionId, hookId) {
|
|
60
|
+
const data = await this.get(`${this.basePath(workspaceSlug, workflowId, transitionId)}/${hookId}/executions/`);
|
|
61
|
+
return Array.isArray(data) ? data : data.results;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
exports.Hooks = Hooks;
|
|
65
|
+
//# sourceMappingURL=Hooks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Hooks.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/Hooks.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAsB/C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAEO,QAAQ,CAAC,aAAqB,EAAE,UAAkB,EAAE,YAAoB;QAC9E,OAAO,eAAe,aAAa,cAAc,UAAU,sBAAsB,YAAY,QAAQ,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,UAAkB,EAAE,YAAoB;QACxE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,CAC7D,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,UAAkB,EAClB,YAAoB,EACpB,IAAkC;QAElC,OAAO,IAAI,CAAC,IAAI,CAAyB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,UAAkB,EAClB,YAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAyB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;IAClH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,UAAkB,EAClB,YAAoB,EACpB,MAAc,EACd,IAAkC;QAElC,OAAO,IAAI,CAAC,KAAK,CACf,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,EACtE,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,UAAkB,EAAE,YAAoB,EAAE,MAAc;QACvF,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;IACjG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CACpB,aAAqB,EACrB,UAAkB,EAClB,YAAoB,EACpB,MAAc;QAEd,OAAO,IAAI,CAAC,IAAI,CACd,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,6BAA6B,EAChG,SAAS,CACV,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,UAAkB,EAClB,YAAoB,EACpB,MAAc;QAEd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,YAAY,CAAC,IAAI,MAAM,cAAc,CAClF,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;CACF;AAlGD,sBAkGC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { AddWorkspaceWorkflowStates, RemoveWorkspaceWorkflowState, UpdateWorkspaceWorkflowState, WorkspaceWorkflowState } from "../../models/WorkspaceWorkflow";
|
|
4
|
+
/**
|
|
5
|
+
* WorkspaceWorkflows.states sub-resource
|
|
6
|
+
* Manages a workspace workflow's chain (state memberships)
|
|
7
|
+
*/
|
|
8
|
+
export declare class States extends BaseResource {
|
|
9
|
+
constructor(config: Configuration);
|
|
10
|
+
/**
|
|
11
|
+
* Append catalog states to the workflow's chain.
|
|
12
|
+
* Returns the updated chain rows.
|
|
13
|
+
*/
|
|
14
|
+
add(workspaceSlug: string, workflowId: string, data: AddWorkspaceWorkflowStates): Promise<WorkspaceWorkflowState[]>;
|
|
15
|
+
/**
|
|
16
|
+
* Update a chain membership row (type, allow_issue_creation, is_default).
|
|
17
|
+
* Changing `type` removes the row's existing transitions server-side.
|
|
18
|
+
*/
|
|
19
|
+
update(workspaceSlug: string, workflowId: string, stateId: string, data: UpdateWorkspaceWorkflowState): Promise<WorkspaceWorkflowState>;
|
|
20
|
+
/**
|
|
21
|
+
* Remove a state from the chain.
|
|
22
|
+
* Orphan-gated: every work item stranded by the removal must be covered by
|
|
23
|
+
* `data.state_mapping` (409 with an orphan report otherwise). Removing the
|
|
24
|
+
* default state requires `data.new_default_state_id`; transitions
|
|
25
|
+
* referencing the state must be removed first.
|
|
26
|
+
*/
|
|
27
|
+
remove(workspaceSlug: string, workflowId: string, stateId: string, data?: RemoveWorkspaceWorkflowState): Promise<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Mark a chain state as the workflow's default.
|
|
30
|
+
* Also force-enables work-item creation on that state.
|
|
31
|
+
*/
|
|
32
|
+
markDefault(workspaceSlug: string, workflowId: string, stateId: string): Promise<WorkspaceWorkflowState>;
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=States.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"States.d.ts","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/States.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,MAAO,SAAQ,YAAY;gBAC1B,MAAM,EAAE,aAAa;IAIjC;;;OAGG;IACG,GAAG,CACP,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAQpC;;;OAGG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,sBAAsB,CAAC;IAOlC;;;;;;OAMG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,4BAA4B,GAClC,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACG,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAM/G"}
|
|
@@ -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
|
+
* WorkspaceWorkflows.states sub-resource
|
|
7
|
+
* Manages a workspace workflow's chain (state memberships)
|
|
8
|
+
*/
|
|
9
|
+
class States extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Append catalog states to the workflow's chain.
|
|
15
|
+
* Returns the updated chain rows.
|
|
16
|
+
*/
|
|
17
|
+
async add(workspaceSlug, workflowId, data) {
|
|
18
|
+
const result = await this.post(`/workspaces/${workspaceSlug}/workflows/${workflowId}/states/`, data);
|
|
19
|
+
return Array.isArray(result) ? result : [result];
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Update a chain membership row (type, allow_issue_creation, is_default).
|
|
23
|
+
* Changing `type` removes the row's existing transitions server-side.
|
|
24
|
+
*/
|
|
25
|
+
async update(workspaceSlug, workflowId, stateId, data) {
|
|
26
|
+
return this.patch(`/workspaces/${workspaceSlug}/workflows/${workflowId}/states/${stateId}/`, data);
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Remove a state from the chain.
|
|
30
|
+
* Orphan-gated: every work item stranded by the removal must be covered by
|
|
31
|
+
* `data.state_mapping` (409 with an orphan report otherwise). Removing the
|
|
32
|
+
* default state requires `data.new_default_state_id`; transitions
|
|
33
|
+
* referencing the state must be removed first.
|
|
34
|
+
*/
|
|
35
|
+
async remove(workspaceSlug, workflowId, stateId, data) {
|
|
36
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/workflows/${workflowId}/states/${stateId}/`, data);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Mark a chain state as the workflow's default.
|
|
40
|
+
* Also force-enables work-item creation on that state.
|
|
41
|
+
*/
|
|
42
|
+
async markDefault(workspaceSlug, workflowId, stateId) {
|
|
43
|
+
return this.post(`/workspaces/${workspaceSlug}/workflows/${workflowId}/states/${stateId}/mark-default/`, undefined);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
exports.States = States;
|
|
47
|
+
//# sourceMappingURL=States.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"States.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/States.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAS/C;;;GAGG;AACH,MAAa,MAAO,SAAQ,2BAAY;IACtC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CACP,aAAqB,EACrB,UAAkB,EAClB,IAAgC;QAEhC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAC5B,eAAe,aAAa,cAAc,UAAU,UAAU,EAC9D,IAAI,CACL,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,UAAkB,EAClB,OAAe,EACf,IAAkC;QAElC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,cAAc,UAAU,WAAW,OAAO,GAAG,EACzE,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,UAAkB,EAClB,OAAe,EACf,IAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,WAAW,OAAO,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,aAAqB,EAAE,UAAkB,EAAE,OAAe;QAC1E,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,cAAc,UAAU,WAAW,OAAO,gBAAgB,EACtF,SAAS,CACV,CAAC;IACJ,CAAC;CACF;AA/DD,wBA+DC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkspaceWorkflowTransition, UpdateWorkspaceWorkflowTransition, WorkspaceWorkflowTransition } from "../../models/WorkspaceWorkflow";
|
|
4
|
+
/**
|
|
5
|
+
* WorkspaceWorkflows.transitions sub-resource
|
|
6
|
+
* Manages state transitions within a workspace workflow
|
|
7
|
+
*/
|
|
8
|
+
export declare class Transitions extends BaseResource {
|
|
9
|
+
constructor(config: Configuration);
|
|
10
|
+
/**
|
|
11
|
+
* List all state transitions for a workspace workflow
|
|
12
|
+
*/
|
|
13
|
+
list(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflowTransition[]>;
|
|
14
|
+
/**
|
|
15
|
+
* Create a state transition for a workspace workflow
|
|
16
|
+
*/
|
|
17
|
+
create(workspaceSlug: string, workflowId: string, data: CreateWorkspaceWorkflowTransition): Promise<WorkspaceWorkflowTransition>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieve a workspace workflow transition by ID
|
|
20
|
+
*/
|
|
21
|
+
retrieve(workspaceSlug: string, workflowId: string, transitionId: string): Promise<WorkspaceWorkflowTransition>;
|
|
22
|
+
/**
|
|
23
|
+
* Update a workspace workflow transition
|
|
24
|
+
*/
|
|
25
|
+
update(workspaceSlug: string, workflowId: string, transitionId: string, data: UpdateWorkspaceWorkflowTransition): Promise<WorkspaceWorkflowTransition>;
|
|
26
|
+
/**
|
|
27
|
+
* Delete a workspace workflow transition
|
|
28
|
+
*/
|
|
29
|
+
del(workspaceSlug: string, workflowId: string, transitionId: string): Promise<void>;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=Transitions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Transitions.d.ts","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/Transitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC5B,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,EAAE,CAAC;IAO7F;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iCAAiC,GACtC,OAAO,CAAC,2BAA2B,CAAC;IAOvC;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,2BAA2B,CAAC;IAMvC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,iCAAiC,GACtC,OAAO,CAAC,2BAA2B,CAAC;IAOvC;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1F"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Transitions = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceWorkflows.transitions sub-resource
|
|
7
|
+
* Manages state transitions within a workspace workflow
|
|
8
|
+
*/
|
|
9
|
+
class Transitions extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List all state transitions for a workspace workflow
|
|
15
|
+
*/
|
|
16
|
+
async list(workspaceSlug, workflowId) {
|
|
17
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/`);
|
|
18
|
+
return Array.isArray(data) ? data : data.results;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Create a state transition for a workspace workflow
|
|
22
|
+
*/
|
|
23
|
+
async create(workspaceSlug, workflowId, data) {
|
|
24
|
+
return this.post(`/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/`, data);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve a workspace workflow transition by ID
|
|
28
|
+
*/
|
|
29
|
+
async retrieve(workspaceSlug, workflowId, transitionId) {
|
|
30
|
+
return this.get(`/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/${transitionId}/`);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Update a workspace workflow transition
|
|
34
|
+
*/
|
|
35
|
+
async update(workspaceSlug, workflowId, transitionId, data) {
|
|
36
|
+
return this.patch(`/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/${transitionId}/`, data);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Delete a workspace workflow transition
|
|
40
|
+
*/
|
|
41
|
+
async del(workspaceSlug, workflowId, transitionId) {
|
|
42
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/workflows/${workflowId}/state-transitions/${transitionId}/`);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.Transitions = Transitions;
|
|
46
|
+
//# sourceMappingURL=Transitions.js.map
|