@makeplane/plane-node-sdk 0.1.0

package/dist/apis/ProjectsApi.d.ts

@@ -0,0 +1,120 @@
+/**
+ * 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 { PaginatedProjectResponse, PatchedProjectUpdateRequest, Project, ProjectCreateRequest } from '../models/index';
+export interface ArchiveProjectRequest {
+    projectId: string;
+    slug: string;
+}
+export interface CreateProjectRequest {
+    slug: string;
+    projectCreateRequest: ProjectCreateRequest;
+}
+export interface DeleteProjectRequest {
+    pk: string;
+    slug: string;
+}
+export interface ListProjectsRequest {
+    slug: string;
+    cursor?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+export interface RetrieveProjectRequest {
+    pk: string;
+    slug: string;
+}
+export interface UnarchiveProjectRequest {
+    projectId: string;
+    slug: string;
+}
+export interface UpdateProjectRequest {
+    pk: string;
+    slug: string;
+    patchedProjectUpdateRequest?: PatchedProjectUpdateRequest;
+}
+/**
+ *
+ */
+export declare class ProjectsApi extends runtime.BaseAPI {
+    /**
+     * Move a project to archived status, hiding it from active project lists.
+     * Archive project
+     */
+    archiveProjectRaw(requestParameters: ArchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Move a project to archived status, hiding it from active project lists.
+     * Archive project
+     */
+    archiveProject(requestParameters: ArchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new project in the workspace with default states and member assignments.
+     * Create project
+     */
+    createProjectRaw(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
+    /**
+     * Create a new project in the workspace with default states and member assignments.
+     * Create project
+     */
+    createProject(requestParameters: CreateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
+    /**
+     * Permanently remove a project and all its associated data from the workspace.
+     * Delete project
+     */
+    deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently remove a project and all its associated data from the workspace.
+     * Delete project
+     */
+    deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve all projects in a workspace or get details of a specific project.
+     * List or retrieve projects
+     */
+    listProjectsRaw(requestParameters: ListProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProjectResponse>>;
+    /**
+     * Retrieve all projects in a workspace or get details of a specific project.
+     * List or retrieve projects
+     */
+    listProjects(requestParameters: ListProjectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProjectResponse>;
+    /**
+     * Retrieve details of a specific project.
+     * Retrieve project
+     */
+    retrieveProjectRaw(requestParameters: RetrieveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
+    /**
+     * Retrieve details of a specific project.
+     * Retrieve project
+     */
+    retrieveProject(requestParameters: RetrieveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
+    /**
+     * Restore an archived project to active status, making it available in regular workflows.
+     * Unarchive project
+     */
+    unarchiveProjectRaw(requestParameters: UnarchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Restore an archived project to active status, making it available in regular workflows.
+     * Unarchive project
+     */
+    unarchiveProject(requestParameters: UnarchiveProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Partially update an existing project\'s properties like name, description, or settings.
+     * Update project
+     */
+    updateProjectRaw(requestParameters: UpdateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Project>>;
+    /**
+     * Partially update an existing project\'s properties like name, description, or settings.
+     * Update project
+     */
+    updateProject(requestParameters: UpdateProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
+}