@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 @@
|
|
|
1
|
+
{"version":3,"file":"Pins.js","sourceRoot":"","sources":["../../../src/api/WorkItemTypeGovernance/Pins.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAI/C;;;;;GAKG;AACH,MAAa,IAAK,SAAQ,2BAAY;IACpC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,MAAc;QAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,oBAAoB,MAAM,mBAAmB,CAC1E,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,MAAc,EACd,IAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAC9B,eAAe,aAAa,oBAAoB,MAAM,mBAAmB,EACzE,IAAI,CACL,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,MAAc,EAAE,KAAa;QAC/D,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,oBAAoB,MAAM,oBAAoB,KAAK,GAAG,CAAC,CAAC;IAC7G,CAAC;CACF;AArCD,oBAqCC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { GovernancePreview, ProjectTypeWorkflow, ProjectWorkflowPickResult, SetProjectWorkflowPick, WorkflowFallbackPreviewRequest } from "../../models/WorkItemTypeGovernance";
|
|
4
|
+
/**
|
|
5
|
+
* WorkItemTypeGovernance.projectWorkflows sub-resource
|
|
6
|
+
*
|
|
7
|
+
* Reports each active type's governance mode and the workflow it effectively
|
|
8
|
+
* resolves to within a project, and manages the project's own workflow pick
|
|
9
|
+
* for a type.
|
|
10
|
+
*/
|
|
11
|
+
export declare class ProjectWorkflows extends BaseResource {
|
|
12
|
+
constructor(config: Configuration);
|
|
13
|
+
/**
|
|
14
|
+
* List every active type's governance mode, effective workflow, and
|
|
15
|
+
* pickable options for a project
|
|
16
|
+
*/
|
|
17
|
+
list(workspaceSlug: string, projectId: string): Promise<ProjectTypeWorkflow[]>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieve one type's governance mode and effective workflow in a project
|
|
20
|
+
*/
|
|
21
|
+
retrieve(workspaceSlug: string, projectId: string, typeId: string): Promise<ProjectTypeWorkflow>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieve the project's current workflow pick context for a type
|
|
24
|
+
*/
|
|
25
|
+
retrievePick(workspaceSlug: string, projectId: string, typeId: string): Promise<ProjectTypeWorkflow>;
|
|
26
|
+
/**
|
|
27
|
+
* Set the project's workflow pick for a type.
|
|
28
|
+
* Runs the workflow fallback for stranded work items; every orphan must be
|
|
29
|
+
* covered by `data.state_mapping` (400 with an orphan report otherwise).
|
|
30
|
+
*/
|
|
31
|
+
updatePick(workspaceSlug: string, projectId: string, typeId: string, data: SetProjectWorkflowPick): Promise<ProjectWorkflowPickResult>;
|
|
32
|
+
/**
|
|
33
|
+
* Dry-run the project's workflow fallback (re-type / switch dialogs)
|
|
34
|
+
*/
|
|
35
|
+
previewFallback(workspaceSlug: string, projectId: string, data: WorkflowFallbackPreviewRequest): Promise<GovernancePreview>;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=ProjectWorkflows.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ProjectWorkflows.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItemTypeGovernance/ProjectWorkflows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,qCAAqC,CAAC;AAQ7C;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;gBACpC,MAAM,EAAE,aAAa;IAIjC;;;OAGG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAOpF;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAMtG;;OAEG;IACG,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAM1G;;;;OAIG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,yBAAyB,CAAC;IAOrC;;OAEG;IACG,eAAe,CACnB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,8BAA8B,GACnC,OAAO,CAAC,iBAAiB,CAAC;CAO9B"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ProjectWorkflows = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
function unwrapPreview(response) {
|
|
6
|
+
return "preview" in response && response.preview ? response.preview : response;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* WorkItemTypeGovernance.projectWorkflows sub-resource
|
|
10
|
+
*
|
|
11
|
+
* Reports each active type's governance mode and the workflow it effectively
|
|
12
|
+
* resolves to within a project, and manages the project's own workflow pick
|
|
13
|
+
* for a type.
|
|
14
|
+
*/
|
|
15
|
+
class ProjectWorkflows extends BaseResource_1.BaseResource {
|
|
16
|
+
constructor(config) {
|
|
17
|
+
super(config);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* List every active type's governance mode, effective workflow, and
|
|
21
|
+
* pickable options for a project
|
|
22
|
+
*/
|
|
23
|
+
async list(workspaceSlug, projectId) {
|
|
24
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/workflows/`);
|
|
25
|
+
return Array.isArray(data) ? data : data.results;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Retrieve one type's governance mode and effective workflow in a project
|
|
29
|
+
*/
|
|
30
|
+
async retrieve(workspaceSlug, projectId, typeId) {
|
|
31
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/${typeId}/workflows/`);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Retrieve the project's current workflow pick context for a type
|
|
35
|
+
*/
|
|
36
|
+
async retrievePick(workspaceSlug, projectId, typeId) {
|
|
37
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/${typeId}/workflow/`);
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Set the project's workflow pick for a type.
|
|
41
|
+
* Runs the workflow fallback for stranded work items; every orphan must be
|
|
42
|
+
* covered by `data.state_mapping` (400 with an orphan report otherwise).
|
|
43
|
+
*/
|
|
44
|
+
async updatePick(workspaceSlug, projectId, typeId, data) {
|
|
45
|
+
return this.put(`/workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/${typeId}/workflow/`, data);
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Dry-run the project's workflow fallback (re-type / switch dialogs)
|
|
49
|
+
*/
|
|
50
|
+
async previewFallback(workspaceSlug, projectId, data) {
|
|
51
|
+
const response = await this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflow-fallback-preview/`, data);
|
|
52
|
+
return unwrapPreview(response);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
exports.ProjectWorkflows = ProjectWorkflows;
|
|
56
|
+
//# sourceMappingURL=ProjectWorkflows.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ProjectWorkflows.js","sourceRoot":"","sources":["../../../src/api/WorkItemTypeGovernance/ProjectWorkflows.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAY/C,SAAS,aAAa,CAAC,QAAmC;IACxD,OAAO,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAE,QAA8B,CAAC;AACxG,CAAC;AAED;;;;;;GAMG;AACH,MAAa,gBAAiB,SAAQ,2BAAY;IAChD,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,6BAA6B,CAChF,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,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc;QACrE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,MAAM,aAAa,CAC1F,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc;QACzE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,MAAM,YAAY,CACzF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,IAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,MAAM,YAAY,EACxF,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,aAAqB,EACrB,SAAiB,EACjB,IAAoC;QAEpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAC9B,eAAe,aAAa,aAAa,SAAS,6BAA6B,EAC/E,IAAI,CACL,CAAC;QACF,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;CACF;AAjED,4CAiEC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { GovernancePreview, TypeGovernance, TypeGovernancePreviewRequest, UpdateTypeGovernance } from "../../models/WorkItemTypeGovernance";
|
|
4
|
+
import { Pins } from "./Pins";
|
|
5
|
+
import { ProjectWorkflows } from "./ProjectWorkflows";
|
|
6
|
+
/**
|
|
7
|
+
* WorkItemTypeGovernance API resource (workspace governance only)
|
|
8
|
+
*
|
|
9
|
+
* Governs which workflows a workspace-level work item type may use
|
|
10
|
+
* (`any` / `constrained` / `required` modes and allowlists). Per-project pins
|
|
11
|
+
* live on `.pins`; the project-side view of effective workflows and picks
|
|
12
|
+
* lives on `.projectWorkflows`. Every endpoint requires the workspace to own
|
|
13
|
+
* states and workflows — otherwise the API responds 400 with code
|
|
14
|
+
* `workspace_not_managed`.
|
|
15
|
+
*/
|
|
16
|
+
export declare class WorkItemTypeGovernance extends BaseResource {
|
|
17
|
+
pins: Pins;
|
|
18
|
+
projectWorkflows: ProjectWorkflows;
|
|
19
|
+
constructor(config: Configuration);
|
|
20
|
+
/**
|
|
21
|
+
* Retrieve a type's governance settings (mode, required workflow, allowlist)
|
|
22
|
+
*/
|
|
23
|
+
retrieve(workspaceSlug: string, typeId: string): Promise<TypeGovernance>;
|
|
24
|
+
/**
|
|
25
|
+
* Update a type's governance mode / allowlist / required workflow.
|
|
26
|
+
* Destructive changes (dropping in-use workflows, mandating one) require
|
|
27
|
+
* `data.acknowledge` and may need a `data.state_mapping` for orphaned work
|
|
28
|
+
* items.
|
|
29
|
+
*/
|
|
30
|
+
update(workspaceSlug: string, typeId: string, data: UpdateTypeGovernance): Promise<TypeGovernance>;
|
|
31
|
+
/**
|
|
32
|
+
* Dry-run a governance change and report affected work items (no writes)
|
|
33
|
+
*/
|
|
34
|
+
preview(workspaceSlug: string, typeId: string, data: TypeGovernancePreviewRequest): Promise<GovernancePreview>;
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItemTypeGovernance/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,4BAA4B,EAC5B,oBAAoB,EACrB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAQtD;;;;;;;;;GASG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAC/C,IAAI,EAAE,IAAI,CAAC;IACX,gBAAgB,EAAE,gBAAgB,CAAC;gBAE9B,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAI9E;;;;;OAKG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;IAIxG;;OAEG;IACG,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAOrH"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.WorkItemTypeGovernance = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
const Pins_1 = require("./Pins");
|
|
6
|
+
const ProjectWorkflows_1 = require("./ProjectWorkflows");
|
|
7
|
+
function unwrapPreview(response) {
|
|
8
|
+
return "preview" in response && response.preview ? response.preview : response;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* WorkItemTypeGovernance API resource (workspace governance only)
|
|
12
|
+
*
|
|
13
|
+
* Governs which workflows a workspace-level work item type may use
|
|
14
|
+
* (`any` / `constrained` / `required` modes and allowlists). Per-project pins
|
|
15
|
+
* live on `.pins`; the project-side view of effective workflows and picks
|
|
16
|
+
* lives on `.projectWorkflows`. Every endpoint requires the workspace to own
|
|
17
|
+
* states and workflows — otherwise the API responds 400 with code
|
|
18
|
+
* `workspace_not_managed`.
|
|
19
|
+
*/
|
|
20
|
+
class WorkItemTypeGovernance extends BaseResource_1.BaseResource {
|
|
21
|
+
constructor(config) {
|
|
22
|
+
super(config);
|
|
23
|
+
this.pins = new Pins_1.Pins(config);
|
|
24
|
+
this.projectWorkflows = new ProjectWorkflows_1.ProjectWorkflows(config);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve a type's governance settings (mode, required workflow, allowlist)
|
|
28
|
+
*/
|
|
29
|
+
async retrieve(workspaceSlug, typeId) {
|
|
30
|
+
return this.get(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/governance/`);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Update a type's governance mode / allowlist / required workflow.
|
|
34
|
+
* Destructive changes (dropping in-use workflows, mandating one) require
|
|
35
|
+
* `data.acknowledge` and may need a `data.state_mapping` for orphaned work
|
|
36
|
+
* items.
|
|
37
|
+
*/
|
|
38
|
+
async update(workspaceSlug, typeId, data) {
|
|
39
|
+
return this.patch(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/governance/`, data);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Dry-run a governance change and report affected work items (no writes)
|
|
43
|
+
*/
|
|
44
|
+
async preview(workspaceSlug, typeId, data) {
|
|
45
|
+
const response = await this.post(`/workspaces/${workspaceSlug}/work-item-types/${typeId}/governance/preview/`, data);
|
|
46
|
+
return unwrapPreview(response);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
exports.WorkItemTypeGovernance = WorkItemTypeGovernance;
|
|
50
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkItemTypeGovernance/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAQ/C,iCAA8B;AAC9B,yDAAsD;AAItD,SAAS,aAAa,CAAC,QAAmC;IACxD,OAAO,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAE,QAA8B,CAAC;AACxG,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,sBAAuB,SAAQ,2BAAY;IAItD,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,WAAI,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,CAAC,gBAAgB,GAAG,IAAI,mCAAgB,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAc;QAClD,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,oBAAoB,MAAM,cAAc,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,MAAc,EAAE,IAA0B;QAC5E,OAAO,IAAI,CAAC,KAAK,CAAiB,eAAe,aAAa,oBAAoB,MAAM,cAAc,EAAE,IAAI,CAAC,CAAC;IAChH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,aAAqB,EAAE,MAAc,EAAE,IAAkC;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAC9B,eAAe,aAAa,oBAAoB,MAAM,sBAAsB,EAC5E,IAAI,CACL,CAAC;QACF,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;CACF;AArCD,wDAqCC"}
|
|
@@ -32,5 +32,12 @@ export declare class WorkItemTypes extends BaseResource {
|
|
|
32
32
|
* List work item types with optional filtering
|
|
33
33
|
*/
|
|
34
34
|
list(workspaceSlug: string, projectId: string, params?: ListWorkItemTypesParams): Promise<WorkItemType[]>;
|
|
35
|
+
/**
|
|
36
|
+
* Import workspace-level work item types into a project.
|
|
37
|
+
*
|
|
38
|
+
* @param workItemTypeIds - IDs of the workspace work item types to import.
|
|
39
|
+
* @returns The resulting project-level work item types after import.
|
|
40
|
+
*/
|
|
41
|
+
importToProject(workspaceSlug: string, projectId: string, workItemTypeIds: string[]): Promise<WorkItemType[]>;
|
|
35
42
|
}
|
|
36
43
|
//# sourceMappingURL=WorkItemTypes.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WorkItemTypes.d.ts","sourceRoot":"","sources":["../../src/api/WorkItemTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE9F,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;gBACjC,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC,YAAY,CAAC;IAOxB;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAMvG;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC,YAAY,CAAC;IAOxB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7F;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"WorkItemTypes.d.ts","sourceRoot":"","sources":["../../src/api/WorkItemTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE9F,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;gBACjC,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC,YAAY,CAAC;IAOxB;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAMvG;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,EACtB,kBAAkB,EAAE,kBAAkB,GACrC,OAAO,CAAC,YAAY,CAAC;IAOxB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7F;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAI/G;;;;;OAKG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAKpH"}
|
|
@@ -40,6 +40,17 @@ class WorkItemTypes extends BaseResource_1.BaseResource {
|
|
|
40
40
|
async list(workspaceSlug, projectId, params) {
|
|
41
41
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-item-types/`, params);
|
|
42
42
|
}
|
|
43
|
+
/**
|
|
44
|
+
* Import workspace-level work item types into a project.
|
|
45
|
+
*
|
|
46
|
+
* @param workItemTypeIds - IDs of the workspace work item types to import.
|
|
47
|
+
* @returns The resulting project-level work item types after import.
|
|
48
|
+
*/
|
|
49
|
+
async importToProject(workspaceSlug, projectId, workItemTypeIds) {
|
|
50
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/import-work-item-types/`, {
|
|
51
|
+
work_item_types: workItemTypeIds,
|
|
52
|
+
});
|
|
53
|
+
}
|
|
43
54
|
}
|
|
44
55
|
exports.WorkItemTypes = WorkItemTypes;
|
|
45
56
|
//# sourceMappingURL=WorkItemTypes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WorkItemTypes.js","sourceRoot":"","sources":["../../src/api/WorkItemTypes.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAU9C;;;GAGG;AACH,MAAa,aAAc,SAAQ,2BAAY;IAC7C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,kBAAsC;QAEtC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,mBAAmB,EACrE,kBAAkB,CACnB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAsB;QAC7E,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,CACxF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,cAAsB,EACtB,kBAAsC;QAEtC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,EACvF,kBAAkB,CACnB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAsB;QAC3E,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,CAAC,CAAC;IAClH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAgC;QACnF,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,aAAa,SAAS,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACjH,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"WorkItemTypes.js","sourceRoot":"","sources":["../../src/api/WorkItemTypes.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAU9C;;;GAGG;AACH,MAAa,aAAc,SAAQ,2BAAY;IAC7C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,kBAAsC;QAEtC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,mBAAmB,EACrE,kBAAkB,CACnB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAsB;QAC7E,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,CACxF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,cAAsB,EACtB,kBAAsC;QAEtC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,EACvF,kBAAkB,CACnB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAsB;QAC3E,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,oBAAoB,cAAc,GAAG,CAAC,CAAC;IAClH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAgC;QACnF,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,aAAa,SAAS,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACjH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,aAAqB,EAAE,SAAiB,EAAE,eAAyB;QACvF,OAAO,IAAI,CAAC,IAAI,CAAiB,eAAe,aAAa,aAAa,SAAS,0BAA0B,EAAE;YAC7G,eAAe,EAAE,eAAe;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AApED,sCAoEC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkItemCustomRelationRequest, WorkItemWithRelationType } from "../../models/WorkItem";
|
|
4
|
+
/**
|
|
5
|
+
* WorkItemCustomRelations API resource
|
|
6
|
+
* Manages custom (definition-based) work item relations.
|
|
7
|
+
*
|
|
8
|
+
* Custom relations are workspace-level types defined via the
|
|
9
|
+
* work-item-relation-definitions endpoint. Each definition has an outward
|
|
10
|
+
* label and an inward label that controls directionality.
|
|
11
|
+
*/
|
|
12
|
+
export declare class CustomRelations extends BaseResource {
|
|
13
|
+
constructor(config: Configuration);
|
|
14
|
+
/**
|
|
15
|
+
* List all custom relations for a work item grouped by definition label.
|
|
16
|
+
* Response keys are the outward/inward labels from active workspace relation
|
|
17
|
+
* definitions (e.g. "implements", "implemented by", "relates to").
|
|
18
|
+
*/
|
|
19
|
+
list(workspaceSlug: string, projectId: string, workItemId: string): Promise<Record<string, WorkItemWithRelationType[]>>;
|
|
20
|
+
/**
|
|
21
|
+
* Create one or more custom relations for a work item
|
|
22
|
+
*/
|
|
23
|
+
create(workspaceSlug: string, projectId: string, workItemId: string, createRelation: CreateWorkItemCustomRelationRequest): Promise<WorkItemWithRelationType[]>;
|
|
24
|
+
/**
|
|
25
|
+
* Remove a custom relation between this work item and a target
|
|
26
|
+
*/
|
|
27
|
+
remove(workspaceSlug: string, projectId: string, workItemId: string, relatedWorkItemId: string): Promise<void>;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=CustomRelations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CustomRelations.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItems/CustomRelations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,mCAAmC,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAEtG;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,YAAY;gBACnC,MAAM,EAAE,aAAa;IAIjC;;;;OAIG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,wBAAwB,EAAE,CAAC,CAAC;IAMtD;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,mCAAmC,GAClD,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAOtC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAKrH"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CustomRelations = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkItemCustomRelations API resource
|
|
7
|
+
* Manages custom (definition-based) work item relations.
|
|
8
|
+
*
|
|
9
|
+
* Custom relations are workspace-level types defined via the
|
|
10
|
+
* work-item-relation-definitions endpoint. Each definition has an outward
|
|
11
|
+
* label and an inward label that controls directionality.
|
|
12
|
+
*/
|
|
13
|
+
class CustomRelations extends BaseResource_1.BaseResource {
|
|
14
|
+
constructor(config) {
|
|
15
|
+
super(config);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* List all custom relations for a work item grouped by definition label.
|
|
19
|
+
* Response keys are the outward/inward labels from active workspace relation
|
|
20
|
+
* definitions (e.g. "implements", "implemented by", "relates to").
|
|
21
|
+
*/
|
|
22
|
+
async list(workspaceSlug, projectId, workItemId) {
|
|
23
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/work-item-relations/`);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Create one or more custom relations for a work item
|
|
27
|
+
*/
|
|
28
|
+
async create(workspaceSlug, projectId, workItemId, createRelation) {
|
|
29
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/work-item-relations/`, createRelation);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Remove a custom relation between this work item and a target
|
|
33
|
+
*/
|
|
34
|
+
async remove(workspaceSlug, projectId, workItemId, relatedWorkItemId) {
|
|
35
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/work-item-relations/${relatedWorkItemId}/`);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.CustomRelations = CustomRelations;
|
|
39
|
+
//# sourceMappingURL=CustomRelations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"CustomRelations.js","sourceRoot":"","sources":["../../../src/api/WorkItems/CustomRelations.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAI/C;;;;;;;GAOG;AACH,MAAa,eAAgB,SAAQ,2BAAY;IAC/C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,UAAkB;QAElB,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,uBAAuB,CACnG,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,cAAmD;QAEnD,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,uBAAuB,EAClG,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,iBAAyB;QAClG,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,wBAAwB,iBAAiB,GAAG,CACxH,CAAC;IACJ,CAAC;CACF;AA3CD,0CA2CC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkItemDependencyRequest, WorkItemDependencyResponse, WorkItemWithRelationType } from "../../models/WorkItem";
|
|
4
|
+
/**
|
|
5
|
+
* WorkItemDependencies API resource
|
|
6
|
+
* Manages work item dependency relations across the six built-in directions:
|
|
7
|
+
* blocking / blocked_by / start_before / start_after / finish_before / finish_after
|
|
8
|
+
*/
|
|
9
|
+
export declare class Dependencies extends BaseResource {
|
|
10
|
+
constructor(config: Configuration);
|
|
11
|
+
/**
|
|
12
|
+
* List all dependency relations for a work item grouped by direction
|
|
13
|
+
*/
|
|
14
|
+
list(workspaceSlug: string, projectId: string, workItemId: string): Promise<WorkItemDependencyResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Create one or more dependency relations for a work item
|
|
17
|
+
*/
|
|
18
|
+
create(workspaceSlug: string, projectId: string, workItemId: string, createDependency: CreateWorkItemDependencyRequest): Promise<WorkItemWithRelationType[]>;
|
|
19
|
+
/**
|
|
20
|
+
* Remove a dependency relation between this work item and a target
|
|
21
|
+
*/
|
|
22
|
+
remove(workspaceSlug: string, projectId: string, workItemId: string, relatedWorkItemId: string): Promise<void>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=Dependencies.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Dependencies.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItems/Dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,+BAA+B,EAC/B,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,YAAY;gBAChC,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAM7G;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,+BAA+B,GAChD,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAOtC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAKrH"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Dependencies = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkItemDependencies API resource
|
|
7
|
+
* Manages work item dependency relations across the six built-in directions:
|
|
8
|
+
* blocking / blocked_by / start_before / start_after / finish_before / finish_after
|
|
9
|
+
*/
|
|
10
|
+
class Dependencies extends BaseResource_1.BaseResource {
|
|
11
|
+
constructor(config) {
|
|
12
|
+
super(config);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* List all dependency relations for a work item grouped by direction
|
|
16
|
+
*/
|
|
17
|
+
async list(workspaceSlug, projectId, workItemId) {
|
|
18
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/dependencies/`);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Create one or more dependency relations for a work item
|
|
22
|
+
*/
|
|
23
|
+
async create(workspaceSlug, projectId, workItemId, createDependency) {
|
|
24
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/dependencies/`, createDependency);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Remove a dependency relation between this work item and a target
|
|
28
|
+
*/
|
|
29
|
+
async remove(workspaceSlug, projectId, workItemId, relatedWorkItemId) {
|
|
30
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/dependencies/${relatedWorkItemId}/`);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
exports.Dependencies = Dependencies;
|
|
34
|
+
//# sourceMappingURL=Dependencies.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Dependencies.js","sourceRoot":"","sources":["../../../src/api/WorkItems/Dependencies.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAQ/C;;;;GAIG;AACH,MAAa,YAAa,SAAQ,2BAAY;IAC5C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACrE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,gBAAgB,CAC5F,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,gBAAiD;QAEjD,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,gBAAgB,EAC3F,gBAAgB,CACjB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,iBAAyB;QAClG,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,iBAAiB,iBAAiB,GAAG,CACjH,CAAC;IACJ,CAAC;CACF;AArCD,oCAqCC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { PaginatedResponse } from "../../models/common";
|
|
4
|
+
import { WorkItemPage, CreateWorkItemPageRequest } from "../../models/WorkItemPage";
|
|
5
|
+
/**
|
|
6
|
+
* WorkItemPages API resource
|
|
7
|
+
* Manages page links on a work item
|
|
8
|
+
*/
|
|
9
|
+
export declare class Pages extends BaseResource {
|
|
10
|
+
constructor(config: Configuration);
|
|
11
|
+
/**
|
|
12
|
+
* List page links for a work item
|
|
13
|
+
*/
|
|
14
|
+
list(workspaceSlug: string, projectId: string, workItemId: string, params?: any): Promise<PaginatedResponse<WorkItemPage>>;
|
|
15
|
+
/**
|
|
16
|
+
* Retrieve a specific page link for a work item
|
|
17
|
+
*/
|
|
18
|
+
retrieve(workspaceSlug: string, projectId: string, workItemId: string, workItemPageId: string): Promise<WorkItemPage>;
|
|
19
|
+
/**
|
|
20
|
+
* Link a page to a work item
|
|
21
|
+
*/
|
|
22
|
+
create(workspaceSlug: string, projectId: string, workItemId: string, createPage: CreateWorkItemPageRequest): Promise<WorkItemPage>;
|
|
23
|
+
/**
|
|
24
|
+
* Remove a page link from a work item
|
|
25
|
+
*/
|
|
26
|
+
delete(workspaceSlug: string, projectId: string, workItemId: string, workItemPageId: string): Promise<void>;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=Pages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Pages.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItems/Pages.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,YAAY,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAEpF;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,GAAG,GACX,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAO3C;;OAEG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,YAAY,CAAC;IAMxB;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,yBAAyB,GACpC,OAAO,CAAC,YAAY,CAAC;IAOxB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAKlH"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Pages = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkItemPages API resource
|
|
7
|
+
* Manages page links on a work item
|
|
8
|
+
*/
|
|
9
|
+
class Pages extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List page links for a work item
|
|
15
|
+
*/
|
|
16
|
+
async list(workspaceSlug, projectId, workItemId, params) {
|
|
17
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/pages/`, params);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Retrieve a specific page link for a work item
|
|
21
|
+
*/
|
|
22
|
+
async retrieve(workspaceSlug, projectId, workItemId, workItemPageId) {
|
|
23
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/pages/${workItemPageId}/`);
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Link a page to a work item
|
|
27
|
+
*/
|
|
28
|
+
async create(workspaceSlug, projectId, workItemId, createPage) {
|
|
29
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/pages/`, createPage);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Remove a page link from a work item
|
|
33
|
+
*/
|
|
34
|
+
async delete(workspaceSlug, projectId, workItemId, workItemPageId) {
|
|
35
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/pages/${workItemPageId}/`);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.Pages = Pages;
|
|
39
|
+
//# sourceMappingURL=Pages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Pages.js","sourceRoot":"","sources":["../../../src/api/WorkItems/Pages.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAK/C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,SAAS,EACpF,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,cAAsB;QAEtB,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,UAAU,cAAc,GAAG,CACvG,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,UAAqC;QAErC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,SAAS,EACpF,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,cAAsB;QAC/F,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,UAAU,cAAc,GAAG,CACvG,CAAC;IACJ,CAAC;CACF;AAzDD,sBAyDC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseResource } from "../BaseResource";
|
|
2
2
|
import { Configuration } from "../../Configuration";
|
|
3
|
-
import { WorkItem, CreateWorkItem, UpdateWorkItem, ListWorkItemsParams, WorkItemExpandableFieldName, WorkItemBase, WorkItemSearch, AdvancedSearchWorkItem, AdvancedSearchResult } from "../../models/WorkItem";
|
|
3
|
+
import { WorkItem, CreateWorkItem, UpdateWorkItem, ListWorkItemsParams, WorkItemExpandableFieldName, WorkItemBase, WorkItemSearch, AdvancedSearchWorkItem, AdvancedSearchResult, WorkItemCountParams, WorkItemCountResponse } from "../../models/WorkItem";
|
|
4
4
|
import { PaginatedResponse } from "../../models/common";
|
|
5
5
|
import { Links } from "../Links";
|
|
6
6
|
import { Relations } from "./Relations";
|
|
@@ -8,6 +8,21 @@ import { Attachments } from "./Attachments";
|
|
|
8
8
|
import { Comments } from "./Comments";
|
|
9
9
|
import { Activities } from "./Activities";
|
|
10
10
|
import { WorkLogs } from "./WorkLogs";
|
|
11
|
+
import { Dependencies } from "./Dependencies";
|
|
12
|
+
import { CustomRelations } from "./CustomRelations";
|
|
13
|
+
import { Pages } from "./Pages";
|
|
14
|
+
/**
|
|
15
|
+
* Prepare query params for work-item list endpoints.
|
|
16
|
+
*
|
|
17
|
+
* The backend's `filters=` query parameter expects a JSON-encoded string, not
|
|
18
|
+
* an exploded object — so we stringify it here before letting axios URL-encode
|
|
19
|
+
* the result into a single query value. Everything else passes through
|
|
20
|
+
* unchanged.
|
|
21
|
+
*
|
|
22
|
+
* Exported for reuse from sibling resources (Cycles, Modules) that list work
|
|
23
|
+
* items.
|
|
24
|
+
*/
|
|
25
|
+
export declare function prepareWorkItemParams(params?: ListWorkItemsParams): Record<string, unknown> | undefined;
|
|
11
26
|
/**
|
|
12
27
|
* WorkItems API resource
|
|
13
28
|
* Handles all work item (issue) related operations
|
|
@@ -19,6 +34,9 @@ export declare class WorkItems extends BaseResource {
|
|
|
19
34
|
comments: Comments;
|
|
20
35
|
activities: Activities;
|
|
21
36
|
workLogs: WorkLogs;
|
|
37
|
+
dependencies: Dependencies;
|
|
38
|
+
customRelations: CustomRelations;
|
|
39
|
+
pages: Pages;
|
|
22
40
|
constructor(config: Configuration);
|
|
23
41
|
/**
|
|
24
42
|
* Create a new work item
|
|
@@ -35,9 +53,54 @@ export declare class WorkItems extends BaseResource {
|
|
|
35
53
|
*/
|
|
36
54
|
delete(workspaceSlug: string, projectId: string, workItemId: string): Promise<void>;
|
|
37
55
|
/**
|
|
38
|
-
* List work items with optional filtering
|
|
56
|
+
* List work items in a project with optional filtering.
|
|
57
|
+
*
|
|
58
|
+
* Supports rich filtering via `filters` (a structured object, JSON-encoded
|
|
59
|
+
* into a single `filters=` query param) and `pql` (Plane Query Language).
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* await client.workItems.list("my-workspace", "project-id", {
|
|
64
|
+
* filters: { and: [{ priority: "urgent" }, { state_group__in: ["unstarted", "started"] }] },
|
|
65
|
+
* order_by: "-created_at",
|
|
66
|
+
* per_page: 50,
|
|
67
|
+
* });
|
|
68
|
+
* ```
|
|
39
69
|
*/
|
|
40
70
|
list(workspaceSlug: string, projectId: string, params?: ListWorkItemsParams): Promise<PaginatedResponse<WorkItem>>;
|
|
71
|
+
/**
|
|
72
|
+
* List work items across an entire workspace.
|
|
73
|
+
*
|
|
74
|
+
* Returns a paginated envelope of work items the caller can view, spanning
|
|
75
|
+
* every project in the workspace (per-project authorization is honored
|
|
76
|
+
* server-side). Supports the same `filters` and `pql` query params as
|
|
77
|
+
* {@link WorkItems.list}, plus `order_by`, `cursor`, `per_page`, `fields`,
|
|
78
|
+
* and `expand`.
|
|
79
|
+
*/
|
|
80
|
+
listWorkspace(workspaceSlug: string, params?: ListWorkItemsParams): Promise<PaginatedResponse<WorkItem>>;
|
|
81
|
+
/**
|
|
82
|
+
* Return the count of work items across an entire workspace.
|
|
83
|
+
*
|
|
84
|
+
* Supports `filters`, `pql`, `group_by`, and `sub_group_by` query params.
|
|
85
|
+
* `grouped_counts` keys are raw ORM field values: UUID strings for FK/M2M
|
|
86
|
+
* dimensions, plain strings for `priority` / `state__group`, ISO-date strings
|
|
87
|
+
* for `target_date` / `start_date`. "None" is used for empty values.
|
|
88
|
+
*/
|
|
89
|
+
countWorkspace(workspaceSlug: string, params?: WorkItemCountParams): Promise<WorkItemCountResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* List archived work items in a project.
|
|
92
|
+
* Supports the same `filters` and `pql` query parameters as list().
|
|
93
|
+
*/
|
|
94
|
+
listArchived(workspaceSlug: string, projectId: string, params?: ListWorkItemsParams): Promise<PaginatedResponse<WorkItem>>;
|
|
95
|
+
/**
|
|
96
|
+
* Archive a work item.
|
|
97
|
+
* Only work items in a completed or cancelled state can be archived.
|
|
98
|
+
*/
|
|
99
|
+
archive(workspaceSlug: string, projectId: string, workItemId: string): Promise<void>;
|
|
100
|
+
/**
|
|
101
|
+
* Unarchive a work item — restore it to active status.
|
|
102
|
+
*/
|
|
103
|
+
unarchive(workspaceSlug: string, projectId: string, workItemId: string): Promise<void>;
|
|
41
104
|
retrieveByIdentifier(workspaceSlug: string, identifier: string): Promise<WorkItemBase>;
|
|
42
105
|
retrieveByIdentifier<E extends WorkItemExpandableFieldName>(workspaceSlug: string, identifier: string, expand: E[]): Promise<WorkItem<E>>;
|
|
43
106
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,QAAQ,EACR,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,YAAY,EACZ,cAAc,EACd,sBAAsB,EACtB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,QAAQ,EACR,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,YAAY,EACZ,cAAc,EACd,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAKvG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;IAClC,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,eAAe,EAAE,eAAe,CAAC;IACjC,KAAK,EAAE,KAAK,CAAC;gBAER,MAAM,EAAE,aAAa;IAajC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKnG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAE7F,QAAQ,CAAC,CAAC,SAAS,2BAA2B,EAClD,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,EAAE,GACV,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAgBvB;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,QAAQ,CAAC;IAOpB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzF;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAOvC;;;;;;;;OAQG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAO9G;;;;;;;OAOG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIzG;;;OAGG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAOvC;;;OAGG;IACG,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1F;;OAEG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtF,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAEtF,oBAAoB,CAAC,CAAC,SAAS,2BAA2B,EAC9D,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,EAAE,GACV,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAavB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,cAAc,CAAC;IAQ7G;;;;;OAKG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;CAG3G"}
|