@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/README.md
CHANGED
|
@@ -63,7 +63,8 @@ const project = await client.projects.create("workspace-slug", {
|
|
|
63
63
|
- **Labels**: Issue categorization and tagging
|
|
64
64
|
- **States**: Workflow state management
|
|
65
65
|
- **Users**: User management and profiles
|
|
66
|
-
- **
|
|
66
|
+
- **Roles**: Workspace and project role definitions (read-only)
|
|
67
|
+
- **Estimates**: Project estimates and estimate points
|
|
67
68
|
- **Modules**: Feature organization and module management
|
|
68
69
|
- **Cycles**: Sprint and iteration management
|
|
69
70
|
- **Customers**: Customer management and operations
|
|
@@ -74,8 +75,23 @@ const project = await client.projects.create("workspace-slug", {
|
|
|
74
75
|
- **Intake**: Intake form and request management
|
|
75
76
|
- **Stickies**: Stickies management
|
|
76
77
|
- **Teamspaces**: Teamspace management
|
|
78
|
+
- **Milestones**: Milestone tracking and management
|
|
77
79
|
- **Initiatives**: Initiative management
|
|
80
|
+
- **WorkspaceTemplates**: Workspace-level work item, project, and page templates
|
|
81
|
+
- **WorkspaceWorkItemTypes**: Workspace-level work item type management with property links
|
|
82
|
+
- **WorkspaceWorkItemProperties**: Workspace-level custom property management with options
|
|
83
|
+
- **WorkspaceProjectLabels**: Workspace-level project label management
|
|
84
|
+
- **WorkspaceProjectStates**: Workspace-level project state management
|
|
85
|
+
- **WorkItemRelationDefinitions**: Custom work item relation type definitions
|
|
86
|
+
- **Releases**: Release management with tags, labels, item labels, changelog, comments, links, and work items
|
|
87
|
+
- **Collections**: Folders that group workspace pages, with member and page management
|
|
88
|
+
- **AgentRuns**: AI agent run orchestration and activity tracking
|
|
89
|
+
- **Workflows**: Project workflow management with state attachments, transitions, transition hooks, activities, and work item approvals
|
|
90
|
+
- **ProjectTemplates**: Work item and page template management per project
|
|
78
91
|
- **Features**: Workspace and project features management
|
|
92
|
+
- **WorkspaceStates**: Workspace-level (catalog) work-item states under workspace governance — dual-mode reads, governed-only writes
|
|
93
|
+
- **WorkspaceWorkflows**: Workspace-level workflow catalog under workspace governance, with chain (states), transitions, usage, activities, and transition hooks
|
|
94
|
+
- **WorkItemTypeGovernance**: Governs which workflows a workspace-level work item type may use (any/constrained/required modes), with per-project pins and the project-side pick/fallback-preview endpoints
|
|
79
95
|
|
|
80
96
|
## Development
|
|
81
97
|
|
|
@@ -34,7 +34,7 @@ export declare abstract class BaseResource {
|
|
|
34
34
|
/**
|
|
35
35
|
* DELETE request
|
|
36
36
|
*/
|
|
37
|
-
protected httpDelete(endpoint: string, data?: any): Promise<void>;
|
|
37
|
+
protected httpDelete(endpoint: string, data?: any, params?: any): Promise<void>;
|
|
38
38
|
/**
|
|
39
39
|
* Builds the complete URL for API requests
|
|
40
40
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseResource.d.ts","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD;;;GAGG;AACH,8BAAsB,YAAY;IAChC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAa;gBAE9B,MAAM,EAAE,aAAa;IAOjC;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAYlE;;OAEG;cACa,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWjE;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWhE;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWlE;;OAEG;cACa,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"BaseResource.d.ts","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD;;;GAGG;AACH,8BAAsB,YAAY;IAChC,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC;IAChC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAa;gBAE9B,MAAM,EAAE,aAAa;IAOjC;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAYlE;;OAEG;cACa,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWjE;;OAEG;cACa,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWhE;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;IAWlE;;OAEG;cACa,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrF;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI5C;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAkB9C;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK;IA8BxC;;OAEG;IACH,OAAO,CAAC,iBAAiB;CAmB1B"}
|
package/dist/api/BaseResource.js
CHANGED
|
@@ -107,11 +107,12 @@ class BaseResource {
|
|
|
107
107
|
/**
|
|
108
108
|
* DELETE request
|
|
109
109
|
*/
|
|
110
|
-
async httpDelete(endpoint, data) {
|
|
110
|
+
async httpDelete(endpoint, data, params) {
|
|
111
111
|
try {
|
|
112
112
|
await axios_1.default.delete(this.buildUrl(endpoint), {
|
|
113
113
|
headers: this.getHeaders(),
|
|
114
114
|
data,
|
|
115
|
+
params,
|
|
115
116
|
});
|
|
116
117
|
}
|
|
117
118
|
catch (error) {
|
|
@@ -145,7 +146,22 @@ class BaseResource {
|
|
|
145
146
|
* Centralized error handling
|
|
146
147
|
*/
|
|
147
148
|
handleError(error) {
|
|
148
|
-
|
|
149
|
+
if (this.config.enableLogging) {
|
|
150
|
+
if (axios_1.default.isAxiosError(error)) {
|
|
151
|
+
console.error("❌ [ERROR]", {
|
|
152
|
+
method: error.config?.method?.toUpperCase(),
|
|
153
|
+
url: error.config?.url,
|
|
154
|
+
status: error.response?.status,
|
|
155
|
+
headers: this.sanitizeHeaders(error.config?.headers),
|
|
156
|
+
requestData: error.config?.data ? this.sanitizeData(error.config.data) : undefined,
|
|
157
|
+
responseData: this.sanitizeData(error.response?.data),
|
|
158
|
+
message: error.message,
|
|
159
|
+
});
|
|
160
|
+
}
|
|
161
|
+
else {
|
|
162
|
+
console.error("❌ [ERROR]", error instanceof Error ? error.message : error);
|
|
163
|
+
}
|
|
164
|
+
}
|
|
149
165
|
if (error instanceof errors_1.HttpError) {
|
|
150
166
|
throw error;
|
|
151
167
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseResource.js","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0D;AAE1D,sCAAsC;AAEtC;;;GAGG;AACH,MAAsB,YAAY;IAIhC,YAAY,MAAqB;QAFvB,gBAAW,GAAW,SAAS,CAAC;QAGxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,OAAY;QAClC,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAC;QAE7B,MAAM,SAAS,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;QACjC,MAAM,aAAa,GAAG,CAAC,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE7E,0DAA0D;QAC1D,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBAC9C,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,IAAS;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAEvB,oCAAoC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,MAAY;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC3D,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1B,MAAM;aACP,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAI,CAAI,QAAgB,EAAE,IAAU;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBAClE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,IAAU;QACjD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACjE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,KAAK,CAAI,QAAgB,EAAE,IAAU;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,KAAK,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACnE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,IAAU;
|
|
1
|
+
{"version":3,"file":"BaseResource.js","sourceRoot":"","sources":["../../src/api/BaseResource.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0D;AAE1D,sCAAsC;AAEtC;;;GAGG;AACH,MAAsB,YAAY;IAIhC,YAAY,MAAqB;QAFvB,gBAAW,GAAW,SAAS,CAAC;QAGxC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,eAAe,CAAC,OAAY;QAClC,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,CAAC;QAE7B,MAAM,SAAS,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC;QACjC,MAAM,aAAa,GAAG,CAAC,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE7E,0DAA0D;QAC1D,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;gBAC9C,SAAS,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,IAAS;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAEvB,oCAAoC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,MAAY;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC3D,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1B,MAAM;aACP,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAI,CAAI,QAAgB,EAAE,IAAU;QAClD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBAClE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,GAAG,CAAI,QAAgB,EAAE,IAAU;QACjD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACjE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,KAAK,CAAI,QAAgB,EAAE,IAAU;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,KAAK,CAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE;gBACnE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;aAC3B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,IAAU,EAAE,MAAY;QACnE,IAAI,CAAC;YACH,MAAM,eAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;gBAC1C,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;gBAC1B,IAAI;gBACJ,MAAM;aACP,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED;;OAEG;IACO,QAAQ,CAAC,QAAgB;QACjC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,GAAG,QAAQ,EAAE,CAAC;IAChE,CAAC;IAED;;OAEG;IACO,UAAU;QAClB,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,kBAAkB;SACnC,CAAC;QAEF,2BAA2B;QAC3B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAC5C,CAAC;QAED,gCAAgC;QAChC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC5B,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACjE,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,KAAU;QAC9B,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;YAC9B,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC9B,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE;oBACzB,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE;oBAC3C,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG;oBACtB,MAAM,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM;oBAC9B,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC;oBACpD,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;oBAClF,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;oBACrD,OAAO,EAAE,KAAK,CAAC,OAAO;iBACvB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC;QAED,IAAI,KAAK,YAAY,kBAAS,EAAE,CAAC;YAC/B,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,CAAC;YACjD,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,IAAI,gBAAgB,CAAC;YACnF,MAAM,IAAI,kBAAS,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,sBAAsB;QACtB,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAC5B,CAAC,MAAkC,EAAE,EAAE;YACrC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;gBAC1B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE;gBACpC,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC7C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC9D,MAAM,EAAE,MAAM,CAAC,MAAM;aACtB,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAChB,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAxMD,oCAwMC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { CollectionMember, CreateCollectionMember, UpdateCollectionMember } from "../../models/Collection";
|
|
4
|
+
/**
|
|
5
|
+
* CollectionMembers sub-resource
|
|
6
|
+
* Manages members of a (typically private) collection
|
|
7
|
+
*/
|
|
8
|
+
export declare class Members extends BaseResource {
|
|
9
|
+
constructor(config: Configuration);
|
|
10
|
+
/**
|
|
11
|
+
* List members of a collection
|
|
12
|
+
*/
|
|
13
|
+
list(workspaceSlug: string, collectionId: string): Promise<CollectionMember[]>;
|
|
14
|
+
/**
|
|
15
|
+
* Add a member to a collection
|
|
16
|
+
*/
|
|
17
|
+
add(workspaceSlug: string, collectionId: string, memberData: CreateCollectionMember): Promise<CollectionMember>;
|
|
18
|
+
/**
|
|
19
|
+
* Update a collection member's access level.
|
|
20
|
+
*
|
|
21
|
+
* @param memberId - UUID of the CollectionMember row (not the user id)
|
|
22
|
+
*/
|
|
23
|
+
update(workspaceSlug: string, collectionId: string, memberId: string, memberData: UpdateCollectionMember): Promise<CollectionMember>;
|
|
24
|
+
/**
|
|
25
|
+
* Remove a member from a collection.
|
|
26
|
+
*
|
|
27
|
+
* @param memberId - UUID of the CollectionMember row (not the user id)
|
|
28
|
+
*/
|
|
29
|
+
remove(workspaceSlug: string, collectionId: string, memberId: string): Promise<void>;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=Members.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Members.d.ts","sourceRoot":"","sources":["../../../src/api/Collections/Members.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAE3G;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY;gBAC3B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAOpF;;OAEG;IACG,GAAG,CACP,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,sBAAsB,GACjC,OAAO,CAAC,gBAAgB,CAAC;IAI5B;;;;OAIG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,sBAAsB,GACjC,OAAO,CAAC,gBAAgB,CAAC;IAO5B;;;;OAIG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG3F"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Members = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* CollectionMembers sub-resource
|
|
7
|
+
* Manages members of a (typically private) collection
|
|
8
|
+
*/
|
|
9
|
+
class Members extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List members of a collection
|
|
15
|
+
*/
|
|
16
|
+
async list(workspaceSlug, collectionId) {
|
|
17
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/collections/${collectionId}/members/`);
|
|
18
|
+
return Array.isArray(data) ? data : data.results;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Add a member to a collection
|
|
22
|
+
*/
|
|
23
|
+
async add(workspaceSlug, collectionId, memberData) {
|
|
24
|
+
return this.post(`/workspaces/${workspaceSlug}/collections/${collectionId}/members/`, memberData);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Update a collection member's access level.
|
|
28
|
+
*
|
|
29
|
+
* @param memberId - UUID of the CollectionMember row (not the user id)
|
|
30
|
+
*/
|
|
31
|
+
async update(workspaceSlug, collectionId, memberId, memberData) {
|
|
32
|
+
return this.patch(`/workspaces/${workspaceSlug}/collections/${collectionId}/members/${memberId}/`, memberData);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Remove a member from a collection.
|
|
36
|
+
*
|
|
37
|
+
* @param memberId - UUID of the CollectionMember row (not the user id)
|
|
38
|
+
*/
|
|
39
|
+
async remove(workspaceSlug, collectionId, memberId) {
|
|
40
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/collections/${collectionId}/members/${memberId}/`);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
exports.Members = Members;
|
|
44
|
+
//# sourceMappingURL=Members.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Members.js","sourceRoot":"","sources":["../../../src/api/Collections/Members.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAI/C;;;GAGG;AACH,MAAa,OAAQ,SAAQ,2BAAY;IACvC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,YAAoB;QACpD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,gBAAgB,YAAY,WAAW,CACpE,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,GAAG,CACP,aAAqB,EACrB,YAAoB,EACpB,UAAkC;QAElC,OAAO,IAAI,CAAC,IAAI,CAAmB,eAAe,aAAa,gBAAgB,YAAY,WAAW,EAAE,UAAU,CAAC,CAAC;IACtH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,YAAoB,EACpB,QAAgB,EAChB,UAAkC;QAElC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,gBAAgB,YAAY,YAAY,QAAQ,GAAG,EAC/E,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,YAAoB,EAAE,QAAgB;QACxE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,gBAAgB,YAAY,YAAY,QAAQ,GAAG,CAAC,CAAC;IAC1G,CAAC;CACF;AAnDD,0BAmDC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { PaginatedResponse } from "../../models/common";
|
|
4
|
+
import { AddCollectionPages, CollectionBranchPage, CollectionPage, CollectionPageSearchResult, ListCollectionPagesParams, UpdateCollectionPage } from "../../models/Collection";
|
|
5
|
+
/**
|
|
6
|
+
* CollectionPages sub-resource
|
|
7
|
+
* Manages the pages that belong to a collection
|
|
8
|
+
*/
|
|
9
|
+
export declare class Pages extends BaseResource {
|
|
10
|
+
constructor(config: Configuration);
|
|
11
|
+
/**
|
|
12
|
+
* List pages that belong to a collection.
|
|
13
|
+
* Without `parent_id`, returns only top-level (non-sub) pages.
|
|
14
|
+
*/
|
|
15
|
+
list(workspaceSlug: string, collectionId: string, params?: ListCollectionPagesParams): Promise<PaginatedResponse<CollectionBranchPage>>;
|
|
16
|
+
/**
|
|
17
|
+
* Add existing page(s) to a collection
|
|
18
|
+
*/
|
|
19
|
+
add(workspaceSlug: string, collectionId: string, pagesData: AddCollectionPages): Promise<CollectionPage[]>;
|
|
20
|
+
/**
|
|
21
|
+
* Search pages that are not yet in a collection, to add them.
|
|
22
|
+
*
|
|
23
|
+
* @param search - Optional case-insensitive substring filter on page name
|
|
24
|
+
*/
|
|
25
|
+
search(workspaceSlug: string, collectionId: string, search?: string): Promise<CollectionPageSearchResult[]>;
|
|
26
|
+
/**
|
|
27
|
+
* Move a page to a different collection, or reorder it within the current one.
|
|
28
|
+
* Omit `collection` in the payload to just reorder.
|
|
29
|
+
*
|
|
30
|
+
* @param pageCollectionId - UUID of the page-collection membership row
|
|
31
|
+
*/
|
|
32
|
+
update(workspaceSlug: string, collectionId: string, pageCollectionId: string, updateData: UpdateCollectionPage): Promise<CollectionPage>;
|
|
33
|
+
/**
|
|
34
|
+
* Remove a page from a collection (does not delete the page itself).
|
|
35
|
+
*
|
|
36
|
+
* @param pageCollectionId - UUID of the page-collection membership row
|
|
37
|
+
*/
|
|
38
|
+
remove(workspaceSlug: string, collectionId: string, pageCollectionId: string): Promise<void>;
|
|
39
|
+
}
|
|
40
|
+
//# sourceMappingURL=Pages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Pages.d.ts","sourceRoot":"","sources":["../../../src/api/Collections/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,EACL,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;GAGG;AACH,qBAAa,KAAM,SAAQ,YAAY;gBACzB,MAAM,EAAE,aAAa;IAIjC;;;OAGG;IACG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;IAOnD;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAQhH;;;;OAIG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,EAAE,CAAC;IAQjH;;;;;OAKG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,MAAM,EACxB,UAAU,EAAE,oBAAoB,GAC/B,OAAO,CAAC,cAAc,CAAC;IAO1B;;;;OAIG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGnG"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Pages = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
/**
|
|
6
|
+
* CollectionPages sub-resource
|
|
7
|
+
* Manages the pages that belong to a collection
|
|
8
|
+
*/
|
|
9
|
+
class Pages extends BaseResource_1.BaseResource {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List pages that belong to a collection.
|
|
15
|
+
* Without `parent_id`, returns only top-level (non-sub) pages.
|
|
16
|
+
*/
|
|
17
|
+
async list(workspaceSlug, collectionId, params) {
|
|
18
|
+
return this.get(`/workspaces/${workspaceSlug}/collections/${collectionId}/pages/`, params);
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Add existing page(s) to a collection
|
|
22
|
+
*/
|
|
23
|
+
async add(workspaceSlug, collectionId, pagesData) {
|
|
24
|
+
const result = await this.post(`/workspaces/${workspaceSlug}/collections/${collectionId}/pages/`, pagesData);
|
|
25
|
+
return Array.isArray(result) ? result : result.results;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Search pages that are not yet in a collection, to add them.
|
|
29
|
+
*
|
|
30
|
+
* @param search - Optional case-insensitive substring filter on page name
|
|
31
|
+
*/
|
|
32
|
+
async search(workspaceSlug, collectionId, search) {
|
|
33
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/collections/${collectionId}/pages-search/`, search ? { search } : undefined);
|
|
34
|
+
return Array.isArray(data) ? data : data.results;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Move a page to a different collection, or reorder it within the current one.
|
|
38
|
+
* Omit `collection` in the payload to just reorder.
|
|
39
|
+
*
|
|
40
|
+
* @param pageCollectionId - UUID of the page-collection membership row
|
|
41
|
+
*/
|
|
42
|
+
async update(workspaceSlug, collectionId, pageCollectionId, updateData) {
|
|
43
|
+
return this.patch(`/workspaces/${workspaceSlug}/collections/${collectionId}/pages/${pageCollectionId}/`, updateData);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Remove a page from a collection (does not delete the page itself).
|
|
47
|
+
*
|
|
48
|
+
* @param pageCollectionId - UUID of the page-collection membership row
|
|
49
|
+
*/
|
|
50
|
+
async remove(workspaceSlug, collectionId, pageCollectionId) {
|
|
51
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/collections/${collectionId}/pages/${pageCollectionId}/`);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
exports.Pages = Pages;
|
|
55
|
+
//# sourceMappingURL=Pages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Pages.js","sourceRoot":"","sources":["../../../src/api/Collections/Pages.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAY/C;;;GAGG;AACH,MAAa,KAAM,SAAQ,2BAAY;IACrC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CACR,aAAqB,EACrB,YAAoB,EACpB,MAAkC;QAElC,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,gBAAgB,YAAY,SAAS,EACjE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,aAAqB,EAAE,YAAoB,EAAE,SAA6B;QAClF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAC5B,eAAe,aAAa,gBAAgB,YAAY,SAAS,EACjE,SAAS,CACV,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,YAAoB,EAAE,MAAe;QACvE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CACzB,eAAe,aAAa,gBAAgB,YAAY,gBAAgB,EACxE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAChC,CAAC;QACF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,aAAqB,EACrB,YAAoB,EACpB,gBAAwB,EACxB,UAAgC;QAEhC,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,gBAAgB,YAAY,UAAU,gBAAgB,GAAG,EACrF,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,YAAoB,EAAE,gBAAwB;QAChF,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,gBAAgB,YAAY,UAAU,gBAAgB,GAAG,CAAC,CAAC;IAChH,CAAC;CACF;AAtED,sBAsEC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { BaseResource } from "../BaseResource";
|
|
2
|
+
import { Configuration } from "../../Configuration";
|
|
3
|
+
import { Collection, CreateCollection, UpdateCollection } from "../../models/Collection";
|
|
4
|
+
import { Members } from "./Members";
|
|
5
|
+
import { Pages } from "./Pages";
|
|
6
|
+
/**
|
|
7
|
+
* Collections API resource
|
|
8
|
+
* Manages collections (folders that group workspace pages) with member and
|
|
9
|
+
* page sub-resources
|
|
10
|
+
*/
|
|
11
|
+
export declare class Collections extends BaseResource {
|
|
12
|
+
members: Members;
|
|
13
|
+
pages: Pages;
|
|
14
|
+
constructor(config: Configuration);
|
|
15
|
+
/**
|
|
16
|
+
* List all collections in a workspace
|
|
17
|
+
*/
|
|
18
|
+
list(workspaceSlug: string): Promise<Collection[]>;
|
|
19
|
+
/**
|
|
20
|
+
* Create a new collection in a workspace
|
|
21
|
+
*/
|
|
22
|
+
create(workspaceSlug: string, createCollection: CreateCollection): Promise<Collection>;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieve a collection by ID
|
|
25
|
+
*/
|
|
26
|
+
retrieve(workspaceSlug: string, collectionId: string): Promise<Collection>;
|
|
27
|
+
/**
|
|
28
|
+
* Update a collection's name, logo, or sort order.
|
|
29
|
+
* A collection's access level cannot be changed after creation.
|
|
30
|
+
*/
|
|
31
|
+
update(workspaceSlug: string, collectionId: string, updateCollection: UpdateCollection): Promise<Collection>;
|
|
32
|
+
/**
|
|
33
|
+
* Delete a collection.
|
|
34
|
+
*
|
|
35
|
+
* @param archivePages - Whether to archive the collection's pages instead of
|
|
36
|
+
* leaving them unfiled. Omit to use the server's default (true). Private
|
|
37
|
+
* collections always archive their pages regardless.
|
|
38
|
+
*/
|
|
39
|
+
delete(workspaceSlug: string, collectionId: string, archivePages?: boolean): Promise<void>;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/Collections/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACzF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,YAAY;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;gBAER,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAKxD;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI5F;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIhF;;;OAGG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlH;;;;;;OAMG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAIjG"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Collections = void 0;
|
|
4
|
+
const BaseResource_1 = require("../BaseResource");
|
|
5
|
+
const Members_1 = require("./Members");
|
|
6
|
+
const Pages_1 = require("./Pages");
|
|
7
|
+
/**
|
|
8
|
+
* Collections API resource
|
|
9
|
+
* Manages collections (folders that group workspace pages) with member and
|
|
10
|
+
* page sub-resources
|
|
11
|
+
*/
|
|
12
|
+
class Collections extends BaseResource_1.BaseResource {
|
|
13
|
+
constructor(config) {
|
|
14
|
+
super(config);
|
|
15
|
+
this.members = new Members_1.Members(config);
|
|
16
|
+
this.pages = new Pages_1.Pages(config);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* List all collections in a workspace
|
|
20
|
+
*/
|
|
21
|
+
async list(workspaceSlug) {
|
|
22
|
+
const data = await this.get(`/workspaces/${workspaceSlug}/collections/`);
|
|
23
|
+
return Array.isArray(data) ? data : data.results;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Create a new collection in a workspace
|
|
27
|
+
*/
|
|
28
|
+
async create(workspaceSlug, createCollection) {
|
|
29
|
+
return this.post(`/workspaces/${workspaceSlug}/collections/`, createCollection);
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve a collection by ID
|
|
33
|
+
*/
|
|
34
|
+
async retrieve(workspaceSlug, collectionId) {
|
|
35
|
+
return this.get(`/workspaces/${workspaceSlug}/collections/${collectionId}/`);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Update a collection's name, logo, or sort order.
|
|
39
|
+
* A collection's access level cannot be changed after creation.
|
|
40
|
+
*/
|
|
41
|
+
async update(workspaceSlug, collectionId, updateCollection) {
|
|
42
|
+
return this.patch(`/workspaces/${workspaceSlug}/collections/${collectionId}/`, updateCollection);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Delete a collection.
|
|
46
|
+
*
|
|
47
|
+
* @param archivePages - Whether to archive the collection's pages instead of
|
|
48
|
+
* leaving them unfiled. Omit to use the server's default (true). Private
|
|
49
|
+
* collections always archive their pages regardless.
|
|
50
|
+
*/
|
|
51
|
+
async delete(workspaceSlug, collectionId, archivePages) {
|
|
52
|
+
const params = archivePages === undefined ? undefined : { archive_pages: archivePages ? "true" : "false" };
|
|
53
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/collections/${collectionId}/`, undefined, params);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
exports.Collections = Collections;
|
|
57
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Collections/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAG/C,uCAAoC;AACpC,mCAAgC;AAEhC;;;;GAIG;AACH,MAAa,WAAY,SAAQ,2BAAY;IAI3C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAA2C,eAAe,aAAa,eAAe,CAAC,CAAC;QACnH,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,gBAAkC;QACpE,OAAO,IAAI,CAAC,IAAI,CAAa,eAAe,aAAa,eAAe,EAAE,gBAAgB,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,YAAoB;QACxD,OAAO,IAAI,CAAC,GAAG,CAAa,eAAe,aAAa,gBAAgB,YAAY,GAAG,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,YAAoB,EAAE,gBAAkC;QAC1F,OAAO,IAAI,CAAC,KAAK,CAAa,eAAe,aAAa,gBAAgB,YAAY,GAAG,EAAE,gBAAgB,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,YAAoB,EAAE,YAAsB;QAC9E,MAAM,MAAM,GAAG,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC3G,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,gBAAgB,YAAY,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;CACF;AAnDD,kCAmDC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseResource } from "../BaseResource";
|
|
2
2
|
import { Configuration } from "../../Configuration";
|
|
3
|
-
import { CustomerProperty, CustomerPropertyValue, UpdateCustomerPropertyValue, ListCustomerPropertyValuesParams, ListCustomerPropertiesParams, CreateCustomerPropertyRequest, UpdateCustomerPropertyRequest, CustomPropertyValueResponse } from "../../models/Customer";
|
|
3
|
+
import { CustomerProperty, CustomerPropertyValue, UpdateCustomerPropertyValue, ListCustomerPropertyValuesParams, ListCustomerPropertiesParams, CreateCustomerPropertyRequest, UpdateCustomerPropertyRequest, CustomPropertyValueResponse, SetCustomerPropertyValues } from "../../models/Customer";
|
|
4
4
|
import { PaginatedResponse } from "../../models/common";
|
|
5
5
|
/**
|
|
6
6
|
* Customer Properties API resource
|
|
@@ -32,6 +32,15 @@ export declare class Properties extends BaseResource {
|
|
|
32
32
|
* Get customer property values
|
|
33
33
|
*/
|
|
34
34
|
listValues(workspaceSlug: string, customerId: string, params?: ListCustomerPropertyValuesParams): Promise<CustomPropertyValueResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* Set several of a customer's property values at once.
|
|
37
|
+
*
|
|
38
|
+
* Acts as an upsert: the properties named are given these values, replacing
|
|
39
|
+
* any they already held. Properties absent from the payload are untouched.
|
|
40
|
+
* Every value is sent as a string — dates as YYYY-MM-DD, booleans as
|
|
41
|
+
* "True"/"False", options and relations as UUIDs.
|
|
42
|
+
*/
|
|
43
|
+
createValues(workspaceSlug: string, customerId: string, values: SetCustomerPropertyValues): Promise<void>;
|
|
35
44
|
/**
|
|
36
45
|
* Get single property value
|
|
37
46
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Properties.d.ts","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,
|
|
1
|
+
{"version":3,"file":"Properties.d.ts","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,gCAAgC,EAChC,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,EAC3B,yBAAyB,EAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,YAAY;gBAC9B,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,uBAAuB,CAC3B,aAAa,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IAI/C;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,6BAA6B,GAC5C,OAAO,CAAC,gBAAgB,CAAC;IAI5B;;OAEG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAItG;;OAEG;IACG,wBAAwB,CAC5B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,6BAA6B,GAC5C,OAAO,CAAC,gBAAgB,CAAC;IAO5B;;OAEG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMxF;;OAEG;IACG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,gCAAgC,GACxC,OAAO,CAAC,2BAA2B,CAAC;IAOvC;;;;;;;OAOG;IACG,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/G;;OAEG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMlH;;OAEG;IACG,WAAW,CACf,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,mBAAmB,EAAE,2BAA2B,GAC/C,OAAO,CAAC,qBAAqB,CAAC;CAMlC"}
|
|
@@ -48,6 +48,17 @@ class Properties extends BaseResource_1.BaseResource {
|
|
|
48
48
|
async listValues(workspaceSlug, customerId, params) {
|
|
49
49
|
return this.get(`/workspaces/${workspaceSlug}/customers/${customerId}/property-values/`, params);
|
|
50
50
|
}
|
|
51
|
+
/**
|
|
52
|
+
* Set several of a customer's property values at once.
|
|
53
|
+
*
|
|
54
|
+
* Acts as an upsert: the properties named are given these values, replacing
|
|
55
|
+
* any they already held. Properties absent from the payload are untouched.
|
|
56
|
+
* Every value is sent as a string — dates as YYYY-MM-DD, booleans as
|
|
57
|
+
* "True"/"False", options and relations as UUIDs.
|
|
58
|
+
*/
|
|
59
|
+
async createValues(workspaceSlug, customerId, values) {
|
|
60
|
+
await this.post(`/workspaces/${workspaceSlug}/customers/${customerId}/property-values/`, values);
|
|
61
|
+
}
|
|
51
62
|
/**
|
|
52
63
|
* Get single property value
|
|
53
64
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;
|
|
1
|
+
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../src/api/Customers/Properties.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAe/C;;;GAGG;AACH,MAAa,UAAW,SAAQ,2BAAY;IAC1C,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED,wDAAwD;IAExD;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAC3B,aAAqB,EACrB,MAAqC;QAErC,OAAO,IAAI,CAAC,GAAG,CAAsC,eAAe,aAAa,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACpH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAqB,EACrB,cAA6C;QAE7C,OAAO,IAAI,CAAC,IAAI,CAAmB,eAAe,aAAa,uBAAuB,EAAE,cAAc,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,0BAA0B,CAAC,aAAqB,EAAE,UAAkB;QACxE,OAAO,IAAI,CAAC,GAAG,CAAmB,eAAe,aAAa,wBAAwB,UAAU,GAAG,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,aAAqB,EACrB,UAAkB,EAClB,cAA6C;QAE7C,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,wBAAwB,UAAU,GAAG,EACjE,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,aAAqB,EAAE,UAAkB;QACtE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,wBAAwB,UAAU,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED,mDAAmD;IAEnD;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAqB,EACrB,UAAkB,EAClB,MAAyC;QAEzC,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,UAAU,mBAAmB,EACvE,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,aAAqB,EAAE,UAAkB,EAAE,MAAiC;QAC7F,MAAM,IAAI,CAAC,IAAI,CAAO,eAAe,aAAa,cAAc,UAAU,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,aAAqB,EAAE,UAAkB,EAAE,UAAkB;QAC/E,OAAO,IAAI,CAAC,GAAG,CACb,eAAe,aAAa,cAAc,UAAU,oBAAoB,UAAU,GAAG,CACtF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,aAAqB,EACrB,UAAkB,EAClB,UAAkB,EAClB,mBAAgD;QAEhD,OAAO,IAAI,CAAC,KAAK,CACf,eAAe,aAAa,cAAc,UAAU,oBAAoB,UAAU,GAAG,EACrF,mBAAmB,CACpB,CAAC;IACJ,CAAC;CACF;AA1GD,gCA0GC"}
|
|
@@ -29,6 +29,12 @@ export declare class Customers extends BaseResource {
|
|
|
29
29
|
* Delete a customer
|
|
30
30
|
*/
|
|
31
31
|
delete(workspaceSlug: string, customerId: string): Promise<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Delete a customer addressed by its external reference
|
|
34
|
+
* (external_source + external_id query params) instead of its id.
|
|
35
|
+
* Deleting by an external reference that matches nothing succeeds silently.
|
|
36
|
+
*/
|
|
37
|
+
deleteByExternalId(workspaceSlug: string, externalSource: string, externalId: string): Promise<void>;
|
|
32
38
|
/**
|
|
33
39
|
* List customers with optional filtering
|
|
34
40
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/Customers/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,4BAA4B,EAC7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,YAAY;IAClC,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;gBAEd,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAItF;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5E;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1G;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAMrG;;OAEG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAInF;;OAEG;IACG,oBAAoB,CACxB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,4BAA4B,CAAC;IAMxC;;OAEG;IACG,uBAAuB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzG"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/Customers/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,4BAA4B,EAC7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,YAAY;IAClC,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;gBAEd,MAAM,EAAE,aAAa;IAMjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAItF;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5E;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI1G;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;;;OAIG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1G;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAMrG;;OAEG;IACG,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAInF;;OAEG;IACG,oBAAoB,CACxB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAAE,GACjB,OAAO,CAAC,4BAA4B,CAAC;IAMxC;;OAEG;IACG,uBAAuB,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzG"}
|
|
@@ -39,6 +39,17 @@ class Customers extends BaseResource_1.BaseResource {
|
|
|
39
39
|
async delete(workspaceSlug, customerId) {
|
|
40
40
|
return this.httpDelete(`/workspaces/${workspaceSlug}/customers/${customerId}/`);
|
|
41
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* Delete a customer addressed by its external reference
|
|
44
|
+
* (external_source + external_id query params) instead of its id.
|
|
45
|
+
* Deleting by an external reference that matches nothing succeeds silently.
|
|
46
|
+
*/
|
|
47
|
+
async deleteByExternalId(workspaceSlug, externalSource, externalId) {
|
|
48
|
+
return this.httpDelete(`/workspaces/${workspaceSlug}/customers/`, undefined, {
|
|
49
|
+
external_source: externalSource,
|
|
50
|
+
external_id: externalId,
|
|
51
|
+
});
|
|
52
|
+
}
|
|
42
53
|
/**
|
|
43
54
|
* List customers with optional filtering
|
|
44
55
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Customers/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAS/C,6CAA0C;AAC1C,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAIzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,cAA8B;QAChE,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,EAAE,cAAc,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,UAAkB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAW,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB,EAAE,cAA8B;QACpF,OAAO,IAAI,CAAC,KAAK,CAAW,eAAe,aAAa,cAAc,UAAU,GAAG,EAAE,cAAc,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,MAA4B;QAC5D,OAAO,IAAI,CAAC,GAAG,CAA8B,eAAe,aAAa,aAAa,EAAE,MAAM,CAAC,CAAC;IAClG,CAAC;IAED,0CAA0C;IAE1C;;OAEG;IACH,KAAK,CAAC,kBAAkB,CAAC,aAAqB,EAAE,UAAkB;QAChE,OAAO,IAAI,CAAC,GAAG,CAAQ,eAAe,aAAa,cAAc,UAAU,UAAU,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,UAAkB,EAClB,QAAkB;QAElB,OAAO,IAAI,CAAC,IAAI,CAA+B,eAAe,aAAa,cAAc,UAAU,UAAU,EAAE;YAC7G,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAAC,aAAqB,EAAE,UAAkB,EAAE,OAAe;QACtF,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,WAAW,OAAO,GAAG,CAAC,CAAC;IACpG,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/Customers/index.ts"],"names":[],"mappings":";;;AAAA,kDAA+C;AAS/C,6CAA0C;AAC1C,yCAAsC;AAGtC;;;;GAIG;AACH,MAAa,SAAU,SAAQ,2BAAY;IAIzC,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,UAAU,GAAG,IAAI,uBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,cAA8B;QAChE,OAAO,IAAI,CAAC,IAAI,CAAW,eAAe,aAAa,aAAa,EAAE,cAAc,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,aAAqB,EAAE,UAAkB;QACtD,OAAO,IAAI,CAAC,GAAG,CAAW,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB,EAAE,cAA8B;QACpF,OAAO,IAAI,CAAC,KAAK,CAAW,eAAe,aAAa,cAAc,UAAU,GAAG,EAAE,cAAc,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,aAAqB,EAAE,UAAkB;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,GAAG,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,aAAqB,EAAE,cAAsB,EAAE,UAAkB;QACxF,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,aAAa,EAAE,SAAS,EAAE;YAC3E,eAAe,EAAE,cAAc;YAC/B,WAAW,EAAE,UAAU;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,aAAqB,EAAE,MAA4B;QAC5D,OAAO,IAAI,CAAC,GAAG,CAA8B,eAAe,aAAa,aAAa,EAAE,MAAM,CAAC,CAAC;IAClG,CAAC;IAED,0CAA0C;IAE1C;;OAEG;IACH,KAAK,CAAC,kBAAkB,CAAC,aAAqB,EAAE,UAAkB;QAChE,OAAO,IAAI,CAAC,GAAG,CAAQ,eAAe,aAAa,cAAc,UAAU,UAAU,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CACxB,aAAqB,EACrB,UAAkB,EAClB,QAAkB;QAElB,OAAO,IAAI,CAAC,IAAI,CAA+B,eAAe,aAAa,cAAc,UAAU,UAAU,EAAE;YAC7G,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAAC,aAAqB,EAAE,UAAkB,EAAE,OAAe;QACtF,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,cAAc,UAAU,WAAW,OAAO,GAAG,CAAC,CAAC;IACpG,CAAC;CACF;AArFD,8BAqFC"}
|
package/dist/api/Cycles.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 { Cycle, CreateCycleRequest, UpdateCycleRequest, TransferCycleWorkItemRequest } from "../models/Cycle";
|
|
5
|
-
import { WorkItem } from "../models/WorkItem";
|
|
4
|
+
import { Cycle, CreateCycleRequest, UpdateCycleRequest, TransferCycleWorkItemRequest, CycleLite, ListCyclesLiteParams } from "../models/Cycle";
|
|
5
|
+
import { ListWorkItemsParams, WorkItem } from "../models/WorkItem";
|
|
6
6
|
/**
|
|
7
7
|
* Cycles API resource
|
|
8
8
|
* Handles all cycle (sprint) related operations
|
|
@@ -29,6 +29,11 @@ export declare class Cycles extends BaseResource {
|
|
|
29
29
|
* List cycles with optional filtering
|
|
30
30
|
*/
|
|
31
31
|
list(workspaceSlug: string, projectId: string): Promise<PaginatedResponse<Cycle>>;
|
|
32
|
+
/**
|
|
33
|
+
* List cycles as a paginated "lite" response, intended for pickers and
|
|
34
|
+
* reference lookups. Accepts an optional status filter.
|
|
35
|
+
*/
|
|
36
|
+
listLite(workspaceSlug: string, projectId: string, params?: ListCyclesLiteParams): Promise<PaginatedResponse<CycleLite>>;
|
|
32
37
|
/**
|
|
33
38
|
* List archived cycles
|
|
34
39
|
*/
|
|
@@ -42,9 +47,12 @@ export declare class Cycles extends BaseResource {
|
|
|
42
47
|
*/
|
|
43
48
|
archive(workspaceSlug: string, projectId: string, cycleId: string): Promise<void>;
|
|
44
49
|
/**
|
|
45
|
-
* List work items in cycle
|
|
50
|
+
* List work items in a cycle.
|
|
51
|
+
*
|
|
52
|
+
* Supports the same `filters` and `pql` query parameters as
|
|
53
|
+
* {@link WorkItems.list}.
|
|
46
54
|
*/
|
|
47
|
-
listWorkItemsInCycle(workspaceSlug: string, projectId: string, cycleId: string, params?:
|
|
55
|
+
listWorkItemsInCycle(workspaceSlug: string, projectId: string, cycleId: string, params?: ListWorkItemsParams): Promise<PaginatedResponse<WorkItem>>;
|
|
48
56
|
/**
|
|
49
57
|
* Add work items to cycle
|
|
50
58
|
*/
|
package/dist/api/Cycles.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Cycles.d.ts","sourceRoot":"","sources":["../../src/api/Cycles.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;AAErD,OAAO,
|
|
1
|
+
{"version":3,"file":"Cycles.d.ts","sourceRoot":"","sources":["../../src/api/Cycles.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;AAErD,OAAO,EACL,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,4BAA4B,EAC5B,SAAS,EACT,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAGnE;;;GAGG;AACH,qBAAa,MAAO,SAAQ,YAAY;gBAC1B,MAAM,EAAE,aAAa;IAIjC;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IAIvG;;OAEG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIzF;;OAEG;IACG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,kBAAkB,GAC9B,OAAO,CAAC,KAAK,CAAC;IAIjB;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF;;OAEG;IACG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAIvF;;;OAGG;IACG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAOxC;;OAEG;IACG,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAO7G;;OAEG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzF;;OAEG;IACG,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvF;;;;;OAKG;IACG,oBAAoB,CACxB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAOvC;;OAEG;IACG,mBAAmB,CACvB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAAE,GACpB,OAAO,CAAC,IAAI,CAAC;IAMhB;;OAEG;IACG,uBAAuB,CAC3B,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAMhB;;OAEG;IACG,+BAA+B,CACnC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,4BAA4B,GACzC,OAAO,CAAC,IAAI,CAAC;CAMjB"}
|