@makeplane/plane-node-sdk 0.2.11 → 0.2.12
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 +14 -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 +9 -0
- package/dist/api/Pages.d.ts.map +1 -1
- package/dist/api/Pages.js +12 -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/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/States.d.ts +19 -0
- package/dist/api/Workflows/States.d.ts.map +1 -0
- package/dist/api/Workflows/States.js +27 -0
- package/dist/api/Workflows/States.js.map +1 -0
- package/dist/api/Workflows/Transitions.d.ts +28 -0
- package/dist/api/Workflows/Transitions.d.ts.map +1 -0
- package/dist/api/Workflows/Transitions.js +61 -0
- package/dist/api/Workflows/Transitions.js.map +1 -0
- package/dist/api/Workflows/index.d.ts +27 -0
- package/dist/api/Workflows/index.d.ts.map +1 -0
- package/dist/api/Workflows/index.js +38 -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/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/client/plane-client.d.ts +24 -2
- package/dist/client/plane-client.d.ts.map +1 -1
- package/dist/client/plane-client.js +24 -2
- package/dist/client/plane-client.js.map +1 -1
- package/dist/index.d.ts +33 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +68 -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 +6 -1
- package/dist/models/Page.d.ts.map +1 -1
- package/dist/models/Project.d.ts +26 -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/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/Workflow.d.ts +30 -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/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/index.d.ts +12 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +12 -0
- package/dist/models/index.js.map +1 -1
- package/dist/types.bundle.d.ts +2236 -560
- 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,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"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.WorkItems = void 0;
|
|
4
|
+
exports.prepareWorkItemParams = prepareWorkItemParams;
|
|
4
5
|
const BaseResource_1 = require("../BaseResource");
|
|
5
6
|
const Links_1 = require("../Links");
|
|
6
7
|
const Relations_1 = require("./Relations");
|
|
@@ -8,6 +9,28 @@ const Attachments_1 = require("./Attachments");
|
|
|
8
9
|
const Comments_1 = require("./Comments");
|
|
9
10
|
const Activities_1 = require("./Activities");
|
|
10
11
|
const WorkLogs_1 = require("./WorkLogs");
|
|
12
|
+
const Dependencies_1 = require("./Dependencies");
|
|
13
|
+
const CustomRelations_1 = require("./CustomRelations");
|
|
14
|
+
const Pages_1 = require("./Pages");
|
|
15
|
+
/**
|
|
16
|
+
* Prepare query params for work-item list endpoints.
|
|
17
|
+
*
|
|
18
|
+
* The backend's `filters=` query parameter expects a JSON-encoded string, not
|
|
19
|
+
* an exploded object — so we stringify it here before letting axios URL-encode
|
|
20
|
+
* the result into a single query value. Everything else passes through
|
|
21
|
+
* unchanged.
|
|
22
|
+
*
|
|
23
|
+
* Exported for reuse from sibling resources (Cycles, Modules) that list work
|
|
24
|
+
* items.
|
|
25
|
+
*/
|
|
26
|
+
function prepareWorkItemParams(params) {
|
|
27
|
+
if (!params)
|
|
28
|
+
return undefined;
|
|
29
|
+
if (params.filters === undefined)
|
|
30
|
+
return params;
|
|
31
|
+
const { filters, ...rest } = params;
|
|
32
|
+
return { ...rest, filters: JSON.stringify(filters) };
|
|
33
|
+
}
|
|
11
34
|
/**
|
|
12
35
|
* WorkItems API resource
|
|
13
36
|
* Handles all work item (issue) related operations
|
|
@@ -21,6 +44,9 @@ class WorkItems extends BaseResource_1.BaseResource {
|
|
|
21
44
|
this.comments = new Comments_1.Comments(config);
|
|
22
45
|
this.activities = new Activities_1.Activities(config);
|
|
23
46
|
this.workLogs = new WorkLogs_1.WorkLogs(config);
|
|
47
|
+
this.dependencies = new Dependencies_1.Dependencies(config);
|
|
48
|
+
this.customRelations = new CustomRelations_1.CustomRelations(config);
|
|
49
|
+
this.pages = new Pages_1.Pages(config);
|
|
24
50
|
}
|
|
25
51
|
/**
|
|
26
52
|
* Create a new work item
|
|
@@ -49,10 +75,65 @@ class WorkItems extends BaseResource_1.BaseResource {
|
|
|
49
75
|
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/`);
|
|
50
76
|
}
|
|
51
77
|
/**
|
|
52
|
-
* List work items with optional filtering
|
|
78
|
+
* List work items in a project with optional filtering.
|
|
79
|
+
*
|
|
80
|
+
* Supports rich filtering via `filters` (a structured object, JSON-encoded
|
|
81
|
+
* into a single `filters=` query param) and `pql` (Plane Query Language).
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```ts
|
|
85
|
+
* await client.workItems.list("my-workspace", "project-id", {
|
|
86
|
+
* filters: { and: [{ priority: "urgent" }, { state_group__in: ["unstarted", "started"] }] },
|
|
87
|
+
* order_by: "-created_at",
|
|
88
|
+
* per_page: 50,
|
|
89
|
+
* });
|
|
90
|
+
* ```
|
|
53
91
|
*/
|
|
54
92
|
async list(workspaceSlug, projectId, params) {
|
|
55
|
-
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/`, params);
|
|
93
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/`, prepareWorkItemParams(params));
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* List work items across an entire workspace.
|
|
97
|
+
*
|
|
98
|
+
* Returns a paginated envelope of work items the caller can view, spanning
|
|
99
|
+
* every project in the workspace (per-project authorization is honored
|
|
100
|
+
* server-side). Supports the same `filters` and `pql` query params as
|
|
101
|
+
* {@link WorkItems.list}, plus `order_by`, `cursor`, `per_page`, `fields`,
|
|
102
|
+
* and `expand`.
|
|
103
|
+
*/
|
|
104
|
+
async listWorkspace(workspaceSlug, params) {
|
|
105
|
+
return this.get(`/workspaces/${workspaceSlug}/work-items/`, prepareWorkItemParams(params));
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Return the count of work items across an entire workspace.
|
|
109
|
+
*
|
|
110
|
+
* Supports `filters`, `pql`, `group_by`, and `sub_group_by` query params.
|
|
111
|
+
* `grouped_counts` keys are raw ORM field values: UUID strings for FK/M2M
|
|
112
|
+
* dimensions, plain strings for `priority` / `state__group`, ISO-date strings
|
|
113
|
+
* for `target_date` / `start_date`. "None" is used for empty values.
|
|
114
|
+
*/
|
|
115
|
+
async countWorkspace(workspaceSlug, params) {
|
|
116
|
+
return this.get(`/workspaces/${workspaceSlug}/work-items/count/`, params);
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* List archived work items in a project.
|
|
120
|
+
* Supports the same `filters` and `pql` query parameters as list().
|
|
121
|
+
*/
|
|
122
|
+
async listArchived(workspaceSlug, projectId, params) {
|
|
123
|
+
return this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/archived-work-items/`, prepareWorkItemParams(params));
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* Archive a work item.
|
|
127
|
+
* Only work items in a completed or cancelled state can be archived.
|
|
128
|
+
*/
|
|
129
|
+
async archive(workspaceSlug, projectId, workItemId) {
|
|
130
|
+
await this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/archive/`, {});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Unarchive a work item — restore it to active status.
|
|
134
|
+
*/
|
|
135
|
+
async unarchive(workspaceSlug, projectId, workItemId) {
|
|
136
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/work-items/${workItemId}/unarchive/`);
|
|
56
137
|
}
|
|
57
138
|
// Implementation
|
|
58
139
|
async retrieveByIdentifier(workspaceSlug, identifier, expand) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/WorkItems/index.ts"],"names":[],"mappings":";;;AAqCA,sDAKC;AA1CD,kDAA+C;AAgB/C,oCAAiC;AACjC,2CAAwC;AACxC,+CAA4C;AAC5C,yCAAsC;AACtC,6CAA0C;AAC1C,yCAAsC;AACtC,iDAA8C;AAC9C,uDAAoD;AACpD,mCAAgC;AAEhC;;;;;;;;;;GAUG;AACH,SAAgB,qBAAqB,CAAC,MAA4B;IAChE,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,MAAiC,CAAC;IAC3E,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;IACpC,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAWzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,2BAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,cAA8B;QACnF,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,EAAE,cAAc,CAAC,CAAC;IAC/G,CAAC;IAYD;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAAE;YAC3G,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,cAA8B;QAE9B,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,EAC9E,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACvE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,GAAG,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,cAAc,EAChE,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,MAA4B;QACrE,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,EAC1C,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,MAA4B;QACtE,OAAO,IAAI,CAAC,GAAG,CAAwB,eAAe,aAAa,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,aAAqB,EACrB,SAAiB,EACjB,MAA4B;QAE5B,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,aAAa,SAAS,uBAAuB,EACzE,qBAAqB,CAAC,MAAM,CAAC,CAC9B,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACxE,MAAM,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,WAAW,EAAE,EAAE,CAAC,CAAC;IACpH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QAC1E,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,SAAS,eAAe,UAAU,aAAa,CAAC,CAAC;IACnH,CAAC;IAWD,iBAAiB;IACjB,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,UAAkB,EAClB,MAAY;QAEZ,OAAO,IAAI,CAAC,GAAG,CAAc,eAAe,aAAa,eAAe,UAAU,GAAG,EAAE;YACrF,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,KAAa,EAAE,SAAkB,EAAE,MAAY;QACjF,OAAO,IAAI,CAAC,GAAG,CAAiB,eAAe,aAAa,qBAAqB,EAAE;YACjF,GAAG,MAAM;YACT,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,SAAS;SACnB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,IAA4B;QACtE,OAAO,IAAI,CAAC,IAAI,CAAyB,eAAe,aAAa,8BAA8B,EAAE,IAAI,CAAC,CAAC;IAC7G,CAAC;CACF;AAzMD,8BAyMC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { AttachWorkflowStates } from "../../models/Workflow";
|
|
4
|
+
/**
|
|
5
|
+
* WorkflowStates sub-resource
|
|
6
|
+
* Manages state attachments on a workflow
|
|
7
|
+
*/
|
|
8
|
+
export declare class States extends BaseResource {
|
|
9
|
+
constructor(config: Configuration);
|
|
10
|
+
/**
|
|
11
|
+
* Attach states to a workflow
|
|
12
|
+
*/
|
|
13
|
+
attach(workspaceSlug: string, projectId: string, workflowId: string, data: AttachWorkflowStates): Promise<void>;
|
|
14
|
+
/**
|
|
15
|
+
* Detach a state from a workflow
|
|
16
|
+
*/
|
|
17
|
+
detach(workspaceSlug: string, projectId: string, workflowId: string, stateId: string): Promise<void>;
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=States.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"States.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/States.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;GAGG;AACH,qBAAa,MAAO,SAAQ,YAAY;gBAC1B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,oBAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;IAIhB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAK3G"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.States = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* WorkflowStates sub-resource
|
|
7
|
+
* Manages state attachments on a workflow
|
|
8
|
+
*/
|
|
9
|
+
class States extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Attach states to a workflow
|
|
15
|
+
*/
|
|
16
|
+
async attach(workspaceSlug, projectId, workflowId, data) {
|
|
17
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/`, data);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Detach a state from a workflow
|
|
21
|
+
*/
|
|
22
|
+
async detach(workspaceSlug, projectId, workflowId, stateId) {
|
|
23
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/states/${stateId}/`);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
exports.States = States;
|
|
27
|
+
//# sourceMappingURL=States.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"States.js","sourceRoot":"","sources":["../../../src/api/Workflows/States.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAI/C;;;GAGG;AACH,MAAa,MAAO,SAAQ,2BAAY;IACtC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,IAA0B;QAE1B,OAAO,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,UAAU,EAAE,IAAI,CAAC,CAAC;IACrH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,OAAe;QACxF,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,WAAW,OAAO,GAAG,CAChG,CAAC;IACJ,CAAC;CACF;AAzBD,wBAyBC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkflowTransition, UpdateWorkflowTransition, WorkflowTransition } from "../../models/Workflow";
|
|
4
|
+
/**
|
|
5
|
+
* WorkflowTransitions sub-resource
|
|
6
|
+
* Manages state transitions within a workflow
|
|
7
|
+
*/
|
|
8
|
+
export declare class Transitions extends BaseResource {
|
|
9
|
+
constructor(config: Configuration);
|
|
10
|
+
/**
|
|
11
|
+
* List all state transitions for a workflow
|
|
12
|
+
*/
|
|
13
|
+
list(workspaceSlug: string, projectId: string, workflowId: string): Promise<WorkflowTransition[]>;
|
|
14
|
+
/**
|
|
15
|
+
* Create a state transition for a workflow.
|
|
16
|
+
* Returns null if the transition already exists (HTTP 400 "already exists").
|
|
17
|
+
*/
|
|
18
|
+
create(workspaceSlug: string, projectId: string, workflowId: string, data: CreateWorkflowTransition): Promise<WorkflowTransition | null>;
|
|
19
|
+
/**
|
|
20
|
+
* Update a workflow state transition
|
|
21
|
+
*/
|
|
22
|
+
update(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string, data: UpdateWorkflowTransition): Promise<WorkflowTransition>;
|
|
23
|
+
/**
|
|
24
|
+
* Delete a workflow state transition
|
|
25
|
+
*/
|
|
26
|
+
del(workspaceSlug: string, projectId: string, workflowId: string, transitionId: string): Promise<void>;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=Transitions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Transitions.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/Transitions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE/G;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBAC/B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAOvG;;;OAGG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;IA0BrC;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,kBAAkB,CAAC;IAO9B;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAK7G"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Transitions = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
const errors_1 = require("../../errors");
|
|
6
|
+
/**
|
|
7
|
+
* WorkflowTransitions sub-resource
|
|
8
|
+
* Manages state transitions within a workflow
|
|
9
|
+
*/
|
|
10
|
+
class Transitions extends BaseResource_1.BaseResource {
|
|
11
|
+
constructor(config) {
|
|
12
|
+
super(config);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* List all state transitions for a workflow
|
|
16
|
+
*/
|
|
17
|
+
async list(workspaceSlug, projectId, workflowId) {
|
|
18
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/`);
|
|
19
|
+
return Array.isArray(data) ? data : data.results;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Create a state transition for a workflow.
|
|
23
|
+
* Returns null if the transition already exists (HTTP 400 "already exists").
|
|
24
|
+
*/
|
|
25
|
+
async create(workspaceSlug, projectId, workflowId, data) {
|
|
26
|
+
try {
|
|
27
|
+
return await this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/`, data);
|
|
28
|
+
}
|
|
29
|
+
catch (error) {
|
|
30
|
+
if (error instanceof errors_1.HttpError && error.statusCode === 400) {
|
|
31
|
+
const response = error.response;
|
|
32
|
+
const body = typeof response === "string"
|
|
33
|
+
? response.toLowerCase()
|
|
34
|
+
: typeof response === "object" &&
|
|
35
|
+
response !== null &&
|
|
36
|
+
"detail" in response &&
|
|
37
|
+
typeof response.detail === "string"
|
|
38
|
+
? response.detail.toLowerCase()
|
|
39
|
+
: "";
|
|
40
|
+
if (body.includes("already exists")) {
|
|
41
|
+
return null;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
throw error;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Update a workflow state transition
|
|
49
|
+
*/
|
|
50
|
+
async update(workspaceSlug, projectId, workflowId, transitionId, data) {
|
|
51
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/${transitionId}/`, data);
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Delete a workflow state transition
|
|
55
|
+
*/
|
|
56
|
+
async del(workspaceSlug, projectId, workflowId, transitionId) {
|
|
57
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/state-transitions/${transitionId}/`);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.Transitions = Transitions;
|
|
61
|
+
//# sourceMappingURL=Transitions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Transitions.js","sourceRoot":"","sources":["../../../src/api/Workflows/Transitions.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAE/C,yCAAyC;AAGzC;;;GAGG;AACH,MAAa,WAAY,SAAQ,2BAAY;IAC3C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB;QACrE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,qBAAqB,CAChG,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,IAA8B;QAE9B,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,IAAI,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,qBAAqB,EAC/F,IAAI,CACL,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,kBAAS,IAAI,KAAK,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAC3D,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAmB,CAAC;gBAC3C,MAAM,IAAI,GACR,OAAO,QAAQ,KAAK,QAAQ;oBAC1B,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE;oBACxB,CAAC,CAAC,OAAO,QAAQ,KAAK,QAAQ;wBAC1B,QAAQ,KAAK,IAAI;wBACjB,QAAQ,IAAI,QAAQ;wBACpB,OAAQ,QAAgC,CAAC,MAAM,KAAK,QAAQ;wBAC9D,CAAC,CAAE,QAA+B,CAAC,MAAM,CAAC,WAAW,EAAE;wBACvD,CAAC,CAAC,EAAE,CAAC;gBACX,IAAI,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACpC,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,SAAiB,EACjB,UAAkB,EAClB,YAAoB,EACpB,IAA8B;QAE9B,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,sBAAsB,YAAY,GAAG,EAC/G,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,YAAoB;QAC1F,OAAO,IAAI,CAAC,UAAU,CACpB,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,sBAAsB,YAAY,GAAG,CAChH,CAAC;IACJ,CAAC;CACF;AA1ED,kCA0EC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CreateWorkflow, UpdateWorkflow, Workflow } from "../../models/Workflow";
|
|
4
|
+
import { States } from "./States";
|
|
5
|
+
import { Transitions } from "./Transitions";
|
|
6
|
+
/**
|
|
7
|
+
* Workflows API resource
|
|
8
|
+
* Handles project workflow operations and exposes states/transitions sub-resources
|
|
9
|
+
*/
|
|
10
|
+
export declare class Workflows extends BaseResource {
|
|
11
|
+
states: States;
|
|
12
|
+
transitions: Transitions;
|
|
13
|
+
constructor(config: Configuration);
|
|
14
|
+
/**
|
|
15
|
+
* List all workflows for a project
|
|
16
|
+
*/
|
|
17
|
+
list(workspaceSlug: string, projectId: string): Promise<Workflow[]>;
|
|
18
|
+
/**
|
|
19
|
+
* Create a new workflow for a project
|
|
20
|
+
*/
|
|
21
|
+
create(workspaceSlug: string, projectId: string, data: CreateWorkflow): Promise<Workflow>;
|
|
22
|
+
/**
|
|
23
|
+
* Update a workflow by ID
|
|
24
|
+
*/
|
|
25
|
+
update(workspaceSlug: string, projectId: string, workflowId: string, data: UpdateWorkflow): Promise<Workflow>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/Workflows/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,WAAW,CAAC;gBAEpB,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOzE;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI/F;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAGpH"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Workflows = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
const States_1 = require("./States");
|
|
6
|
+
const Transitions_1 = require("./Transitions");
|
|
7
|
+
/**
|
|
8
|
+
* Workflows API resource
|
|
9
|
+
* Handles project workflow operations and exposes states/transitions sub-resources
|
|
10
|
+
*/
|
|
11
|
+
class Workflows extends BaseResource_1.BaseResource {
|
|
12
|
+
constructor(config) {
|
|
13
|
+
super(config);
|
|
14
|
+
this.states = new States_1.States(config);
|
|
15
|
+
this.transitions = new Transitions_1.Transitions(config);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* List all workflows for a project
|
|
19
|
+
*/
|
|
20
|
+
async list(workspaceSlug, projectId) {
|
|
21
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/`);
|
|
22
|
+
return Array.isArray(data) ? data : data.results;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Create a new workflow for a project
|
|
26
|
+
*/
|
|
27
|
+
async create(workspaceSlug, projectId, data) {
|
|
28
|
+
return this.post(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/`, data);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Update a workflow by ID
|
|
32
|
+
*/
|
|
33
|
+
async update(workspaceSlug, projectId, workflowId, data) {
|
|
34
|
+
return this.patch(`/workspaces/${workspaceSlug}/projects/${projectId}/workflows/${workflowId}/`, data);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.Workflows = Workflows;
|
|
38
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Workflows/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAG/C,qCAAkC;AAClC,+CAA4C;AAE5C;;;GAGG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAIzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,SAAiB;QACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,aAAa,SAAS,aAAa,CAChE,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,IAAoB;QACzE,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,SAAS,aAAa,EAAE,IAAI,CAAC,CAAC;IACpG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,SAAiB,EAAE,UAAkB,EAAE,IAAoB;QAC7F,OAAO,IAAI,CAAC,KAAK,CAAW,eAAe,aAAa,aAAa,SAAS,cAAc,UAAU,GAAG,EAAE,IAAI,CAAC,CAAC;IACnH,CAAC;CACF;AAjCD,8BAiCC"}
|
package/dist/api/Workspace.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { BaseResource } from "./BaseResource";
|
|
2
2
|
import { Configuration } from "../Configuration";
|
|
3
|
-
import {
|
|
3
|
+
import { WorkspaceMember, ListMembersLiteParams, ProjectRoleDistribution } from "../models/Member";
|
|
4
|
+
import { PaginatedResponse } from "../models/common";
|
|
4
5
|
import { UpdateWorkspaceFeatures, WorkspaceFeatures } from "../models/WorkspaceFeatures";
|
|
5
6
|
/**
|
|
6
7
|
* Workspace API resource
|
|
@@ -9,9 +10,21 @@ import { UpdateWorkspaceFeatures, WorkspaceFeatures } from "../models/WorkspaceF
|
|
|
9
10
|
export declare class Workspace extends BaseResource {
|
|
10
11
|
constructor(config: Configuration);
|
|
11
12
|
/**
|
|
12
|
-
* Get workspace members
|
|
13
|
+
* Get workspace members with their role information.
|
|
13
14
|
*/
|
|
14
|
-
getMembers(workspaceSlug: string): Promise<
|
|
15
|
+
getMembers(workspaceSlug: string): Promise<WorkspaceMember[]>;
|
|
16
|
+
/**
|
|
17
|
+
* List workspace members as a paginated "lite" response.
|
|
18
|
+
* Unlike getMembers() (which returns a bare list), this returns a
|
|
19
|
+
* cursor-paginated envelope.
|
|
20
|
+
*/
|
|
21
|
+
getMembersLite(workspaceSlug: string, params?: ListMembersLiteParams): Promise<PaginatedResponse<WorkspaceMember>>;
|
|
22
|
+
/**
|
|
23
|
+
* Aggregate count of project members by role across the workspace.
|
|
24
|
+
* Counts span all active (non-archived) projects and include both built-in
|
|
25
|
+
* and custom roles.
|
|
26
|
+
*/
|
|
27
|
+
getProjectRoleDistribution(workspaceSlug: string): Promise<ProjectRoleDistribution>;
|
|
15
28
|
/**
|
|
16
29
|
* Retrieve workspace features
|
|
17
30
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"Workspace.d.ts","sourceRoot":"","sources":["../../src/api/Workspace.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AACnG,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEzF;;;GAGG;AACH,qBAAa,SAAU,SAAQ,YAAY;gBAC7B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAInE;;;;OAIG;IACG,cAAc,CAClB,aAAa,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAI9C;;;;OAIG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIzF;;OAEG;IACG,gBAAgB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIzE;;OAEG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAGjH"}
|