@makeplane/plane-node-sdk 0.1.0

package/dist/apis/index.d.ts

@@ -0,0 +1,17 @@
+export * from './AssetsApi';
+export * from './CyclesApi';
+export * from './IntakeApi';
+export * from './LabelsApi';
+export * from './MembersApi';
+export * from './ModulesApi';
+export * from './ProjectsApi';
+export * from './StatesApi';
+export * from './UsersApi';
+export * from './WorkItemActivityApi';
+export * from './WorkItemAttachmentsApi';
+export * from './WorkItemCommentsApi';
+export * from './WorkItemLinksApi';
+export * from './WorkItemPropertiesApi';
+export * from './WorkItemTypesApi';
+export * from './WorkItemWorklogsApi';
+export * from './WorkItemsApi';

package/dist/apis/index.js

@@ -0,0 +1,34 @@
+"use strict";
+/* tslint:disable */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AssetsApi"), exports);
+__exportStar(require("./CyclesApi"), exports);
+__exportStar(require("./IntakeApi"), exports);
+__exportStar(require("./LabelsApi"), exports);
+__exportStar(require("./MembersApi"), exports);
+__exportStar(require("./ModulesApi"), exports);
+__exportStar(require("./ProjectsApi"), exports);
+__exportStar(require("./StatesApi"), exports);
+__exportStar(require("./UsersApi"), exports);
+__exportStar(require("./WorkItemActivityApi"), exports);
+__exportStar(require("./WorkItemAttachmentsApi"), exports);
+__exportStar(require("./WorkItemCommentsApi"), exports);
+__exportStar(require("./WorkItemLinksApi"), exports);
+__exportStar(require("./WorkItemPropertiesApi"), exports);
+__exportStar(require("./WorkItemTypesApi"), exports);
+__exportStar(require("./WorkItemWorklogsApi"), exports);
+__exportStar(require("./WorkItemsApi"), exports);

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+/* tslint:disable */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./runtime"), exports);
+__exportStar(require("./apis/index"), exports);
+__exportStar(require("./models/index"), exports);

package/dist/models/AccessEnum.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+/**
+ * * `INTERNAL` - INTERNAL
+ * * `EXTERNAL` - EXTERNAL
+ * @export
+ */
+export declare const AccessEnum: {
+    readonly Internal: "INTERNAL";
+    readonly External: "EXTERNAL";
+};
+export type AccessEnum = typeof AccessEnum[keyof typeof AccessEnum];
+export declare function instanceOfAccessEnum(value: any): boolean;
+export declare function AccessEnumFromJSON(json: any): AccessEnum;
+export declare function AccessEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessEnum;
+export declare function AccessEnumToJSON(value?: AccessEnum | null): any;
+export declare function AccessEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): AccessEnum;

package/dist/models/AccessEnum.js

@@ -0,0 +1,51 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccessEnum = void 0;
+exports.instanceOfAccessEnum = instanceOfAccessEnum;
+exports.AccessEnumFromJSON = AccessEnumFromJSON;
+exports.AccessEnumFromJSONTyped = AccessEnumFromJSONTyped;
+exports.AccessEnumToJSON = AccessEnumToJSON;
+exports.AccessEnumToJSONTyped = AccessEnumToJSONTyped;
+/**
+ * * `INTERNAL` - INTERNAL
+ * * `EXTERNAL` - EXTERNAL
+ * @export
+ */
+exports.AccessEnum = {
+    Internal: 'INTERNAL',
+    External: 'EXTERNAL'
+};
+function instanceOfAccessEnum(value) {
+    for (var key in exports.AccessEnum) {
+        if (Object.prototype.hasOwnProperty.call(exports.AccessEnum, key)) {
+            if (exports.AccessEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function AccessEnumFromJSON(json) {
+    return AccessEnumFromJSONTyped(json, false);
+}
+function AccessEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function AccessEnumToJSON(value) {
+    return value;
+}
+function AccessEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/Cycle.d.ts

@@ -0,0 +1,215 @@
+/**
+ * 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 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
+     */
+    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
+     */
+    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;
+}
+/**
+ * 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;

package/dist/models/Cycle.js

@@ -0,0 +1,93 @@
+"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.
+ */
+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'],
+    };
+}

package/dist/models/CycleCreateRequest.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 type { TimezoneEnum } from './TimezoneEnum';
+/**
+ * Serializer for creating cycles with timezone handling and date validation.
+ *
+ * Manages cycle creation including project timezone conversion, date range validation,
+ * and UTC normalization for time-bound iteration planning and sprint management.
+ * @export
+ * @interface CycleCreateRequest
+ */
+export interface CycleCreateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CycleCreateRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleCreateRequest
+     */
+    description?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CycleCreateRequest
+     */
+    startDate?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CycleCreateRequest
+     */
+    endDate?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleCreateRequest
+     */
+    ownedBy: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleCreateRequest
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleCreateRequest
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {TimezoneEnum}
+     * @memberof CycleCreateRequest
+     */
+    timezone?: TimezoneEnum;
+}
+/**
+ * Check if a given object implements the CycleCreateRequest interface.
+ */
+export declare function instanceOfCycleCreateRequest(value: object): value is CycleCreateRequest;
+export declare function CycleCreateRequestFromJSON(json: any): CycleCreateRequest;
+export declare function CycleCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CycleCreateRequest;
+export declare function CycleCreateRequestToJSON(json: any): CycleCreateRequest;
+export declare function CycleCreateRequestToJSONTyped(value?: CycleCreateRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CycleCreateRequest.js

@@ -0,0 +1,67 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCycleCreateRequest = instanceOfCycleCreateRequest;
+exports.CycleCreateRequestFromJSON = CycleCreateRequestFromJSON;
+exports.CycleCreateRequestFromJSONTyped = CycleCreateRequestFromJSONTyped;
+exports.CycleCreateRequestToJSON = CycleCreateRequestToJSON;
+exports.CycleCreateRequestToJSONTyped = CycleCreateRequestToJSONTyped;
+var TimezoneEnum_1 = require("./TimezoneEnum");
+/**
+ * Check if a given object implements the CycleCreateRequest interface.
+ */
+function instanceOfCycleCreateRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('ownedBy' in value) || value['ownedBy'] === undefined)
+        return false;
+    return true;
+}
+function CycleCreateRequestFromJSON(json) {
+    return CycleCreateRequestFromJSONTyped(json, false);
+}
+function CycleCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        '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'])),
+        'ownedBy': json['owned_by'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'timezone': json['timezone'] == null ? undefined : (0, TimezoneEnum_1.TimezoneEnumFromJSON)(json['timezone']),
+    };
+}
+function CycleCreateRequestToJSON(json) {
+    return CycleCreateRequestToJSONTyped(json, false);
+}
+function CycleCreateRequestToJSONTyped(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()),
+        'owned_by': value['ownedBy'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'timezone': (0, TimezoneEnum_1.TimezoneEnumToJSON)(value['timezone']),
+    };
+}