@makeplane/plane-node-sdk 0.1.5 → 0.2.0

package/dist/models/Cycle.d.ts

@@ -1,215 +1,64 @@
-/**
- * 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.2
- * Contact: support@plane.so
- *
- * NOTE: This class is auto generated.
- * Do not edit the class manually.
- */
-import type { TimezoneEnum } from './TimezoneEnum';
-/**
- * Cycle serializer with comprehensive project metrics and time tracking.
- *
- * Provides cycle details including work item counts by status, progress estimates,
- * and time-bound iteration data for project management and sprint planning.
- * @export
- * @interface Cycle
- */
-export interface Cycle {
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly id?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly totalIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly cancelledIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly completedIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly startedIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly unstartedIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly backlogIssues?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly totalEstimates?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly completedEstimates?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    readonly startedEstimates?: number;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    readonly createdAt?: Date;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    readonly updatedAt?: Date;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    readonly deletedAt?: Date | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
+import { BaseModel, TimezoneEnum } from "./common";
+export interface TransferCycleWorkItemRequest {
+    new_cycle_id: string;
+}
+export interface CycleWorkItem {
+    id?: string;
+    sub_issues_count?: number;
+    created_at?: string;
+    updated_at?: string;
+    deleted_at: string;
+    created_by?: string;
+    updated_by?: string;
+    project?: string;
+    workspace?: string;
+    issue: string;
+    cycle?: string;
+}
+export interface Cycle extends BaseModel {
     name: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
     description?: string;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    startDate?: Date | null;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    endDate?: Date | null;
-    /**
-     *
-     * @type {any}
-     * @memberof Cycle
-     */
-    viewProps?: any | null;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
-    sortOrder?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    externalSource?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    externalId?: string | null;
-    /**
-     *
-     * @type {any}
-     * @memberof Cycle
-     */
-    progressSnapshot?: any | null;
-    /**
-     *
-     * @type {Date}
-     * @memberof Cycle
-     */
-    archivedAt?: Date | null;
-    /**
-     *
-     * @type {any}
-     * @memberof Cycle
-     */
-    logoProps?: any | null;
-    /**
-     *
-     * @type {TimezoneEnum}
-     * @memberof Cycle
-     */
+    start_date?: string;
+    end_date?: string;
+    view_props?: any;
+    sort_order?: number;
+    progress_snapshot?: any;
+    archived_at?: string;
+    logo_props?: any;
     timezone?: TimezoneEnum;
-    /**
-     *
-     * @type {number}
-     * @memberof Cycle
-     */
     version?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly createdBy?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly updatedBy?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly project?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly workspace?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Cycle
-     */
-    readonly ownedBy?: string;
+    project: string;
+    workspace: string;
+    owned_by: string;
+}
+export interface CreateCycleRequest {
+    name: string;
+    description?: string;
+    start_date?: string;
+    end_date?: string;
+    owned_by: string;
+    external_source?: string;
+    external_id?: string;
+    timezone?: TimezoneEnum;
+    project_id: string;
+}
+export interface UpdateCycleRequest {
+    name?: string;
+    description?: string;
+    start_date?: string;
+    end_date?: string;
+    owned_by?: string;
+    external_source?: string;
+    external_id?: string;
+    timezone?: TimezoneEnum;
+}
+export interface AddWorkItemsToCycleRequest {
+    issues: string[];
+}
+export interface RemoveCycleIssuesRequestRequest {
+    issues: string[];
+}
+export interface TransferCycleIssueRequestRequest {
+    new_cycle_id: string;
 }
-/**
- * Check if a given object implements the Cycle interface.
- */
-export declare function instanceOfCycle(value: object): value is Cycle;
-export declare function CycleFromJSON(json: any): Cycle;
-export declare function CycleFromJSONTyped(json: any, ignoreDiscriminator: boolean): Cycle;
-export declare function CycleToJSON(json: any): Cycle;
-export declare function CycleToJSONTyped(value?: Omit<Cycle, 'id' | 'total_issues' | 'cancelled_issues' | 'completed_issues' | 'started_issues' | 'unstarted_issues' | 'backlog_issues' | 'total_estimates' | 'completed_estimates' | 'started_estimates' | 'created_at' | 'updated_at' | 'deleted_at' | 'created_by' | 'updated_by' | 'project' | 'workspace' | 'owned_by'> | null, ignoreDiscriminator?: boolean): any;
+//# sourceMappingURL=Cycle.d.ts.map

package/dist/models/Cycle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cycle.d.ts","sourceRoot":"","sources":["../../src/models/Cycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEnD,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,KAAM,SAAQ,SAAS;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,GAAG,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/models/Cycle.js

@@ -1,93 +1,3 @@
 "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.2
- * Contact: support@plane.so
- *
- * NOTE: This class is auto generated.
- * Do not edit the class manually.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instanceOfCycle = instanceOfCycle;
-exports.CycleFromJSON = CycleFromJSON;
-exports.CycleFromJSONTyped = CycleFromJSONTyped;
-exports.CycleToJSON = CycleToJSON;
-exports.CycleToJSONTyped = CycleToJSONTyped;
-var TimezoneEnum_1 = require("./TimezoneEnum");
-/**
- * Check if a given object implements the Cycle interface.
- */
-function instanceOfCycle(value) {
-    if (!('name' in value) || value['name'] === undefined)
-        return false;
-    return true;
-}
-function CycleFromJSON(json) {
-    return CycleFromJSONTyped(json, false);
-}
-function CycleFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'id': json['id'] == null ? undefined : json['id'],
-        'totalIssues': json['total_issues'] == null ? undefined : json['total_issues'],
-        'cancelledIssues': json['cancelled_issues'] == null ? undefined : json['cancelled_issues'],
-        'completedIssues': json['completed_issues'] == null ? undefined : json['completed_issues'],
-        'startedIssues': json['started_issues'] == null ? undefined : json['started_issues'],
-        'unstartedIssues': json['unstarted_issues'] == null ? undefined : json['unstarted_issues'],
-        'backlogIssues': json['backlog_issues'] == null ? undefined : json['backlog_issues'],
-        'totalEstimates': json['total_estimates'] == null ? undefined : json['total_estimates'],
-        'completedEstimates': json['completed_estimates'] == null ? undefined : json['completed_estimates'],
-        'startedEstimates': json['started_estimates'] == null ? undefined : json['started_estimates'],
-        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
-        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
-        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
-        'name': json['name'],
-        'description': json['description'] == null ? undefined : json['description'],
-        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
-        'endDate': json['end_date'] == null ? undefined : (new Date(json['end_date'])),
-        'viewProps': json['view_props'] == null ? undefined : json['view_props'],
-        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
-        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
-        'externalId': json['external_id'] == null ? undefined : json['external_id'],
-        'progressSnapshot': json['progress_snapshot'] == null ? undefined : json['progress_snapshot'],
-        'archivedAt': json['archived_at'] == null ? undefined : (new Date(json['archived_at'])),
-        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
-        'timezone': json['timezone'] == null ? undefined : (0, TimezoneEnum_1.TimezoneEnumFromJSON)(json['timezone']),
-        'version': json['version'] == null ? undefined : json['version'],
-        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
-        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
-        'project': json['project'] == null ? undefined : json['project'],
-        'workspace': json['workspace'] == null ? undefined : json['workspace'],
-        'ownedBy': json['owned_by'] == null ? undefined : json['owned_by'],
-    };
-}
-function CycleToJSON(json) {
-    return CycleToJSONTyped(json, false);
-}
-function CycleToJSONTyped(value, ignoreDiscriminator) {
-    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
-    if (value == null) {
-        return value;
-    }
-    return {
-        'name': value['name'],
-        'description': value['description'],
-        'start_date': value['startDate'] == null ? undefined : (value['startDate'].toISOString()),
-        'end_date': value['endDate'] == null ? undefined : (value['endDate'].toISOString()),
-        'view_props': value['viewProps'],
-        'sort_order': value['sortOrder'],
-        'external_source': value['externalSource'],
-        'external_id': value['externalId'],
-        'progress_snapshot': value['progressSnapshot'],
-        'archived_at': value['archivedAt'] == null ? undefined : (value['archivedAt'].toISOString()),
-        'logo_props': value['logoProps'],
-        'timezone': (0, TimezoneEnum_1.TimezoneEnumToJSON)(value['timezone']),
-        'version': value['version'],
-    };
-}
+//# sourceMappingURL=Cycle.js.map

