@makeplane/plane-node-sdk 0.1.0

package/dist/apis/MembersApi.js

@@ -0,0 +1,228 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The Plane REST API
+ * The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
+ *
+ * The version of the API Spec: 0.0.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MembersApi = void 0;
+var runtime = require("../runtime");
+var index_1 = require("../models/index");
+/**
+ *
+ */
+var MembersApi = /** @class */ (function (_super) {
+    __extends(MembersApi, _super);
+    function MembersApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Retrieve all users who are members of the specified project.
+     * List project members
+     */
+    MembersApi.prototype.getProjectMembersRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, _c, _d, _e, _f, response;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        if (requestParameters['projectId'] == null) {
+                            throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getProjectMembers().');
+                        }
+                        if (requestParameters['slug'] == null) {
+                            throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getProjectMembers().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "X-API-Key";
+                        return [4 /*yield*/, this.configuration.apiKey("X-API-Key")];
+                    case 1:
+                        _a[_b] = _g.sent(); // ApiKeyAuthentication authentication
+                        _g.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        // oauth required
+                        _c = headerParameters;
+                        _d = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("OAuth2Authentication", [])];
+                    case 3:
+                        // oauth required
+                        _c[_d] = _g.sent();
+                        _g.label = 4;
+                    case 4:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 6];
+                        // oauth required
+                        _e = headerParameters;
+                        _f = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("OAuth2Authentication", [])];
+                    case 5:
+                        // oauth required
+                        _e[_f] = _g.sent();
+                        _g.label = 6;
+                    case 6: return [4 /*yield*/, this.request({
+                            path: "/api/v1/workspaces/{slug}/projects/{project_id}/members/".replace("{".concat("project_id", "}"), encodeURIComponent(String(requestParameters['projectId']))).replace("{".concat("slug", "}"), encodeURIComponent(String(requestParameters['slug']))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 7:
+                        response = _g.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserLiteFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve all users who are members of the specified project.
+     * List project members
+     */
+    MembersApi.prototype.getProjectMembers = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getProjectMembersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve all users who are members of the specified workspace.
+     * List workspace members
+     */
+    MembersApi.prototype.getWorkspaceMembersRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, _c, _d, _e, _f, response;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        if (requestParameters['slug'] == null) {
+                            throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getWorkspaceMembers().');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "X-API-Key";
+                        return [4 /*yield*/, this.configuration.apiKey("X-API-Key")];
+                    case 1:
+                        _a[_b] = _g.sent(); // ApiKeyAuthentication authentication
+                        _g.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
+                        // oauth required
+                        _c = headerParameters;
+                        _d = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("OAuth2Authentication", [])];
+                    case 3:
+                        // oauth required
+                        _c[_d] = _g.sent();
+                        _g.label = 4;
+                    case 4:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 6];
+                        // oauth required
+                        _e = headerParameters;
+                        _f = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("OAuth2Authentication", [])];
+                    case 5:
+                        // oauth required
+                        _e[_f] = _g.sent();
+                        _g.label = 6;
+                    case 6: return [4 /*yield*/, this.request({
+                            path: "/api/v1/workspaces/{slug}/members/".replace("{".concat("slug", "}"), encodeURIComponent(String(requestParameters['slug']))),
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 7:
+                        response = _g.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return jsonValue.map(index_1.GetWorkspaceMembers200ResponseInnerFromJSON); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve all users who are members of the specified workspace.
+     * List workspace members
+     */
+    MembersApi.prototype.getWorkspaceMembers = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getWorkspaceMembersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return MembersApi;
+}(runtime.BaseAPI));
+exports.MembersApi = MembersApi;

package/dist/apis/ModulesApi.d.ts

@@ -0,0 +1,198 @@
+/**
+ * The Plane REST API
+ * The Plane REST API  Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
+ *
+ * The version of the API Spec: 0.0.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { Module, ModuleCreateRequest, ModuleIssue, ModuleIssueRequestRequest, PaginatedArchivedModuleResponse, PaginatedModuleIssueResponse, PaginatedModuleResponse, PatchedModuleUpdateRequest } from '../models/index';
+export interface AddModuleWorkItemsRequest {
+    moduleId: string;
+    projectId: string;
+    slug: string;
+    moduleIssueRequestRequest: ModuleIssueRequestRequest;
+}
+export interface ArchiveModuleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface CreateModuleRequest {
+    projectId: string;
+    slug: string;
+    moduleCreateRequest: ModuleCreateRequest;
+}
+export interface DeleteModuleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface DeleteModuleWorkItemRequest {
+    issueId: string;
+    moduleId: string;
+    projectId: string;
+    slug: string;
+}
+export interface ListArchivedModulesRequest {
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+export interface ListModuleWorkItemsRequest {
+    moduleId: string;
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+export interface ListModulesRequest {
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+export interface RetrieveModuleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface UnarchiveModuleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface UpdateModuleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+    patchedModuleUpdateRequest?: PatchedModuleUpdateRequest;
+}
+/**
+ *
+ */
+export declare class ModulesApi extends runtime.BaseAPI {
+    /**
+     * Assign multiple work items to a module or move them from another module. Automatically handles bulk creation and updates with activity tracking.
+     * Add Work Items to Module
+     */
+    addModuleWorkItemsRaw(requestParameters: AddModuleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModuleIssue>>;
+    /**
+     * Assign multiple work items to a module or move them from another module. Automatically handles bulk creation and updates with activity tracking.
+     * Add Work Items to Module
+     */
+    addModuleWorkItems(requestParameters: AddModuleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModuleIssue>;
+    /**
+     * Move a module to archived status for historical tracking.
+     * Archive module
+     */
+    archiveModuleRaw(requestParameters: ArchiveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Move a module to archived status for historical tracking.
+     * Archive module
+     */
+    archiveModule(requestParameters: ArchiveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new project module with specified name, description, and timeline.
+     * Create module
+     */
+    createModuleRaw(requestParameters: CreateModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Module>>;
+    /**
+     * Create a new project module with specified name, description, and timeline.
+     * Create module
+     */
+    createModule(requestParameters: CreateModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Module>;
+    /**
+     * Permanently remove a module and all its associated issue relationships.
+     * Delete module
+     */
+    deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently remove a module and all its associated issue relationships.
+     * Delete module
+     */
+    deleteModule(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Remove a work item from a module while keeping the work item in the project.
+     * Delete module work item
+     */
+    deleteModuleWorkItemRaw(requestParameters: DeleteModuleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a work item from a module while keeping the work item in the project.
+     * Delete module work item
+     */
+    deleteModuleWorkItem(requestParameters: DeleteModuleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve all modules that have been archived in the project.
+     * List archived modules
+     */
+    listArchivedModulesRaw(requestParameters: ListArchivedModulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedArchivedModuleResponse>>;
+    /**
+     * Retrieve all modules that have been archived in the project.
+     * List archived modules
+     */
+    listArchivedModules(requestParameters: ListArchivedModulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedArchivedModuleResponse>;
+    /**
+     * Retrieve all work items assigned to a module with detailed information.
+     * List module work items
+     */
+    listModuleWorkItemsRaw(requestParameters: ListModuleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedModuleIssueResponse>>;
+    /**
+     * Retrieve all work items assigned to a module with detailed information.
+     * List module work items
+     */
+    listModuleWorkItems(requestParameters: ListModuleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedModuleIssueResponse>;
+    /**
+     * Retrieve all modules in a project.
+     * List modules
+     */
+    listModulesRaw(requestParameters: ListModulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedModuleResponse>>;
+    /**
+     * Retrieve all modules in a project.
+     * List modules
+     */
+    listModules(requestParameters: ListModulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedModuleResponse>;
+    /**
+     * Retrieve details of a specific module.
+     * Retrieve module
+     */
+    retrieveModuleRaw(requestParameters: RetrieveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Module>>;
+    /**
+     * Retrieve details of a specific module.
+     * Retrieve module
+     */
+    retrieveModule(requestParameters: RetrieveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Module>;
+    /**
+     * Restore an archived module to active status, making it available for regular use.
+     * Unarchive module
+     */
+    unarchiveModuleRaw(requestParameters: UnarchiveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Restore an archived module to active status, making it available for regular use.
+     * Unarchive module
+     */
+    unarchiveModule(requestParameters: UnarchiveModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Modify an existing module\'s properties like name, description, status, or timeline.
+     * Update module
+     */
+    updateModuleRaw(requestParameters: UpdateModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Module>>;
+    /**
+     * Modify an existing module\'s properties like name, description, status, or timeline.
+     * Update module
+     */
+    updateModule(requestParameters: UpdateModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Module>;
+}