@makeplane/plane-node-sdk 0.1.0

package/dist/apis/CyclesApi.d.ts

@@ -0,0 +1,225 @@
+/**
+ * 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 { Cycle, CycleCreateRequest, CycleIssue, CycleIssueRequestRequest, PaginatedArchivedCycleResponse, PaginatedCycleIssueResponse, PaginatedCycleResponse, PatchedCycleUpdateRequest, TransferCycleIssueRequestRequest, TransferCycleWorkItems200Response } from '../models/index';
+export interface AddCycleWorkItemsRequest {
+    cycleId: string;
+    projectId: string;
+    slug: string;
+    cycleIssueRequestRequest: CycleIssueRequestRequest;
+}
+export interface ArchiveCycleRequest {
+    cycleId: string;
+    projectId: string;
+    slug: string;
+}
+export interface CreateCycleRequest {
+    projectId: string;
+    slug: string;
+    cycleCreateRequest: CycleCreateRequest;
+}
+export interface DeleteCycleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface DeleteCycleWorkItemRequest {
+    cycleId: string;
+    issueId: string;
+    projectId: string;
+    slug: string;
+}
+export interface ListArchivedCyclesRequest {
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    perPage?: number;
+}
+export interface ListCycleWorkItemsRequest {
+    cycleId: string;
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    perPage?: number;
+}
+export interface ListCyclesRequest {
+    projectId: string;
+    slug: string;
+    cursor?: string;
+    cycleView?: string;
+    expand?: string;
+    fields?: string;
+    orderBy?: string;
+    perPage?: number;
+}
+export interface RetrieveCycleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface RetrieveCycleWorkItemRequest {
+    cycleId: string;
+    issueId: string;
+    projectId: string;
+    slug: string;
+}
+export interface TransferCycleWorkItemsRequest {
+    cycleId: string;
+    projectId: string;
+    slug: string;
+    transferCycleIssueRequestRequest: TransferCycleIssueRequestRequest;
+}
+export interface UnarchiveCycleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+}
+export interface UpdateCycleRequest {
+    pk: string;
+    projectId: string;
+    slug: string;
+    patchedCycleUpdateRequest?: PatchedCycleUpdateRequest;
+}
+/**
+ *
+ */
+export declare class CyclesApi extends runtime.BaseAPI {
+    /**
+     * Assign multiple work items to a cycle. Automatically handles bulk creation and updates with activity tracking.
+     * Add Work Items to Cycle
+     */
+    addCycleWorkItemsRaw(requestParameters: AddCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CycleIssue>>;
+    /**
+     * Assign multiple work items to a cycle. Automatically handles bulk creation and updates with activity tracking.
+     * Add Work Items to Cycle
+     */
+    addCycleWorkItems(requestParameters: AddCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CycleIssue>;
+    /**
+     * Move a completed cycle to archived status for historical tracking. Only cycles that have ended can be archived.
+     * Archive cycle
+     */
+    archiveCycleRaw(requestParameters: ArchiveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Move a completed cycle to archived status for historical tracking. Only cycles that have ended can be archived.
+     * Archive cycle
+     */
+    archiveCycle(requestParameters: ArchiveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new development cycle with specified name, description, and date range. Supports external ID tracking for integration purposes.
+     * Create cycle
+     */
+    createCycleRaw(requestParameters: CreateCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Cycle>>;
+    /**
+     * Create a new development cycle with specified name, description, and date range. Supports external ID tracking for integration purposes.
+     * Create cycle
+     */
+    createCycle(requestParameters: CreateCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Cycle>;
+    /**
+     * Permanently remove a cycle and all its associated issue relationships
+     * Delete cycle
+     */
+    deleteCycleRaw(requestParameters: DeleteCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Permanently remove a cycle and all its associated issue relationships
+     * Delete cycle
+     */
+    deleteCycle(requestParameters: DeleteCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Remove a work item from a cycle while keeping the work item in the project.
+     * Delete cycle work item
+     */
+    deleteCycleWorkItemRaw(requestParameters: DeleteCycleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a work item from a cycle while keeping the work item in the project.
+     * Delete cycle work item
+     */
+    deleteCycleWorkItem(requestParameters: DeleteCycleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieve all cycles that have been archived in the project.
+     * List archived cycles
+     */
+    listArchivedCyclesRaw(requestParameters: ListArchivedCyclesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedArchivedCycleResponse>>;
+    /**
+     * Retrieve all cycles that have been archived in the project.
+     * List archived cycles
+     */
+    listArchivedCycles(requestParameters: ListArchivedCyclesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedArchivedCycleResponse>;
+    /**
+     * Retrieve all work items assigned to a cycle.
+     * List cycle work items
+     */
+    listCycleWorkItemsRaw(requestParameters: ListCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedCycleIssueResponse>>;
+    /**
+     * Retrieve all work items assigned to a cycle.
+     * List cycle work items
+     */
+    listCycleWorkItems(requestParameters: ListCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedCycleIssueResponse>;
+    /**
+     * Retrieve all cycles in a project. Supports filtering by cycle status like current, upcoming, completed, or draft.
+     * List cycles
+     */
+    listCyclesRaw(requestParameters: ListCyclesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedCycleResponse>>;
+    /**
+     * Retrieve all cycles in a project. Supports filtering by cycle status like current, upcoming, completed, or draft.
+     * List cycles
+     */
+    listCycles(requestParameters: ListCyclesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedCycleResponse>;
+    /**
+     * Retrieve details of a specific cycle by its ID. Supports cycle status filtering.
+     * Retrieve cycle
+     */
+    retrieveCycleRaw(requestParameters: RetrieveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Cycle>>;
+    /**
+     * Retrieve details of a specific cycle by its ID. Supports cycle status filtering.
+     * Retrieve cycle
+     */
+    retrieveCycle(requestParameters: RetrieveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Cycle>;
+    /**
+     * Retrieve details of a specific cycle work item.
+     * Retrieve cycle work item
+     */
+    retrieveCycleWorkItemRaw(requestParameters: RetrieveCycleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CycleIssue>>;
+    /**
+     * Retrieve details of a specific cycle work item.
+     * Retrieve cycle work item
+     */
+    retrieveCycleWorkItem(requestParameters: RetrieveCycleWorkItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CycleIssue>;
+    /**
+     * Move incomplete work items from the current cycle to a new target cycle. Captures progress snapshot and transfers only unfinished work items.
+     * Transfer cycle work items
+     */
+    transferCycleWorkItemsRaw(requestParameters: TransferCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransferCycleWorkItems200Response>>;
+    /**
+     * Move incomplete work items from the current cycle to a new target cycle. Captures progress snapshot and transfers only unfinished work items.
+     * Transfer cycle work items
+     */
+    transferCycleWorkItems(requestParameters: TransferCycleWorkItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransferCycleWorkItems200Response>;
+    /**
+     * Restore an archived cycle to active status, making it available for regular use.
+     * Unarchive cycle
+     */
+    unarchiveCycleRaw(requestParameters: UnarchiveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Restore an archived cycle to active status, making it available for regular use.
+     * Unarchive cycle
+     */
+    unarchiveCycle(requestParameters: UnarchiveCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Modify an existing cycle\'s properties like name, description, or date range. Completed cycles can only have their sort order changed.
+     * Update cycle
+     */
+    updateCycleRaw(requestParameters: UpdateCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Cycle>>;
+    /**
+     * Modify an existing cycle\'s properties like name, description, or date range. Completed cycles can only have their sort order changed.
+     * Update cycle
+     */
+    updateCycle(requestParameters: UpdateCycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Cycle>;
+}