package/dist/models/Cycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cycle.js","sourceRoot":"","sources":["../../src/models/Cycle.ts"],"names":[],"mappings":""}

package/dist/models/Epic.d.ts

@@ -1,206 +1,34 @@
-/**
- * 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.2
- * Contact: support@plane.so
- *
- * NOTE: This class is auto generated.
- * Do not edit the class manually.
- */
-import type { PriorityEnum } from './PriorityEnum';
-/**
- *
- * @export
- * @interface Epic
- */
+import { PriorityEnum } from "./common";
 export interface Epic {
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    readonly id?: string;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    readonly deletedAt?: Date | null;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    readonly createdAt?: Date;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    readonly updatedAt?: Date;
-    /**
-     *
-     * @type {number}
-     * @memberof Epic
-     */
-    point?: number | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
+    id?: string;
+    deleted_at?: string;
+    created_at?: string;
+    updated_at?: string;
+    point?: number;
     name: string;
-    /**
-     *
-     * @type {any}
-     * @memberof Epic
-     */
-    description?: any | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    descriptionHtml?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    descriptionStripped?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    readonly descriptionBinary?: string | null;
-    /**
-     *
-     * @type {PriorityEnum}
-     * @memberof Epic
-     */
+    description?: any;
+    description_html?: string;
+    description_stripped?: string;
+    description_binary?: string;
     priority?: PriorityEnum;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    startDate?: Date | null;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    targetDate?: Date | null;
-    /**
-     *
-     * @type {number}
-     * @memberof Epic
-     */
-    sequenceId?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Epic
-     */
-    sortOrder?: number;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    completedAt?: Date | null;
-    /**
-     *
-     * @type {Date}
-     * @memberof Epic
-     */
-    archivedAt?: Date | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Epic
-     */
-    isDraft?: boolean;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    externalSource?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    externalId?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    createdBy?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    updatedBy?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
+    start_date?: string;
+    target_date?: string;
+    sequence_id?: number;
+    sort_order?: number;
+    completed_at?: string;
+    archived_at?: string;
+    is_draft?: boolean;
+    external_source?: string;
+    external_id?: string;
+    created_by?: string;
+    updated_by?: string;
     project: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
     workspace: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    parent?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    state?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    estimatePoint?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Epic
-     */
-    type?: string | null;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof Epic
-     */
-    readonly assignees?: Array<string>;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof Epic
-     */
-    readonly labels?: Array<string>;
+    parent?: string;
+    state?: string;
+    estimate_point?: string;
+    type?: string;
+    assignees?: string[];
+    labels?: string[];
 }
-/**
- * Check if a given object implements the Epic interface.
- */
-export declare function instanceOfEpic(value: object): value is Epic;
-export declare function EpicFromJSON(json: any): Epic;
-export declare function EpicFromJSONTyped(json: any, ignoreDiscriminator: boolean): Epic;
-export declare function EpicToJSON(json: any): Epic;
-export declare function EpicToJSONTyped(value?: Omit<Epic, 'id' | 'deleted_at' | 'created_at' | 'updated_at' | 'description_binary' | 'assignees' | 'labels'> | null, ignoreDiscriminator?: boolean): any;
+//# sourceMappingURL=Epic.d.ts.map

package/dist/models/Epic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Epic.d.ts","sourceRoot":"","sources":["../../src/models/Epic.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,WAAW,IAAI;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,GAAG,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}