@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
package/dist/api/Cycles.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Cycles = void 0;
|
|
4
4
|
const BaseResource_1 = require("./BaseResource");
|
|
5
|
+
const WorkItems_1 = require("./WorkItems");
|
|
5
6
|
/**
|
|
6
7
|
* Cycles API resource
|
|
7
8
|
* Handles all cycle (sprint) related operations
|
|
@@ -40,6 +41,13 @@ class Cycles extends BaseResource_1.BaseResource {
|
|
|
40
41
|
async list(workspaceSlug, projectId) {
|
|
41
42
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/cycles/`);
|
|
42
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* List cycles as a paginated "lite" response, intended for pickers and
|
|
46
|
+
* reference lookups. Accepts an optional status filter.
|
|
47
|
+
*/
|
|
48
|
+
async listLite(workspaceSlug, projectId, params) {
|
|
49
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/cycles-lite/`, params);
|
|
50
|
+
}
|
|
43
51
|
/**
|
|
44
52
|
* List archived cycles
|
|
45
53
|
*/
|
|
@@ -56,13 +64,16 @@ class Cycles extends BaseResource_1.BaseResource {
|
|
|
56
64
|
* Archive a cycle
|
|
57
65
|
*/
|
|
58
66
|
async archive(workspaceSlug, projectId, cycleId) {
|
|
59
|
-
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/
|
|
67
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/cycles/${cycleId}/archive/`);
|
|
60
68
|
}
|
|
61
69
|
/**
|
|
62
|
-
* List work items in cycle
|
|
70
|
+
* List work items in a cycle.
|
|
71
|
+
*
|
|
72
|
+
* Supports the same `filters` and `pql` query parameters as
|
|
73
|
+
* {@link WorkItems.list}.
|
|
63
74
|
*/
|
|
64
75
|
async listWorkItemsInCycle(workspaceSlug, projectId, cycleId, params) {
|
|
65
|
-
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/cycles/${cycleId}/cycle-issues/`, params);
|
|
76
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/cycles/${cycleId}/cycle-issues/`, (0, WorkItems_1.prepareWorkItemParams)(params));
|
|
66
77
|
}
|
|
67
78
|
/**
|
|
68
79
|
* Add work items to cycle
|
package/dist/api/Cycles.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Cycles.js","sourceRoot":"","sources":["../../src/api/Cycles.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;
|
|
1
|
+
{"version":3,"file":"Cycles.js","sourceRoot":"","sources":["../../src/api/Cycles.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAa9C,2CAAoD;AAEpD;;;GAGG;AACH,MAAa,MAAO,SAAQ,2BAAY;IACtC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,WAA+B;QACpF,OAAO,IAAI,CAAC,IAAI,CAAQ,eAAe,aAAa,aAAa,SAAS,UAAU,EAAE,WAAW,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,OAAe;QACtE,OAAO,IAAI,CAAC,GAAG,CAAQ,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,GAAG,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,WAA+B;QAE/B,OAAO,IAAI,CAAC,KAAK,CAAQ,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,GAAG,EAAE,WAAW,CAAC,CAAC;IACjH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,OAAe;QACpE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,GAAG,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB;QACjD,OAAO,IAAI,CAAC,GAAG,CAA2B,eAAe,aAAa,aAAa,SAAS,UAAU,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,MAA6B;QAE7B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,eAAe,EACjE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAY;QACvE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,mBAAmB,EACrE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,aAAqB,EAAE,SAAiB,EAAE,OAAe;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,oBAAoB,OAAO,aAAa,CAAC,CAAC;IACrH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,aAAqB,EAAE,SAAiB,EAAE,OAAe;QACrE,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,WAAW,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,gBAAgB,EACpF,IAAA,iCAAqB,EAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,WAAqB;QAErB,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,gBAAgB,EAAE;YAC3G,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAC3B,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,UAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,iBAAiB,UAAU,GAAG,CACnG,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,+BAA+B,CACnC,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,YAA0C;QAE1C,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,WAAW,OAAO,mBAAmB,EACvF,YAAY,CACb,CAAC;IACJ,CAAC;CACF;AAhJD,wBAgJC"}
|
package/dist/api/Epics.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Configuration } from "../Configuration";
|
|
2
|
-
import { Epic } from "../models/Epic";
|
|
2
|
+
import { Epic, CreateEpic, UpdateEpic, AddEpicWorkItems, EpicIssue } from "../models/Epic";
|
|
3
3
|
import { PaginatedResponse } from "../models/common";
|
|
4
4
|
import { BaseResource } from "./BaseResource";
|
|
5
5
|
/**
|
|
@@ -8,13 +8,33 @@ import { BaseResource } from "./BaseResource";
|
|
|
8
8
|
*/
|
|
9
9
|
export declare class Epics extends BaseResource {
|
|
10
10
|
constructor(config: Configuration);
|
|
11
|
+
/**
|
|
12
|
+
* Create a new epic in the specified project
|
|
13
|
+
*/
|
|
14
|
+
create(workspaceSlug: string, projectId: string, data: CreateEpic): Promise<Epic>;
|
|
11
15
|
/**
|
|
12
16
|
* Retrieve an epic by ID
|
|
13
17
|
*/
|
|
14
18
|
retrieve(workspaceSlug: string, projectId: string, epicId: string): Promise<Epic>;
|
|
19
|
+
/**
|
|
20
|
+
* Partially update an existing epic
|
|
21
|
+
*/
|
|
22
|
+
update(workspaceSlug: string, projectId: string, epicId: string, data: UpdateEpic): Promise<Epic>;
|
|
23
|
+
/**
|
|
24
|
+
* Delete an epic
|
|
25
|
+
*/
|
|
26
|
+
delete(workspaceSlug: string, projectId: string, epicId: string): Promise<void>;
|
|
15
27
|
/**
|
|
16
28
|
* List epics with optional filtering
|
|
17
29
|
*/
|
|
18
30
|
list(workspaceSlug: string, projectId: string, params?: any): Promise<PaginatedResponse<Epic>>;
|
|
31
|
+
/**
|
|
32
|
+
* List work items under an epic
|
|
33
|
+
*/
|
|
34
|
+
listIssues(workspaceSlug: string, projectId: string, epicId: string, params?: any): Promise<PaginatedResponse<EpicIssue>>;
|
|
35
|
+
/**
|
|
36
|
+
* Add work items as sub-issues under an epic
|
|
37
|
+
*/
|
|
38
|
+
addIssues(workspaceSlug: string, projectId: string, epicId: string, data: AddEpicWorkItems): Promise<EpicIssue[]>;
|
|
19
39
|
}
|
|
20
40
|
//# sourceMappingURL=Epics.d.ts.map
|
package/dist/api/Epics.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Epics.d.ts","sourceRoot":"","sources":["../../src/api/Epics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"Epics.d.ts","sourceRoot":"","sources":["../../src/api/Epics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvG;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrF;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAIpG;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,GAAG,GACX,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAOxC;;OAEG;IACG,SAAS,CACb,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,SAAS,EAAE,CAAC;CAGxB"}
|
package/dist/api/Epics.js
CHANGED
|
@@ -10,18 +10,48 @@ class Epics extends BaseResource_1.BaseResource {
|
|
|
10
10
|
constructor(config) {
|
|
11
11
|
super(config);
|
|
12
12
|
}
|
|
13
|
+
/**
|
|
14
|
+
* Create a new epic in the specified project
|
|
15
|
+
*/
|
|
16
|
+
async create(workspaceSlug, projectId, data) {
|
|
17
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/`, data);
|
|
18
|
+
}
|
|
13
19
|
/**
|
|
14
20
|
* Retrieve an epic by ID
|
|
15
21
|
*/
|
|
16
22
|
async retrieve(workspaceSlug, projectId, epicId) {
|
|
17
23
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/${epicId}/`);
|
|
18
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* Partially update an existing epic
|
|
27
|
+
*/
|
|
28
|
+
async update(workspaceSlug, projectId, epicId, data) {
|
|
29
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/${epicId}/`, data);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Delete an epic
|
|
33
|
+
*/
|
|
34
|
+
async delete(workspaceSlug, projectId, epicId) {
|
|
35
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/${epicId}/`);
|
|
36
|
+
}
|
|
19
37
|
/**
|
|
20
38
|
* List epics with optional filtering
|
|
21
39
|
*/
|
|
22
40
|
async list(workspaceSlug, projectId, params) {
|
|
23
41
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/`, params);
|
|
24
42
|
}
|
|
43
|
+
/**
|
|
44
|
+
* List work items under an epic
|
|
45
|
+
*/
|
|
46
|
+
async listIssues(workspaceSlug, projectId, epicId, params) {
|
|
47
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/${epicId}/issues/`, params);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Add work items as sub-issues under an epic
|
|
51
|
+
*/
|
|
52
|
+
async addIssues(workspaceSlug, projectId, epicId, data) {
|
|
53
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/epics/${epicId}/issues/`, data);
|
|
54
|
+
}
|
|
25
55
|
}
|
|
26
56
|
exports.Epics = Epics;
|
|
27
57
|
//# sourceMappingURL=Epics.js.map
|
package/dist/api/Epics.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Epics.js","sourceRoot":"","sources":["../../src/api/Epics.ts"],"names":[],"mappings":";;;AAGA,iDAA8C;AAE9C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc;QACrE,OAAO,IAAI,CAAC,GAAG,CAAO,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAY;QAC/D,OAAO,IAAI,CAAC,GAAG,CAA0B,eAAe,aAAa,aAAa,SAAS,SAAS,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"Epics.js","sourceRoot":"","sources":["../../src/api/Epics.ts"],"names":[],"mappings":";;;AAGA,iDAA8C;AAE9C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,IAAgB;QACrE,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,SAAS,EAAE,IAAI,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc;QACrE,OAAO,IAAI,CAAC,GAAG,CAAO,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc,EAAE,IAAgB;QACrF,OAAO,IAAI,CAAC,KAAK,CAAO,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAc;QACnE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,GAAG,CAAC,CAAC;IAChG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAY;QAC/D,OAAO,IAAI,CAAC,GAAG,CAA0B,eAAe,aAAa,aAAa,SAAS,SAAS,EAAE,MAAM,CAAC,CAAC;IAChH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,UAAU,EAC5E,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,aAAqB,EACrB,SAAiB,EACjB,MAAc,EACd,IAAsB;QAEtB,OAAO,IAAI,CAAC,IAAI,CAAc,eAAe,aAAa,aAAa,SAAS,UAAU,MAAM,UAAU,EAAE,IAAI,CAAC,CAAC;IACpH,CAAC;CACF;AAlED,sBAkEC"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { BaseResource } from "./BaseResource";
|
|
2
|
+
import { Configuration } from "../Configuration";
|
|
3
|
+
import { Estimate, CreateEstimateRequest, UpdateEstimateRequest, EstimatePoint, CreateEstimatePointRequest, UpdateEstimatePointRequest } from "../models/Estimate";
|
|
4
|
+
import { Project } from "../models/Project";
|
|
5
|
+
/**
|
|
6
|
+
* Estimates API resource
|
|
7
|
+
* Manages project estimates and estimate points
|
|
8
|
+
*/
|
|
9
|
+
export declare class Estimates extends BaseResource {
|
|
10
|
+
constructor(config: Configuration);
|
|
11
|
+
/**
|
|
12
|
+
* Create a new estimate for a project
|
|
13
|
+
*/
|
|
14
|
+
create(workspaceSlug: string, projectId: string, createEstimate: CreateEstimateRequest): Promise<Estimate>;
|
|
15
|
+
/**
|
|
16
|
+
* Retrieve the estimate configured for a project
|
|
17
|
+
*/
|
|
18
|
+
retrieve(workspaceSlug: string, projectId: string): Promise<Estimate>;
|
|
19
|
+
/**
|
|
20
|
+
* Update the estimate for a project
|
|
21
|
+
*/
|
|
22
|
+
update(workspaceSlug: string, projectId: string, updateEstimate: UpdateEstimateRequest): Promise<Estimate>;
|
|
23
|
+
/**
|
|
24
|
+
* Delete the estimate for a project
|
|
25
|
+
*/
|
|
26
|
+
delete(workspaceSlug: string, projectId: string): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Link an estimate to a project so it becomes the active estimate system.
|
|
29
|
+
* Delegates to the project update endpoint (PATCH .../projects/{projectId}).
|
|
30
|
+
*/
|
|
31
|
+
linkToProject(workspaceSlug: string, projectId: string, estimateId: string): Promise<Project>;
|
|
32
|
+
/**
|
|
33
|
+
* List all estimate points for a project estimate
|
|
34
|
+
*/
|
|
35
|
+
listPoints(workspaceSlug: string, projectId: string, estimateId: string): Promise<EstimatePoint[]>;
|
|
36
|
+
/**
|
|
37
|
+
* Create estimate points for a project estimate.
|
|
38
|
+
* The API accepts a JSON array directly as the request body.
|
|
39
|
+
*/
|
|
40
|
+
createPoints(workspaceSlug: string, projectId: string, estimateId: string, points: CreateEstimatePointRequest[]): Promise<EstimatePoint[]>;
|
|
41
|
+
/**
|
|
42
|
+
* Update a single estimate point
|
|
43
|
+
*/
|
|
44
|
+
updatePoint(workspaceSlug: string, projectId: string, estimateId: string, estimatePointId: string, updatePoint: UpdateEstimatePointRequest): Promise<EstimatePoint>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete a single estimate point
|
|
47
|
+
*/
|
|
48
|
+
deletePoint(workspaceSlug: string, projectId: string, estimateId: string, estimatePointId: string): Promise<void>;
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=Estimates.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Estimates.d.ts","sourceRoot":"","sources":["../../src/api/Estimates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EACL,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;gBAC7B,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhH;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI3E;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhH;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;OAGG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMnG;;OAEG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAMxG;;;OAGG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,0BAA0B,EAAE,GACnC,OAAO,CAAC,aAAa,EAAE,CAAC;IAO3B;;OAEG;IACG,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,0BAA0B,GACtC,OAAO,CAAC,aAAa,CAAC;IAOzB;;OAEG;IACG,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC;CAKjB"}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Estimates = void 0;
|
|
4
|
+
const BaseResource_1 = require("./BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* Estimates API resource
|
|
7
|
+
* Manages project estimates and estimate points
|
|
8
|
+
*/
|
|
9
|
+
class Estimates extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
// ===== ESTIMATE CRUD =====
|
|
14
|
+
/**
|
|
15
|
+
* Create a new estimate for a project
|
|
16
|
+
*/
|
|
17
|
+
async create(workspaceSlug, projectId, createEstimate) {
|
|
18
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/`, createEstimate);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Retrieve the estimate configured for a project
|
|
22
|
+
*/
|
|
23
|
+
async retrieve(workspaceSlug, projectId) {
|
|
24
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/`);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Update the estimate for a project
|
|
28
|
+
*/
|
|
29
|
+
async update(workspaceSlug, projectId, updateEstimate) {
|
|
30
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/`, updateEstimate);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Delete the estimate for a project
|
|
34
|
+
*/
|
|
35
|
+
async delete(workspaceSlug, projectId) {
|
|
36
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/`);
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Link an estimate to a project so it becomes the active estimate system.
|
|
40
|
+
* Delegates to the project update endpoint (PATCH .../projects/{projectId}).
|
|
41
|
+
*/
|
|
42
|
+
async linkToProject(workspaceSlug, projectId, estimateId) {
|
|
43
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/`, { estimate: estimateId });
|
|
44
|
+
}
|
|
45
|
+
// ===== ESTIMATE POINTS =====
|
|
46
|
+
/**
|
|
47
|
+
* List all estimate points for a project estimate
|
|
48
|
+
*/
|
|
49
|
+
async listPoints(workspaceSlug, projectId, estimateId) {
|
|
50
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/${estimateId}/estimate-points/`);
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Create estimate points for a project estimate.
|
|
54
|
+
* The API accepts a JSON array directly as the request body.
|
|
55
|
+
*/
|
|
56
|
+
async createPoints(workspaceSlug, projectId, estimateId, points) {
|
|
57
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/${estimateId}/estimate-points/`, points);
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Update a single estimate point
|
|
61
|
+
*/
|
|
62
|
+
async updatePoint(workspaceSlug, projectId, estimateId, estimatePointId, updatePoint) {
|
|
63
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/${estimateId}/estimate-points/${estimatePointId}/`, updatePoint);
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Delete a single estimate point
|
|
67
|
+
*/
|
|
68
|
+
async deletePoint(workspaceSlug, projectId, estimateId, estimatePointId) {
|
|
69
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/estimates/${estimateId}/estimate-points/${estimatePointId}/`);
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
exports.Estimates = Estimates;
|
|
73
|
+
//# sourceMappingURL=Estimates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Estimates.js","sourceRoot":"","sources":["../../src/api/Estimates.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAY9C;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IACzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED,4BAA4B;IAE5B;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAqC;QAC1F,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,aAAa,EAAE,cAAc,CAAC,CAAC;IAC9G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB;QACrD,OAAO,IAAI,CAAC,GAAG,CAAW,eAAe,aAAa,aAAa,SAAS,aAAa,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAAqC;QAC1F,OAAO,IAAI,CAAC,KAAK,CAAW,eAAe,aAAa,aAAa,SAAS,aAAa,EAAE,cAAc,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,aAAa,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QAC9E,OAAO,IAAI,CAAC,KAAK,CAAU,eAAe,aAAa,aAAa,SAAS,GAAG,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED,8BAA8B;IAE9B;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QAC3E,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,mBAAmB,CAC9F,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAoC;QAEpC,OAAO,IAAI,CAAC,IAAI,CACd,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,mBAAmB,EAC7F,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,eAAuB,EACvB,WAAuC;QAEvC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,oBAAoB,eAAe,GAAG,EAChH,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,eAAuB;QAEvB,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,oBAAoB,eAAe,GAAG,CACjH,CAAC;IACJ,CAAC;CACF;AAnGD,8BAmGC"}
|
package/dist/api/Intake.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { BaseResource } from "./BaseResource";
|
|
2
2
|
import { Configuration } from "../Configuration";
|
|
3
3
|
import { PaginatedResponse } from "../models/common";
|
|
4
|
-
import { IntakeWorkItem, IntakeWorkItemCreateRequest, UpdateIntakeWorkItemRequest } from "../models/Intake";
|
|
4
|
+
import { IntakeWorkItem, IntakeWorkItemCreateRequest, UpdateIntakeWorkItemRequest, UpdateIntakeStatusRequest } from "../models/Intake";
|
|
5
5
|
/**
|
|
6
6
|
* Intake API resource
|
|
7
7
|
* Handles all intake issue operations
|
|
@@ -24,6 +24,13 @@ export declare class Intake extends BaseResource {
|
|
|
24
24
|
* Update an intake issue
|
|
25
25
|
*/
|
|
26
26
|
update(workspaceSlug: string, projectId: string, intakeId: string, updateData: UpdateIntakeWorkItemRequest): Promise<IntakeWorkItem>;
|
|
27
|
+
/**
|
|
28
|
+
* Update the triage status of an intake work item.
|
|
29
|
+
*
|
|
30
|
+
* @param workItemId - UUID of the underlying work item (the `issue` field
|
|
31
|
+
* from the IntakeWorkItem response, not the intake issue ID)
|
|
32
|
+
*/
|
|
33
|
+
updateStatus(workspaceSlug: string, projectId: string, workItemId: string, statusData: UpdateIntakeStatusRequest): Promise<IntakeWorkItem>;
|
|
27
34
|
/**
|
|
28
35
|
* Delete an intake issue
|
|
29
36
|
*/
|
package/dist/api/Intake.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Intake.d.ts","sourceRoot":"","sources":["../../src/api/Intake.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,
|
|
1
|
+
{"version":3,"file":"Intake.d.ts","sourceRoot":"","sources":["../../src/api/Intake.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,cAAc,EACd,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,kBAAkB,CAAC;AAE1B;;;GAGG;AACH,qBAAa,MAAO,SAAQ,YAAY;gBAC1B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAInG;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAO9G;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,cAAc,CAAC;IAI1B;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,2BAA2B,GACtC,OAAO,CAAC,cAAc,CAAC;IAO1B;;;;;OAKG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,yBAAyB,GACpC,OAAO,CAAC,cAAc,CAAC;IAO1B;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGxF"}
|
package/dist/api/Intake.js
CHANGED
|
@@ -34,6 +34,15 @@ class Intake extends BaseResource_1.BaseResource {
|
|
|
34
34
|
async update(workspaceSlug, projectId, intakeId, updateData) {
|
|
35
35
|
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/intake-issues/${intakeId}/`, updateData);
|
|
36
36
|
}
|
|
37
|
+
/**
|
|
38
|
+
* Update the triage status of an intake work item.
|
|
39
|
+
*
|
|
40
|
+
* @param workItemId - UUID of the underlying work item (the `issue` field
|
|
41
|
+
* from the IntakeWorkItem response, not the intake issue ID)
|
|
42
|
+
*/
|
|
43
|
+
async updateStatus(workspaceSlug, projectId, workItemId, statusData) {
|
|
44
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/intake-issues/${workItemId}/status/`, statusData);
|
|
45
|
+
}
|
|
37
46
|
/**
|
|
38
47
|
* Delete an intake issue
|
|
39
48
|
*/
|
package/dist/api/Intake.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Intake.js","sourceRoot":"","sources":["../../src/api/Intake.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;
|
|
1
|
+
{"version":3,"file":"Intake.js","sourceRoot":"","sources":["../../src/api/Intake.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAU9C;;;GAGG;AACH,MAAa,MAAO,SAAQ,2BAAY;IACtC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,aAAa,SAAS,kBAAkB,QAAQ,GAAG,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,MAAY;QAC/D,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,iBAAiB,EACnE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAuC;QAEvC,OAAO,IAAI,CAAC,IAAI,CAAiB,eAAe,aAAa,aAAa,SAAS,iBAAiB,EAAE,UAAU,CAAC,CAAC;IACpH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,QAAgB,EAChB,UAAuC;QAEvC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,kBAAkB,QAAQ,GAAG,EAC/E,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,UAAqC;QAErC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,kBAAkB,UAAU,UAAU,EACxF,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QACrE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,kBAAkB,QAAQ,GAAG,CAAC,CAAC;IAC1G,CAAC;CACF;AAxED,wBAwEC"}
|
package/dist/api/Modules.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { BaseResource } from "./BaseResource";
|
|
2
2
|
import { Configuration } from "../Configuration";
|
|
3
3
|
import { PaginatedResponse } from "../models/common";
|
|
4
|
-
import { CreateModuleRequest, UpdateModuleRequest, Module, ListModulesParamsRequest } from "../models/Module";
|
|
5
|
-
import { WorkItem } from "../models/WorkItem";
|
|
4
|
+
import { CreateModuleRequest, UpdateModuleRequest, Module, ListModulesParamsRequest, ModuleLite, ListModulesLiteParams } from "../models/Module";
|
|
5
|
+
import { ListWorkItemsParams, WorkItem } from "../models/WorkItem";
|
|
6
6
|
/**
|
|
7
7
|
* Modules API resource
|
|
8
8
|
* Handles all module related operations
|
|
@@ -30,9 +30,17 @@ export declare class Modules extends BaseResource {
|
|
|
30
30
|
*/
|
|
31
31
|
list(workspaceSlug: string, projectId: string, params?: ListModulesParamsRequest): Promise<PaginatedResponse<Module>>;
|
|
32
32
|
/**
|
|
33
|
-
* List
|
|
33
|
+
* List modules as a paginated "lite" response, intended for pickers and
|
|
34
|
+
* reference lookups.
|
|
34
35
|
*/
|
|
35
|
-
|
|
36
|
+
listLite(workspaceSlug: string, projectId: string, params?: ListModulesLiteParams): Promise<PaginatedResponse<ModuleLite>>;
|
|
37
|
+
/**
|
|
38
|
+
* List work items in a module.
|
|
39
|
+
*
|
|
40
|
+
* Supports the same `filters` and `pql` query parameters as
|
|
41
|
+
* {@link WorkItems.list}.
|
|
42
|
+
*/
|
|
43
|
+
listWorkItemsInModule(workspaceSlug: string, projectId: string, moduleId: string, params?: ListWorkItemsParams): Promise<PaginatedResponse<WorkItem>>;
|
|
36
44
|
/**
|
|
37
45
|
* Add work items to module
|
|
38
46
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Modules.d.ts","sourceRoot":"","sources":["../../src/api/Modules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,
|
|
1
|
+
{"version":3,"file":"Modules.d.ts","sourceRoot":"","sources":["../../src/api/Modules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,MAAM,EACN,wBAAwB,EACxB,UAAU,EACV,qBAAqB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAGnE;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY;gBAC3B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1G;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3F;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,MAAM,CAAC;IAIlB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF;;OAEG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAIrC;;;OAGG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAOzC;;;;;OAKG;IACG,qBAAqB,CACzB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAOvC;;OAEG;IACG,oBAAoB,CACxB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,IAAI,CAAC;IAMhB;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAMhB;;OAEG;IACG,mBAAmB,CACvB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,GAAG,GACX,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAOrC;;OAEG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9F;;OAEG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAKjG"}
|
package/dist/api/Modules.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.Modules = void 0;
|
|
4
4
|
const BaseResource_1 = require("./BaseResource");
|
|
5
|
+
const WorkItems_1 = require("./WorkItems");
|
|
5
6
|
/**
|
|
6
7
|
* Modules API resource
|
|
7
8
|
* Handles all module related operations
|
|
@@ -41,10 +42,20 @@ class Modules extends BaseResource_1.BaseResource {
|
|
|
41
42
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/`, params);
|
|
42
43
|
}
|
|
43
44
|
/**
|
|
44
|
-
* List
|
|
45
|
+
* List modules as a paginated "lite" response, intended for pickers and
|
|
46
|
+
* reference lookups.
|
|
47
|
+
*/
|
|
48
|
+
async listLite(workspaceSlug, projectId, params) {
|
|
49
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/modules-lite/`, params);
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* List work items in a module.
|
|
53
|
+
*
|
|
54
|
+
* Supports the same `filters` and `pql` query parameters as
|
|
55
|
+
* {@link WorkItems.list}.
|
|
45
56
|
*/
|
|
46
57
|
async listWorkItemsInModule(workspaceSlug, projectId, moduleId, params) {
|
|
47
|
-
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/module-issues/`, params);
|
|
58
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/module-issues/`, (0, WorkItems_1.prepareWorkItemParams)(params));
|
|
48
59
|
}
|
|
49
60
|
/**
|
|
50
61
|
* Add work items to module
|
|
@@ -64,7 +75,7 @@ class Modules extends BaseResource_1.BaseResource {
|
|
|
64
75
|
* List archived modules
|
|
65
76
|
*/
|
|
66
77
|
async listArchivedModules(workspaceSlug, projectId, params) {
|
|
67
|
-
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/modules
|
|
78
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/archived-modules/`, params);
|
|
68
79
|
}
|
|
69
80
|
/**
|
|
70
81
|
* Archive a module
|
package/dist/api/Modules.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Modules.js","sourceRoot":"","sources":["../../src/api/Modules.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;
|
|
1
|
+
{"version":3,"file":"Modules.js","sourceRoot":"","sources":["../../src/api/Modules.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAY9C,2CAAoD;AAEpD;;;GAGG;AACH,MAAa,OAAQ,SAAQ,2BAAY;IACvC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,YAAiC;QACtF,OAAO,IAAI,CAAC,IAAI,CAAS,eAAe,aAAa,aAAa,SAAS,WAAW,EAAE,YAAY,CAAC,CAAC;IACxG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QACvE,OAAO,IAAI,CAAC,GAAG,CAAS,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,GAAG,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,QAAgB,EAChB,YAAiC;QAEjC,OAAO,IAAI,CAAC,KAAK,CAAS,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,GAAG,EAAE,YAAY,CAAC,CAAC;IACrH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QACrE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,GAAG,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,MAAiC;QAEjC,OAAO,IAAI,CAAC,GAAG,CAA4B,eAAe,aAAa,aAAa,SAAS,WAAW,EAAE,MAAM,CAAC,CAAC;IACpH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,gBAAgB,EAClE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,aAAqB,EACrB,SAAiB,EACjB,QAAgB,EAChB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,iBAAiB,EACvF,IAAA,iCAAqB,EAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,SAAiB,EACjB,QAAgB,EAChB,WAAqB;QAErB,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,iBAAiB,EAAE;YAC9G,MAAM,EAAE,WAAW;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAqB,EACrB,SAAiB,EACjB,QAAgB,EAChB,UAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,kBAAkB,UAAU,GAAG,CACtG,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,aAAqB,EACrB,SAAiB,EACjB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,oBAAoB,EACtE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QAC5E,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,YAAY,QAAQ,WAAW,CAAC,CAAC;IAC5G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,aAAqB,EAAE,SAAiB,EAAE,QAAgB;QAC9E,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,qBAAqB,QAAQ,aAAa,CAC7F,CAAC;IACJ,CAAC;CACF;AA3ID,0BA2IC"}
|
package/dist/api/Pages.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { BaseResource } from "./BaseResource";
|
|
2
2
|
import { Configuration } from "../Configuration";
|
|
3
|
-
import { Page, CreatePage } from "../models/Page";
|
|
3
|
+
import { Page, CreatePage, UpdatePage } from "../models/Page";
|
|
4
|
+
import { PaginatedResponse } from "../models/common";
|
|
4
5
|
/**
|
|
5
6
|
* Pages API resource
|
|
6
7
|
* Handles both workspace and project page operations
|
|
@@ -15,6 +16,33 @@ export declare class Pages extends BaseResource {
|
|
|
15
16
|
* Get a workspace page by ID
|
|
16
17
|
*/
|
|
17
18
|
getWorkspacePage(workspaceSlug: string, pageId: string): Promise<Page>;
|
|
19
|
+
/**
|
|
20
|
+
* List workspace pages
|
|
21
|
+
*/
|
|
22
|
+
listWorkspacePages(workspaceSlug: string, params?: any): Promise<PaginatedResponse<Page>>;
|
|
23
|
+
/**
|
|
24
|
+
* Update a workspace page's name, content, or both. A page that is locked or
|
|
25
|
+
* archived is refused.
|
|
26
|
+
*
|
|
27
|
+
* Content is written through Plane's live collaboration service, which owns the
|
|
28
|
+
* document. If it is unreachable the API answers 502 and nothing is written,
|
|
29
|
+
* rather than leaving the editor showing the old text.
|
|
30
|
+
*/
|
|
31
|
+
updateWorkspacePage(workspaceSlug: string, pageId: string, updatePage: UpdatePage): Promise<Page>;
|
|
32
|
+
/**
|
|
33
|
+
* Archive a workspace page. Archiving is the reversible step the API requires
|
|
34
|
+
* before a page can be deleted.
|
|
35
|
+
*/
|
|
36
|
+
archiveWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
|
|
37
|
+
/**
|
|
38
|
+
* Restore an archived workspace page
|
|
39
|
+
*/
|
|
40
|
+
unarchiveWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* Delete a workspace page. The page must be archived first; the API answers 400
|
|
43
|
+
* "The page should be archived before deleting" otherwise.
|
|
44
|
+
*/
|
|
45
|
+
deleteWorkspacePage(workspaceSlug: string, pageId: string): Promise<void>;
|
|
18
46
|
/**
|
|
19
47
|
* Create a project page
|
|
20
48
|
*/
|
|
@@ -23,6 +51,33 @@ export declare class Pages extends BaseResource {
|
|
|
23
51
|
* Get a project page by ID
|
|
24
52
|
*/
|
|
25
53
|
getProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<Page>;
|
|
54
|
+
/**
|
|
55
|
+
* List project pages
|
|
56
|
+
*/
|
|
57
|
+
listProjectPages(workspaceSlug: string, projectId: string, params?: any): Promise<PaginatedResponse<Page>>;
|
|
58
|
+
/**
|
|
59
|
+
* Update a project page's name, content, or both. A page that is locked or
|
|
60
|
+
* archived is refused.
|
|
61
|
+
*
|
|
62
|
+
* Content is written through Plane's live collaboration service, which owns the
|
|
63
|
+
* document. If it is unreachable the API answers 502 and nothing is written,
|
|
64
|
+
* rather than leaving the editor showing the old text.
|
|
65
|
+
*/
|
|
66
|
+
updateProjectPage(workspaceSlug: string, projectId: string, pageId: string, updatePage: UpdatePage): Promise<Page>;
|
|
67
|
+
/**
|
|
68
|
+
* Archive a project page. Archiving is the reversible step the API requires
|
|
69
|
+
* before a page can be deleted.
|
|
70
|
+
*/
|
|
71
|
+
archiveProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
|
|
72
|
+
/**
|
|
73
|
+
* Restore an archived project page
|
|
74
|
+
*/
|
|
75
|
+
unarchiveProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
|
|
76
|
+
/**
|
|
77
|
+
* Delete a project page. The page must be archived first; the API answers 400
|
|
78
|
+
* "The page should be archived before deleting" otherwise.
|
|
79
|
+
*/
|
|
80
|
+
deleteProjectPage(workspaceSlug: string, projectId: string, pageId: string): Promise<void>;
|
|
26
81
|
/**
|
|
27
82
|
* Retrieve workspace page
|
|
28
83
|
*/
|
package/dist/api/Pages.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Pages.d.ts","sourceRoot":"","sources":["../../src/api/Pages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"Pages.d.ts","sourceRoot":"","sources":["../../src/api/Pages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF;;OAEG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5E;;OAEG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAI/F;;;;;;;OAOG;IACG,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvG;;;OAGG;IACG,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhF;;OAEG;IACG,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlF;;;OAGG;IACG,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/E;;OAEG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;OAEG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7F;;OAEG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAIhH;;;;;;;OAOG;IACG,iBAAiB,CACrB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,IAAI,CAAC;IAIhB;;;OAGG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjG;;OAEG;IACG,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAInG;;;OAGG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhG;;OAEG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjF;;OAEG;IACG,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGnG"}
|
package/dist/api/Pages.js
CHANGED
|
@@ -23,6 +23,43 @@ class Pages extends BaseResource_1.BaseResource {
|
|
|
23
23
|
async getWorkspacePage(workspaceSlug, pageId) {
|
|
24
24
|
return this.get(`/workspaces/${workspaceSlug}/pages/${pageId}/`);
|
|
25
25
|
}
|
|
26
|
+
/**
|
|
27
|
+
* List workspace pages
|
|
28
|
+
*/
|
|
29
|
+
async listWorkspacePages(workspaceSlug, params) {
|
|
30
|
+
return this.get(`/workspaces/${workspaceSlug}/pages/`, params);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Update a workspace page's name, content, or both. A page that is locked or
|
|
34
|
+
* archived is refused.
|
|
35
|
+
*
|
|
36
|
+
* Content is written through Plane's live collaboration service, which owns the
|
|
37
|
+
* document. If it is unreachable the API answers 502 and nothing is written,
|
|
38
|
+
* rather than leaving the editor showing the old text.
|
|
39
|
+
*/
|
|
40
|
+
async updateWorkspacePage(workspaceSlug, pageId, updatePage) {
|
|
41
|
+
return this.put(`/workspaces/${workspaceSlug}/pages/${pageId}/`, updatePage);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Archive a workspace page. Archiving is the reversible step the API requires
|
|
45
|
+
* before a page can be deleted.
|
|
46
|
+
*/
|
|
47
|
+
async archiveWorkspacePage(workspaceSlug, pageId) {
|
|
48
|
+
return this.post(`/workspaces/${workspaceSlug}/pages/${pageId}/archive/`);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Restore an archived workspace page
|
|
52
|
+
*/
|
|
53
|
+
async unarchiveWorkspacePage(workspaceSlug, pageId) {
|
|
54
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/pages/${pageId}/archive/`);
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Delete a workspace page. The page must be archived first; the API answers 400
|
|
58
|
+
* "The page should be archived before deleting" otherwise.
|
|
59
|
+
*/
|
|
60
|
+
async deleteWorkspacePage(workspaceSlug, pageId) {
|
|
61
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/pages/${pageId}/`);
|
|
62
|
+
}
|
|
26
63
|
// ===== PROJECT PAGES API METHODS =====
|
|
27
64
|
/**
|
|
28
65
|
* Create a project page
|
|
@@ -36,6 +73,43 @@ class Pages extends BaseResource_1.BaseResource {
|
|
|
36
73
|
async getProjectPage(workspaceSlug, projectId, pageId) {
|
|
37
74
|
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/`);
|
|
38
75
|
}
|
|
76
|
+
/**
|
|
77
|
+
* List project pages
|
|
78
|
+
*/
|
|
79
|
+
async listProjectPages(workspaceSlug, projectId, params) {
|
|
80
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/`, params);
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Update a project page's name, content, or both. A page that is locked or
|
|
84
|
+
* archived is refused.
|
|
85
|
+
*
|
|
86
|
+
* Content is written through Plane's live collaboration service, which owns the
|
|
87
|
+
* document. If it is unreachable the API answers 502 and nothing is written,
|
|
88
|
+
* rather than leaving the editor showing the old text.
|
|
89
|
+
*/
|
|
90
|
+
async updateProjectPage(workspaceSlug, projectId, pageId, updatePage) {
|
|
91
|
+
return this.put(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/`, updatePage);
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Archive a project page. Archiving is the reversible step the API requires
|
|
95
|
+
* before a page can be deleted.
|
|
96
|
+
*/
|
|
97
|
+
async archiveProjectPage(workspaceSlug, projectId, pageId) {
|
|
98
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/archive/`);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Restore an archived project page
|
|
102
|
+
*/
|
|
103
|
+
async unarchiveProjectPage(workspaceSlug, projectId, pageId) {
|
|
104
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/archive/`);
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Delete a project page. The page must be archived first; the API answers 400
|
|
108
|
+
* "The page should be archived before deleting" otherwise.
|
|
109
|
+
*/
|
|
110
|
+
async deleteProjectPage(workspaceSlug, projectId, pageId) {
|
|
111
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/`);
|
|
112
|
+
}
|
|
39
113
|
/**
|
|
40
114
|
* Retrieve workspace page
|
|
41
115
|
*/
|