@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.
- package/README.md +17 -1
- package/dist/api/BaseResource.d.ts +1 -1
- package/dist/api/BaseResource.d.ts.map +1 -1
- package/dist/api/BaseResource.js +18 -2
- package/dist/api/BaseResource.js.map +1 -1
- package/dist/api/Collections/Members.d.ts +31 -0
- package/dist/api/Collections/Members.d.ts.map +1 -0
- package/dist/api/Collections/Members.js +44 -0
- package/dist/api/Collections/Members.js.map +1 -0
- package/dist/api/Collections/Pages.d.ts +40 -0
- package/dist/api/Collections/Pages.d.ts.map +1 -0
- package/dist/api/Collections/Pages.js +55 -0
- package/dist/api/Collections/Pages.js.map +1 -0
- package/dist/api/Collections/index.d.ts +41 -0
- package/dist/api/Collections/index.d.ts.map +1 -0
- package/dist/api/Collections/index.js +57 -0
- package/dist/api/Collections/index.js.map +1 -0
- package/dist/api/Customers/Properties.d.ts +10 -1
- package/dist/api/Customers/Properties.d.ts.map +1 -1
- package/dist/api/Customers/Properties.js +11 -0
- package/dist/api/Customers/Properties.js.map +1 -1
- package/dist/api/Customers/index.d.ts +6 -0
- package/dist/api/Customers/index.d.ts.map +1 -1
- package/dist/api/Customers/index.js +11 -0
- package/dist/api/Customers/index.js.map +1 -1
- package/dist/api/Cycles.d.ts +12 -4
- package/dist/api/Cycles.d.ts.map +1 -1
- package/dist/api/Cycles.js +14 -3
- package/dist/api/Cycles.js.map +1 -1
- package/dist/api/Epics.d.ts +21 -1
- package/dist/api/Epics.d.ts.map +1 -1
- package/dist/api/Epics.js +30 -0
- package/dist/api/Epics.js.map +1 -1
- package/dist/api/Estimates.d.ts +50 -0
- package/dist/api/Estimates.d.ts.map +1 -0
- package/dist/api/Estimates.js +73 -0
- package/dist/api/Estimates.js.map +1 -0
- package/dist/api/Intake.d.ts +8 -1
- package/dist/api/Intake.d.ts.map +1 -1
- package/dist/api/Intake.js +9 -0
- package/dist/api/Intake.js.map +1 -1
- package/dist/api/Modules.d.ts +12 -4
- package/dist/api/Modules.d.ts.map +1 -1
- package/dist/api/Modules.js +14 -3
- package/dist/api/Modules.js.map +1 -1
- package/dist/api/Pages.d.ts +56 -1
- package/dist/api/Pages.d.ts.map +1 -1
- package/dist/api/Pages.js +74 -0
- package/dist/api/Pages.js.map +1 -1
- package/dist/api/ProjectTemplates/Pages.d.ts +27 -0
- package/dist/api/ProjectTemplates/Pages.d.ts.map +1 -0
- package/dist/api/ProjectTemplates/Pages.js +40 -0
- package/dist/api/ProjectTemplates/Pages.js.map +1 -0
- package/dist/api/ProjectTemplates/WorkItems.d.ts +27 -0
- package/dist/api/ProjectTemplates/WorkItems.d.ts.map +1 -0
- package/dist/api/ProjectTemplates/WorkItems.js +40 -0
- package/dist/api/ProjectTemplates/WorkItems.js.map +1 -0
- package/dist/api/ProjectTemplates/index.d.ts +14 -0
- package/dist/api/ProjectTemplates/index.d.ts.map +1 -0
- package/dist/api/ProjectTemplates/index.js +19 -0
- package/dist/api/ProjectTemplates/index.js.map +1 -0
- package/dist/api/Projects.d.ts +15 -4
- package/dist/api/Projects.d.ts.map +1 -1
- package/dist/api/Projects.js +18 -3
- package/dist/api/Projects.js.map +1 -1
- package/dist/api/Releases/Changelog.d.ts +19 -0
- package/dist/api/Releases/Changelog.d.ts.map +1 -0
- package/dist/api/Releases/Changelog.js +27 -0
- package/dist/api/Releases/Changelog.js.map +1 -0
- package/dist/api/Releases/Comments.d.ts +31 -0
- package/dist/api/Releases/Comments.d.ts.map +1 -0
- package/dist/api/Releases/Comments.js +46 -0
- package/dist/api/Releases/Comments.js.map +1 -0
- package/dist/api/Releases/ItemLabels.d.ts +23 -0
- package/dist/api/Releases/ItemLabels.d.ts.map +1 -0
- package/dist/api/Releases/ItemLabels.js +39 -0
- package/dist/api/Releases/ItemLabels.js.map +1 -0
- package/dist/api/Releases/Labels.d.ts +16 -0
- package/dist/api/Releases/Labels.d.ts.map +1 -0
- package/dist/api/Releases/Labels.js +31 -0
- package/dist/api/Releases/Labels.js.map +1 -0
- package/dist/api/Releases/Links.d.ts +31 -0
- package/dist/api/Releases/Links.d.ts.map +1 -0
- package/dist/api/Releases/Links.js +46 -0
- package/dist/api/Releases/Links.js.map +1 -0
- package/dist/api/Releases/Tags.d.ts +16 -0
- package/dist/api/Releases/Tags.d.ts.map +1 -0
- package/dist/api/Releases/Tags.js +31 -0
- package/dist/api/Releases/Tags.js.map +1 -0
- package/dist/api/Releases/WorkItems.d.ts +23 -0
- package/dist/api/Releases/WorkItems.d.ts.map +1 -0
- package/dist/api/Releases/WorkItems.js +38 -0
- package/dist/api/Releases/WorkItems.js.map +1 -0
- package/dist/api/Releases/index.d.ts +31 -0
- package/dist/api/Releases/index.d.ts.map +1 -0
- package/dist/api/Releases/index.js +46 -0
- package/dist/api/Releases/index.js.map +1 -0
- package/dist/api/Roles.d.ts +26 -0
- package/dist/api/Roles.d.ts.map +1 -0
- package/dist/api/Roles.js +33 -0
- package/dist/api/Roles.js.map +1 -0
- package/dist/api/Users.d.ts +5 -1
- package/dist/api/Users.d.ts.map +1 -1
- package/dist/api/Users.js +6 -0
- package/dist/api/Users.js.map +1 -1
- package/dist/api/WorkItemProperties/index.d.ts +30 -0
- package/dist/api/WorkItemProperties/index.d.ts.map +1 -1
- package/dist/api/WorkItemProperties/index.js +46 -0
- package/dist/api/WorkItemProperties/index.js.map +1 -1
- package/dist/api/WorkItemRelationDefinitions.d.ts +15 -0
- package/dist/api/WorkItemRelationDefinitions.d.ts.map +1 -0
- package/dist/api/WorkItemRelationDefinitions.js +33 -0
- package/dist/api/WorkItemRelationDefinitions.js.map +1 -0
- 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/WorkItemTypes.d.ts +7 -0
- package/dist/api/WorkItemTypes.d.ts.map +1 -1
- package/dist/api/WorkItemTypes.js +11 -0
- package/dist/api/WorkItemTypes.js.map +1 -1
- package/dist/api/WorkItems/CustomRelations.d.ts +29 -0
- package/dist/api/WorkItems/CustomRelations.d.ts.map +1 -0
- package/dist/api/WorkItems/CustomRelations.js +39 -0
- package/dist/api/WorkItems/CustomRelations.js.map +1 -0
- package/dist/api/WorkItems/Dependencies.d.ts +24 -0
- package/dist/api/WorkItems/Dependencies.d.ts.map +1 -0
- package/dist/api/WorkItems/Dependencies.js +34 -0
- package/dist/api/WorkItems/Dependencies.js.map +1 -0
- package/dist/api/WorkItems/Pages.d.ts +28 -0
- package/dist/api/WorkItems/Pages.d.ts.map +1 -0
- package/dist/api/WorkItems/Pages.js +39 -0
- package/dist/api/WorkItems/Pages.js.map +1 -0
- package/dist/api/WorkItems/index.d.ts +65 -2
- package/dist/api/WorkItems/index.d.ts.map +1 -1
- package/dist/api/WorkItems/index.js +83 -2
- package/dist/api/WorkItems/index.js.map +1 -1
- 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 +31 -0
- package/dist/api/Workflows/States.d.ts.map +1 -0
- package/dist/api/Workflows/States.js +47 -0
- package/dist/api/Workflows/States.js.map +1 -0
- package/dist/api/Workflows/Transitions.d.ts +32 -0
- package/dist/api/Workflows/Transitions.d.ts.map +1 -0
- package/dist/api/Workflows/Transitions.js +67 -0
- package/dist/api/Workflows/Transitions.js.map +1 -0
- package/dist/api/Workflows/index.d.ts +54 -0
- package/dist/api/Workflows/index.d.ts.map +1 -0
- package/dist/api/Workflows/index.js +71 -0
- package/dist/api/Workflows/index.js.map +1 -0
- package/dist/api/Workspace.d.ts +16 -3
- package/dist/api/Workspace.d.ts.map +1 -1
- package/dist/api/Workspace.js +17 -1
- package/dist/api/Workspace.js.map +1 -1
- package/dist/api/WorkspaceProjectLabels.d.ts +15 -0
- package/dist/api/WorkspaceProjectLabels.d.ts.map +1 -0
- package/dist/api/WorkspaceProjectLabels.js +28 -0
- package/dist/api/WorkspaceProjectLabels.js.map +1 -0
- package/dist/api/WorkspaceProjectStates.d.ts +15 -0
- package/dist/api/WorkspaceProjectStates.d.ts.map +1 -0
- package/dist/api/WorkspaceProjectStates.js +28 -0
- package/dist/api/WorkspaceProjectStates.js.map +1 -0
- 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/WorkspaceTemplates/Pages.d.ts +15 -0
- package/dist/api/WorkspaceTemplates/Pages.d.ts.map +1 -0
- package/dist/api/WorkspaceTemplates/Pages.js +28 -0
- package/dist/api/WorkspaceTemplates/Pages.js.map +1 -0
- package/dist/api/WorkspaceTemplates/Projects.d.ts +15 -0
- package/dist/api/WorkspaceTemplates/Projects.d.ts.map +1 -0
- package/dist/api/WorkspaceTemplates/Projects.js +28 -0
- package/dist/api/WorkspaceTemplates/Projects.js.map +1 -0
- package/dist/api/WorkspaceTemplates/WorkItems.d.ts +15 -0
- package/dist/api/WorkspaceTemplates/WorkItems.d.ts.map +1 -0
- package/dist/api/WorkspaceTemplates/WorkItems.js +28 -0
- package/dist/api/WorkspaceTemplates/WorkItems.js.map +1 -0
- package/dist/api/WorkspaceTemplates/index.d.ts +16 -0
- package/dist/api/WorkspaceTemplates/index.d.ts.map +1 -0
- package/dist/api/WorkspaceTemplates/index.js +21 -0
- package/dist/api/WorkspaceTemplates/index.js.map +1 -0
- package/dist/api/WorkspaceWorkItemProperties/Options.d.ts +16 -0
- package/dist/api/WorkspaceWorkItemProperties/Options.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkItemProperties/Options.js +31 -0
- package/dist/api/WorkspaceWorkItemProperties/Options.js.map +1 -0
- package/dist/api/WorkspaceWorkItemProperties/index.d.ts +18 -0
- package/dist/api/WorkspaceWorkItemProperties/index.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkItemProperties/index.js +33 -0
- package/dist/api/WorkspaceWorkItemProperties/index.js.map +1 -0
- package/dist/api/WorkspaceWorkItemTypes/Properties.d.ts +15 -0
- package/dist/api/WorkspaceWorkItemTypes/Properties.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkItemTypes/Properties.js +25 -0
- package/dist/api/WorkspaceWorkItemTypes/Properties.js.map +1 -0
- package/dist/api/WorkspaceWorkItemTypes/index.d.ts +18 -0
- package/dist/api/WorkspaceWorkItemTypes/index.d.ts.map +1 -0
- package/dist/api/WorkspaceWorkItemTypes/index.js +33 -0
- package/dist/api/WorkspaceWorkItemTypes/index.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 +30 -2
- package/dist/client/plane-client.d.ts.map +1 -1
- package/dist/client/plane-client.js +30 -2
- package/dist/client/plane-client.js.map +1 -1
- package/dist/index.d.ts +42 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +86 -3
- package/dist/index.js.map +1 -1
- package/dist/models/Collection.d.ts +147 -0
- package/dist/models/Collection.d.ts.map +1 -0
- package/dist/models/Collection.js +19 -0
- package/dist/models/Collection.js.map +1 -0
- package/dist/models/Customer.d.ts +9 -0
- package/dist/models/Customer.d.ts.map +1 -1
- package/dist/models/Cycle.d.ts +25 -0
- package/dist/models/Cycle.d.ts.map +1 -1
- package/dist/models/Epic.d.ts +54 -0
- package/dist/models/Epic.d.ts.map +1 -1
- package/dist/models/Estimate.d.ts +72 -0
- package/dist/models/Estimate.d.ts.map +1 -0
- package/dist/models/Estimate.js +7 -0
- package/dist/models/Estimate.js.map +1 -0
- package/dist/models/Initiative.d.ts +4 -2
- package/dist/models/Initiative.d.ts.map +1 -1
- package/dist/models/Intake.d.ts +8 -0
- package/dist/models/Intake.d.ts.map +1 -1
- package/dist/models/Member.d.ts +54 -0
- package/dist/models/Member.d.ts.map +1 -0
- package/dist/models/Member.js +3 -0
- package/dist/models/Member.js.map +1 -0
- package/dist/models/Module.d.ts +21 -0
- package/dist/models/Module.d.ts.map +1 -1
- package/dist/models/Page.d.ts +27 -1
- package/dist/models/Page.d.ts.map +1 -1
- package/dist/models/Project.d.ts +27 -0
- package/dist/models/Project.d.ts.map +1 -1
- package/dist/models/ProjectTemplate.d.ts +25 -0
- package/dist/models/ProjectTemplate.d.ts.map +1 -0
- package/dist/models/ProjectTemplate.js +3 -0
- package/dist/models/ProjectTemplate.js.map +1 -0
- package/dist/models/Release.d.ts +157 -0
- package/dist/models/Release.d.ts.map +1 -0
- package/dist/models/Release.js +3 -0
- package/dist/models/Release.js.map +1 -0
- package/dist/models/Role.d.ts +31 -0
- package/dist/models/Role.d.ts.map +1 -0
- package/dist/models/Role.js +11 -0
- package/dist/models/Role.js.map +1 -0
- package/dist/models/State.d.ts +31 -0
- package/dist/models/State.d.ts.map +1 -1
- package/dist/models/User.d.ts +23 -0
- package/dist/models/User.d.ts.map +1 -1
- package/dist/models/WorkItem.d.ts +102 -0
- package/dist/models/WorkItem.d.ts.map +1 -1
- package/dist/models/WorkItemPage.d.ts +37 -0
- package/dist/models/WorkItemPage.d.ts.map +1 -0
- package/dist/models/WorkItemPage.js +3 -0
- package/dist/models/WorkItemPage.js.map +1 -0
- package/dist/models/WorkItemRelationDefinition.d.ts +21 -0
- package/dist/models/WorkItemRelationDefinition.d.ts.map +1 -0
- package/dist/models/WorkItemRelationDefinition.js +3 -0
- package/dist/models/WorkItemRelationDefinition.js.map +1 -0
- package/dist/models/WorkItemType.d.ts +6 -0
- package/dist/models/WorkItemType.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 +92 -0
- package/dist/models/Workflow.d.ts.map +1 -0
- package/dist/models/Workflow.js +3 -0
- package/dist/models/Workflow.js.map +1 -0
- package/dist/models/WorkspaceFeatures.d.ts +18 -7
- package/dist/models/WorkspaceFeatures.d.ts.map +1 -1
- package/dist/models/WorkspaceProjectLabel.d.ts +13 -0
- package/dist/models/WorkspaceProjectLabel.d.ts.map +1 -0
- package/dist/models/WorkspaceProjectLabel.js +3 -0
- package/dist/models/WorkspaceProjectLabel.js.map +1 -0
- package/dist/models/WorkspaceProjectState.d.ts +16 -0
- package/dist/models/WorkspaceProjectState.d.ts.map +1 -0
- package/dist/models/WorkspaceProjectState.js +3 -0
- package/dist/models/WorkspaceProjectState.js.map +1 -0
- package/dist/models/WorkspaceTemplate.d.ts +35 -0
- package/dist/models/WorkspaceTemplate.d.ts.map +1 -0
- package/dist/models/WorkspaceTemplate.js +3 -0
- package/dist/models/WorkspaceTemplate.js.map +1 -0
- 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 +14 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +14 -0
- package/dist/models/index.js.map +1 -1
- package/dist/types.bundle.d.ts +3042 -539
- package/package.json +4 -10
- package/dist/api/Members.d.ts +0 -56
- package/dist/api/Members.d.ts.map +0 -1
- package/dist/api/Members.js +0 -45
- package/dist/api/Members.js.map +0 -1
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Properties = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceWorkItemTypeProperties sub-resource
|
|
7
|
+
* Manages property links on workspace-level work item types
|
|
8
|
+
*/
|
|
9
|
+
class Properties extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
async list(workspaceSlug, typeId) {
|
|
14
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/properties/`);
|
|
15
|
+
return Array.isArray(data) ? data : data.results;
|
|
16
|
+
}
|
|
17
|
+
async create(workspaceSlug, typeId, data) {
|
|
18
|
+
return this.post(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/properties/`, data);
|
|
19
|
+
}
|
|
20
|
+
async del(workspaceSlug, typeId, propertyId) {
|
|
21
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/properties/${propertyId}/`);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
exports.Properties = Properties;
|
|
25
|
+
//# sourceMappingURL=Properties.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkItemTypes/Properties.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAK/C;;;GAGG;AACH,MAAa,UAAW,SAAQ,2BAAY;IAC1C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,MAAc;QAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,oBAAoB,MAAM,cAAc,CACrE,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,MAAc,EACd,IAAuC;QAEvC,OAAO,IAAI,CAAC,IAAI,CAAmB,eAAe,aAAa,oBAAoB,MAAM,cAAc,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,MAAc,EAAE,UAAkB;QACjE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,oBAAoB,MAAM,eAAe,UAAU,GAAG,CAAC,CAAC;IAC7G,CAAC;CACF;AAvBD,gCAuBC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { WorkItemType, CreateWorkItemType, UpdateWorkItemType } from "../../models/WorkItemType";
|
|
4
|
+
import { Properties } from "./Properties";
|
|
5
|
+
/**
|
|
6
|
+
* WorkspaceWorkItemTypes API resource
|
|
7
|
+
* Manages work item types at the workspace level
|
|
8
|
+
*/
|
|
9
|
+
export declare class WorkspaceWorkItemTypes extends BaseResource {
|
|
10
|
+
properties: Properties;
|
|
11
|
+
constructor(config: Configuration);
|
|
12
|
+
list(workspaceSlug: string): Promise<WorkItemType[]>;
|
|
13
|
+
create(workspaceSlug: string, data: CreateWorkItemType): Promise<WorkItemType>;
|
|
14
|
+
retrieve(workspaceSlug: string, typeId: string): Promise<WorkItemType>;
|
|
15
|
+
update(workspaceSlug: string, typeId: string, data: UpdateWorkItemType): Promise<WorkItemType>;
|
|
16
|
+
delete(workspaceSlug: string, typeId: string): Promise<void>;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkItemTypes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAC/C,UAAU,EAAE,UAAU,CAAC;gBAElB,MAAM,EAAE,aAAa;IAK3B,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAOpD,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9E,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAItE,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAI9F,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGnE"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WorkspaceWorkItemTypes = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
const Properties_1 = require("./Properties");
|
|
6
|
+
/**
|
|
7
|
+
* WorkspaceWorkItemTypes API resource
|
|
8
|
+
* Manages work item types at the workspace level
|
|
9
|
+
*/
|
|
10
|
+
class WorkspaceWorkItemTypes extends BaseResource_1.BaseResource {
|
|
11
|
+
constructor(config) {
|
|
12
|
+
super(config);
|
|
13
|
+
this.properties = new Properties_1.Properties(config);
|
|
14
|
+
}
|
|
15
|
+
async list(workspaceSlug) {
|
|
16
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/work-item-types/`);
|
|
17
|
+
return Array.isArray(data) ? data : data.results;
|
|
18
|
+
}
|
|
19
|
+
async create(workspaceSlug, data) {
|
|
20
|
+
return this.post(`/workspaces/${workspaceSlug}/work-item-types/`, data);
|
|
21
|
+
}
|
|
22
|
+
async retrieve(workspaceSlug, typeId) {
|
|
23
|
+
return this.get(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/`);
|
|
24
|
+
}
|
|
25
|
+
async update(workspaceSlug, typeId, data) {
|
|
26
|
+
return this.patch(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/`, data);
|
|
27
|
+
}
|
|
28
|
+
async delete(workspaceSlug, typeId) {
|
|
29
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/`);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
exports.WorkspaceWorkItemTypes = WorkspaceWorkItemTypes;
|
|
33
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkItemTypes/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAG/C,6CAA0C;AAE1C;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,2BAAY;IAGtD,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,aAAqB;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,mBAAmB,CAChD,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,IAAwB;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAe,eAAe,aAAa,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACxF,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAc;QAClD,OAAO,IAAI,CAAC,GAAG,CAAe,eAAe,aAAa,oBAAoB,MAAM,GAAG,CAAC,CAAC;IAC3F,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,MAAc,EAAE,IAAwB;QAC1E,OAAO,IAAI,CAAC,KAAK,CAAe,eAAe,aAAa,oBAAoB,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;IACnG,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,MAAc;QAChD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,oBAAoB,MAAM,GAAG,CAAC,CAAC;IACpF,CAAC;CACF;AA9BD,wDA8BC"}
|
|
@@ -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
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Transitions.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/Transitions.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAQ/C;;;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,UAAkB;QAClD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,cAAc,UAAU,qBAAqB,CAC1E,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,UAAkB,EAClB,IAAuC;QAEvC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,cAAc,UAAU,qBAAqB,EACzE,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,UAAkB,EAClB,YAAoB;QAEpB,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,UAAU,sBAAsB,YAAY,GAAG,CAC1F,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,UAAkB,EAClB,YAAoB,EACpB,IAAuC;QAEvC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,cAAc,UAAU,sBAAsB,YAAY,GAAG,EACzF,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,UAAkB,EAAE,YAAoB;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,sBAAsB,YAAY,GAAG,CAAC,CAAC;IACpH,CAAC;CACF;AA/DD,kCA+DC"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { PaginatedResponse } from "../../models/common";
|
|
4
|
+
import { WorkflowActivity } from "../../models/Workflow";
|
|
5
|
+
import { CreateWorkspaceWorkflow, UpdateWorkspaceWorkflow, WorkspaceWorkflow, WorkspaceWorkflowUsage } from "../../models/WorkspaceWorkflow";
|
|
6
|
+
import { States } from "./States";
|
|
7
|
+
import { Transitions } from "./Transitions";
|
|
8
|
+
import { Hooks } from "./Hooks";
|
|
9
|
+
export type ListWorkspaceWorkflowsParams = {
|
|
10
|
+
search?: string;
|
|
11
|
+
is_active?: boolean;
|
|
12
|
+
sort_by?: "name" | "created_at" | "updated_at";
|
|
13
|
+
sort_order?: "asc" | "desc";
|
|
14
|
+
cursor?: string;
|
|
15
|
+
per_page?: number;
|
|
16
|
+
};
|
|
17
|
+
export type ListWorkspaceWorkflowActivitiesParams = {
|
|
18
|
+
created_at__gt?: string;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* WorkspaceWorkflows API resource
|
|
22
|
+
* Manages the workspace workflow catalog (workspace governance) and exposes
|
|
23
|
+
* states/transitions/hooks sub-resources.
|
|
24
|
+
*
|
|
25
|
+
* `list` is dual-mode: under workspace governance it serves the workspace
|
|
26
|
+
* workflow catalog; in ungoverned workspaces it aggregates project workflows.
|
|
27
|
+
* All writes require the workspace to own states and workflows — otherwise
|
|
28
|
+
* the API responds 400 with code `workspace_not_managed`.
|
|
29
|
+
*/
|
|
30
|
+
export declare class WorkspaceWorkflows extends BaseResource {
|
|
31
|
+
states: States;
|
|
32
|
+
transitions: Transitions;
|
|
33
|
+
hooks: Hooks;
|
|
34
|
+
constructor(config: Configuration);
|
|
35
|
+
/**
|
|
36
|
+
* List workspace workflows
|
|
37
|
+
*/
|
|
38
|
+
list(workspaceSlug: string, params?: ListWorkspaceWorkflowsParams): Promise<PaginatedResponse<WorkspaceWorkflow>>;
|
|
39
|
+
/**
|
|
40
|
+
* Create a workspace workflow draft (configure its chain via `states`).
|
|
41
|
+
* Workflow names are workspace-unique.
|
|
42
|
+
*/
|
|
43
|
+
create(workspaceSlug: string, data: CreateWorkspaceWorkflow): Promise<WorkspaceWorkflow>;
|
|
44
|
+
/**
|
|
45
|
+
* Retrieve a workspace workflow with its full chain
|
|
46
|
+
*/
|
|
47
|
+
retrieve(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflow>;
|
|
48
|
+
/**
|
|
49
|
+
* Update workspace workflow metadata (name, description, is_active)
|
|
50
|
+
*/
|
|
51
|
+
update(workspaceSlug: string, workflowId: string, data: UpdateWorkspaceWorkflow): Promise<WorkspaceWorkflow>;
|
|
52
|
+
/**
|
|
53
|
+
* Delete a workspace workflow.
|
|
54
|
+
* The default workflow and workflows in use by projects cannot be deleted.
|
|
55
|
+
*/
|
|
56
|
+
delete(workspaceSlug: string, workflowId: string): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* Report which projects/types resolve to this workflow, and which types
|
|
59
|
+
* mandate or allow it
|
|
60
|
+
*/
|
|
61
|
+
usage(workspaceSlug: string, workflowId: string): Promise<WorkspaceWorkflowUsage>;
|
|
62
|
+
/**
|
|
63
|
+
* List the workflow's activity/audit entries
|
|
64
|
+
*/
|
|
65
|
+
activities(workspaceSlug: string, workflowId: string, params?: ListWorkspaceWorkflowActivitiesParams): Promise<WorkflowActivity[]>;
|
|
66
|
+
}
|
|
67
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,gCAAgC,CAAC;AACxC,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,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,YAAY,CAAC;IAC/C,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG;IAClD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;gBAER,MAAM,EAAE,aAAa;IAOjC;;OAEG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAIhD;;;OAGG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI9F;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIrF;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIlH;;;OAGG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;;OAGG;IACG,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIvF;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,qCAAqC,GAC7C,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAO/B"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WorkspaceWorkflows = 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
|
+
* WorkspaceWorkflows API resource
|
|
10
|
+
* Manages the workspace workflow catalog (workspace governance) and exposes
|
|
11
|
+
* states/transitions/hooks sub-resources.
|
|
12
|
+
*
|
|
13
|
+
* `list` is dual-mode: under workspace governance it serves the workspace
|
|
14
|
+
* workflow catalog; in ungoverned workspaces it aggregates project workflows.
|
|
15
|
+
* All writes require the workspace to own states and workflows — otherwise
|
|
16
|
+
* the API responds 400 with code `workspace_not_managed`.
|
|
17
|
+
*/
|
|
18
|
+
class WorkspaceWorkflows extends BaseResource_1.BaseResource {
|
|
19
|
+
constructor(config) {
|
|
20
|
+
super(config);
|
|
21
|
+
this.states = new States_1.States(config);
|
|
22
|
+
this.transitions = new Transitions_1.Transitions(config);
|
|
23
|
+
this.hooks = new Hooks_1.Hooks(config);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* List workspace workflows
|
|
27
|
+
*/
|
|
28
|
+
async list(workspaceSlug, params) {
|
|
29
|
+
return this.get(`/workspaces/${workspaceSlug}/workflows/`, params);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Create a workspace workflow draft (configure its chain via `states`).
|
|
33
|
+
* Workflow names are workspace-unique.
|
|
34
|
+
*/
|
|
35
|
+
async create(workspaceSlug, data) {
|
|
36
|
+
return this.post(`/workspaces/${workspaceSlug}/workflows/`, data);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Retrieve a workspace workflow with its full chain
|
|
40
|
+
*/
|
|
41
|
+
async retrieve(workspaceSlug, workflowId) {
|
|
42
|
+
return this.get(`/workspaces/${workspaceSlug}/workflows/${workflowId}/`);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Update workspace workflow metadata (name, description, is_active)
|
|
46
|
+
*/
|
|
47
|
+
async update(workspaceSlug, workflowId, data) {
|
|
48
|
+
return this.patch(`/workspaces/${workspaceSlug}/workflows/${workflowId}/`, data);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Delete a workspace workflow.
|
|
52
|
+
* The default workflow and workflows in use by projects cannot be deleted.
|
|
53
|
+
*/
|
|
54
|
+
async delete(workspaceSlug, workflowId) {
|
|
55
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/workflows/${workflowId}/`);
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Report which projects/types resolve to this workflow, and which types
|
|
59
|
+
* mandate or allow it
|
|
60
|
+
*/
|
|
61
|
+
async usage(workspaceSlug, workflowId) {
|
|
62
|
+
return this.get(`/workspaces/${workspaceSlug}/workflows/${workflowId}/usage/`);
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* List the workflow's activity/audit entries
|
|
66
|
+
*/
|
|
67
|
+
async activities(workspaceSlug, workflowId, params) {
|
|
68
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/workflows/${workflowId}/activities/`, params);
|
|
69
|
+
return Array.isArray(data) ? data : data.results;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
exports.WorkspaceWorkflows = WorkspaceWorkflows;
|
|
73
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkspaceWorkflows/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAU/C,qCAAkC;AAClC,+CAA4C;AAC5C,mCAAgC;AAehC;;;;;;;;;GASG;AACH,MAAa,kBAAmB,SAAQ,2BAAY;IAKlD,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,CACR,aAAqB,EACrB,MAAqC;QAErC,OAAO,IAAI,CAAC,GAAG,CAAuC,eAAe,aAAa,aAAa,EAAE,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,IAA6B;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAoB,eAAe,aAAa,aAAa,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,UAAkB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAoB,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB,EAAE,IAA6B;QACnF,OAAO,IAAI,CAAC,KAAK,CAAoB,eAAe,aAAa,cAAc,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,aAAqB,EAAE,UAAkB;QACnD,OAAO,IAAI,CAAC,GAAG,CAAyB,eAAe,aAAa,cAAc,UAAU,SAAS,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,UAAkB,EAClB,MAA8C;QAE9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,cAAc,UAAU,cAAc,EAClE,MAAM,CACP,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;CACF;AA1ED,gDA0EC"}
|
|
@@ -8,11 +8,13 @@ import { Customers } from "../api/Customers";
|
|
|
8
8
|
import { Pages } from "../api/Pages";
|
|
9
9
|
import { Labels } from "../api/Labels";
|
|
10
10
|
import { States } from "../api/States";
|
|
11
|
-
import { Members } from "../api/Members";
|
|
12
11
|
import { Modules } from "../api/Modules";
|
|
13
12
|
import { Cycles } from "../api/Cycles";
|
|
14
13
|
import { Users } from "../api/Users";
|
|
15
14
|
import { Workspace } from "../api/Workspace";
|
|
15
|
+
import { Estimates } from "../api/Estimates";
|
|
16
|
+
import { Roles } from "../api/Roles";
|
|
17
|
+
import { Collections } from "../api/Collections";
|
|
16
18
|
import { Epics } from "../api/Epics";
|
|
17
19
|
import { Intake } from "../api/Intake";
|
|
18
20
|
import { Stickies } from "../api/Stickies";
|
|
@@ -20,6 +22,18 @@ import { Teamspaces } from "../api/Teamspaces";
|
|
|
20
22
|
import { Initiatives } from "../api/Initiatives";
|
|
21
23
|
import { Milestones } from "../api/Milestones";
|
|
22
24
|
import { AgentRuns } from "../api/AgentRuns";
|
|
25
|
+
import { WorkspaceTemplates } from "../api/WorkspaceTemplates";
|
|
26
|
+
import { WorkspaceWorkItemTypes } from "../api/WorkspaceWorkItemTypes";
|
|
27
|
+
import { WorkspaceWorkItemProperties } from "../api/WorkspaceWorkItemProperties";
|
|
28
|
+
import { WorkspaceProjectLabels } from "../api/WorkspaceProjectLabels";
|
|
29
|
+
import { WorkspaceProjectStates } from "../api/WorkspaceProjectStates";
|
|
30
|
+
import { WorkItemRelationDefinitions } from "../api/WorkItemRelationDefinitions";
|
|
31
|
+
import { Releases } from "../api/Releases";
|
|
32
|
+
import { Workflows } from "../api/Workflows";
|
|
33
|
+
import { ProjectTemplates } from "../api/ProjectTemplates";
|
|
34
|
+
import { WorkspaceStates } from "../api/WorkspaceStates";
|
|
35
|
+
import { WorkspaceWorkflows } from "../api/WorkspaceWorkflows";
|
|
36
|
+
import { WorkItemTypeGovernance } from "../api/WorkItemTypeGovernance";
|
|
23
37
|
/**
|
|
24
38
|
* Main Plane Client class
|
|
25
39
|
* Provides access to all Plane API resources
|
|
@@ -35,11 +49,13 @@ export declare class PlaneClient {
|
|
|
35
49
|
projects: Projects;
|
|
36
50
|
labels: Labels;
|
|
37
51
|
states: States;
|
|
38
|
-
members: Members;
|
|
39
52
|
modules: Modules;
|
|
40
53
|
cycles: Cycles;
|
|
41
54
|
users: Users;
|
|
42
55
|
workspace: Workspace;
|
|
56
|
+
estimates: Estimates;
|
|
57
|
+
roles: Roles;
|
|
58
|
+
collections: Collections;
|
|
43
59
|
epics: Epics;
|
|
44
60
|
intake: Intake;
|
|
45
61
|
stickies: Stickies;
|
|
@@ -47,6 +63,18 @@ export declare class PlaneClient {
|
|
|
47
63
|
milestones: Milestones;
|
|
48
64
|
initiatives: Initiatives;
|
|
49
65
|
agentRuns: AgentRuns;
|
|
66
|
+
workspaceTemplates: WorkspaceTemplates;
|
|
67
|
+
workspaceWorkItemTypes: WorkspaceWorkItemTypes;
|
|
68
|
+
workspaceWorkItemProperties: WorkspaceWorkItemProperties;
|
|
69
|
+
workspaceProjectLabels: WorkspaceProjectLabels;
|
|
70
|
+
workspaceProjectStates: WorkspaceProjectStates;
|
|
71
|
+
workItemRelationDefinitions: WorkItemRelationDefinitions;
|
|
72
|
+
releases: Releases;
|
|
73
|
+
workflows: Workflows;
|
|
74
|
+
projectTemplates: ProjectTemplates;
|
|
75
|
+
workspaceStates: WorkspaceStates;
|
|
76
|
+
workspaceWorkflows: WorkspaceWorkflows;
|
|
77
|
+
workItemTypeGovernance: WorkItemTypeGovernance;
|
|
50
78
|
constructor(config: {
|
|
51
79
|
baseUrl?: string;
|
|
52
80
|
apiKey?: string;
|