plane-node-sdk/src/api/Modules.ts at 37f1280ff3c211a9551b2a725a49d8e27d727286 · makeplane/plane-node-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
import { BaseResource } from "./BaseResource";
import { Configuration } from "../Configuration";
import { PaginatedResponse } from "../models/common";
import { CreateModuleRequest, UpdateModuleRequest, Module, ListModulesParamsRequest } from "../models/Module";
import { WorkItem } from "../models/WorkItem";

/**
 * Modules API resource
 * Handles all module related operations
 */
export class Modules extends BaseResource {
  constructor(config: Configuration) {
    super(config);
  }

  /**
   * Create a new module
   */
  async create(workspaceSlug: string, projectId: string, createModule: CreateModuleRequest): Promise<Module> {
    return this.post<Module>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/`, createModule);
  }

  /**
   * Retrieve a module by ID
   */
  async retrieve(workspaceSlug: string, projectId: string, moduleId: string): Promise<Module> {
    return this.get<Module>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/`);
  }

  /**
   * Update a module
   */
  async update(
    workspaceSlug: string,
    projectId: string,
    moduleId: string,
    updateModule: UpdateModuleRequest
  ): Promise<Module> {
    return this.patch<Module>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/`, updateModule);
  }

  /**
   * Delete a module
   */
  async delete(workspaceSlug: string, projectId: string, moduleId: string): Promise<void> {
    return this.httpDelete(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/`);
  }

  /**
   * List modules with optional filtering
   */
  async list(
    workspaceSlug: string,
    projectId: string,
    params?: ListModulesParamsRequest
  ): Promise<PaginatedResponse<Module>> {
    return this.get<PaginatedResponse<Module>>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/`, params);
  }

  /**
   * List work items in module
   */
  async listWorkItemsInModule(
    workspaceSlug: string,
    projectId: string,
    moduleId: string,
    params?: any
  ): Promise<PaginatedResponse<WorkItem>> {
    return this.get<PaginatedResponse<WorkItem>>(
      `/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/module-issues/`,
      params
    );
  }

  /**
   * Add work items to module
   */
  async addWorkItemsToModule(
    workspaceSlug: string,
    projectId: string,
    moduleId: string,
    workItemIds: string[]
  ): Promise<void> {
    return this.post<void>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/module-issues/`, {
      issues: workItemIds,
    });
  }

  /**
   * Delete work item from module
   */
  async removeWorkItemFromModule(
    workspaceSlug: string,
    projectId: string,
    moduleId: string,
    workItemId: string
  ): Promise<void> {
    return this.httpDelete(
      `/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/module-issues/${workItemId}/`
    );
  }

  /**
   * List archived modules
   */
  async listArchivedModules(
    workspaceSlug: string,
    projectId: string,
    params?: any
  ): Promise<PaginatedResponse<Module>> {
    return this.get<PaginatedResponse<Module>>(
      `/workspaces/${workspaceSlug}/projects/${projectId}/modules/archived/`,
      params
    );
  }

  /**
   * Archive a module
   */
  async archiveModule(workspaceSlug: string, projectId: string, moduleId: string): Promise<void> {
    return this.post<void>(`/workspaces/${workspaceSlug}/projects/${projectId}/modules/${moduleId}/archive/`);
  }

  /**
   * Unarchive a module
   */
  async unArchiveModule(workspaceSlug: string, projectId: string, moduleId: string): Promise<void> {
    return this.httpDelete(
      `/workspaces/${workspaceSlug}/projects/${projectId}/archived-modules/${moduleId}/unarchive/`
    );
  }
}