@makeplane/plane-node-sdk 0.1.0

package/dist/models/Project.d.ts

@@ -0,0 +1,294 @@
+/**
+ * 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 { NetworkEnum } from './NetworkEnum';
+import type { TimezoneEnum } from './TimezoneEnum';
+/**
+ * Comprehensive project serializer with metrics and member context.
+ *
+ * Provides complete project data including member counts, cycle/module totals,
+ * deployment status, and user-specific context for project management.
+ * @export
+ * @interface Project
+ */
+export interface Project {
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    readonly totalMembers?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    readonly totalCycles?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    readonly totalModules?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    readonly isMember?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    readonly sortOrder?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    readonly memberRole?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    readonly isDeployed?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly coverImageUrl?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Project
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Project
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Project
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    description?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof Project
+     */
+    descriptionText?: any | null;
+    /**
+     *
+     * @type {any}
+     * @memberof Project
+     */
+    descriptionHtml?: any | null;
+    /**
+     *
+     * @type {NetworkEnum}
+     * @memberof Project
+     */
+    network?: NetworkEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    identifier: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly emoji?: string | null;
+    /**
+     *
+     * @type {any}
+     * @memberof Project
+     */
+    iconProp?: any | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    moduleView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    cycleView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    issueViewsView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    pageView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    intakeView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    isTimeTrackingEnabled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    isIssueTypeEnabled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Project
+     */
+    guestViewAllFeatures?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    coverImage?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    archiveIn?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Project
+     */
+    closeIn?: number;
+    /**
+     *
+     * @type {any}
+     * @memberof Project
+     */
+    logoProps?: any | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof Project
+     */
+    archivedAt?: Date | null;
+    /**
+     *
+     * @type {TimezoneEnum}
+     * @memberof Project
+     */
+    timezone?: TimezoneEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    readonly workspace?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    defaultAssignee?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    projectLead?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    coverImageAsset?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    estimate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Project
+     */
+    defaultState?: string | null;
+}
+/**
+ * Check if a given object implements the Project interface.
+ */
+export declare function instanceOfProject(value: object): value is Project;
+export declare function ProjectFromJSON(json: any): Project;
+export declare function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): Project;
+export declare function ProjectToJSON(json: any): Project;
+export declare function ProjectToJSONTyped(value?: Omit<Project, 'id' | 'total_members' | 'total_cycles' | 'total_modules' | 'is_member' | 'sort_order' | 'member_role' | 'is_deployed' | 'cover_image_url' | 'created_at' | 'updated_at' | 'deleted_at' | 'emoji' | 'created_by' | 'updated_by' | 'workspace'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/Project.js

@@ -0,0 +1,124 @@
+"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.instanceOfProject = instanceOfProject;
+exports.ProjectFromJSON = ProjectFromJSON;
+exports.ProjectFromJSONTyped = ProjectFromJSONTyped;
+exports.ProjectToJSON = ProjectToJSON;
+exports.ProjectToJSONTyped = ProjectToJSONTyped;
+var NetworkEnum_1 = require("./NetworkEnum");
+var TimezoneEnum_1 = require("./TimezoneEnum");
+/**
+ * Check if a given object implements the Project interface.
+ */
+function instanceOfProject(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('identifier' in value) || value['identifier'] === undefined)
+        return false;
+    return true;
+}
+function ProjectFromJSON(json) {
+    return ProjectFromJSONTyped(json, false);
+}
+function ProjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'totalMembers': json['total_members'] == null ? undefined : json['total_members'],
+        'totalCycles': json['total_cycles'] == null ? undefined : json['total_cycles'],
+        'totalModules': json['total_modules'] == null ? undefined : json['total_modules'],
+        'isMember': json['is_member'] == null ? undefined : json['is_member'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        'memberRole': json['member_role'] == null ? undefined : json['member_role'],
+        'isDeployed': json['is_deployed'] == null ? undefined : json['is_deployed'],
+        'coverImageUrl': json['cover_image_url'] == null ? undefined : json['cover_image_url'],
+        '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'],
+        'descriptionText': json['description_text'] == null ? undefined : json['description_text'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'network': json['network'] == null ? undefined : (0, NetworkEnum_1.NetworkEnumFromJSON)(json['network']),
+        'identifier': json['identifier'],
+        'emoji': json['emoji'] == null ? undefined : json['emoji'],
+        'iconProp': json['icon_prop'] == null ? undefined : json['icon_prop'],
+        'moduleView': json['module_view'] == null ? undefined : json['module_view'],
+        'cycleView': json['cycle_view'] == null ? undefined : json['cycle_view'],
+        'issueViewsView': json['issue_views_view'] == null ? undefined : json['issue_views_view'],
+        'pageView': json['page_view'] == null ? undefined : json['page_view'],
+        'intakeView': json['intake_view'] == null ? undefined : json['intake_view'],
+        'isTimeTrackingEnabled': json['is_time_tracking_enabled'] == null ? undefined : json['is_time_tracking_enabled'],
+        'isIssueTypeEnabled': json['is_issue_type_enabled'] == null ? undefined : json['is_issue_type_enabled'],
+        'guestViewAllFeatures': json['guest_view_all_features'] == null ? undefined : json['guest_view_all_features'],
+        'coverImage': json['cover_image'] == null ? undefined : json['cover_image'],
+        'archiveIn': json['archive_in'] == null ? undefined : json['archive_in'],
+        'closeIn': json['close_in'] == null ? undefined : json['close_in'],
+        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
+        'archivedAt': json['archived_at'] == null ? undefined : (new Date(json['archived_at'])),
+        'timezone': json['timezone'] == null ? undefined : (0, TimezoneEnum_1.TimezoneEnumFromJSON)(json['timezone']),
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+        'workspace': json['workspace'] == null ? undefined : json['workspace'],
+        'defaultAssignee': json['default_assignee'] == null ? undefined : json['default_assignee'],
+        'projectLead': json['project_lead'] == null ? undefined : json['project_lead'],
+        'coverImageAsset': json['cover_image_asset'] == null ? undefined : json['cover_image_asset'],
+        'estimate': json['estimate'] == null ? undefined : json['estimate'],
+        'defaultState': json['default_state'] == null ? undefined : json['default_state'],
+    };
+}
+function ProjectToJSON(json) {
+    return ProjectToJSONTyped(json, false);
+}
+function ProjectToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'description_text': value['descriptionText'],
+        'description_html': value['descriptionHtml'],
+        'network': (0, NetworkEnum_1.NetworkEnumToJSON)(value['network']),
+        'identifier': value['identifier'],
+        'icon_prop': value['iconProp'],
+        'module_view': value['moduleView'],
+        'cycle_view': value['cycleView'],
+        'issue_views_view': value['issueViewsView'],
+        'page_view': value['pageView'],
+        'intake_view': value['intakeView'],
+        'is_time_tracking_enabled': value['isTimeTrackingEnabled'],
+        'is_issue_type_enabled': value['isIssueTypeEnabled'],
+        'guest_view_all_features': value['guestViewAllFeatures'],
+        'cover_image': value['coverImage'],
+        'archive_in': value['archiveIn'],
+        'close_in': value['closeIn'],
+        'logo_props': value['logoProps'],
+        'archived_at': value['archivedAt'] == null ? undefined : (value['archivedAt'].toISOString()),
+        'timezone': (0, TimezoneEnum_1.TimezoneEnumToJSON)(value['timezone']),
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'default_assignee': value['defaultAssignee'],
+        'project_lead': value['projectLead'],
+        'cover_image_asset': value['coverImageAsset'],
+        'estimate': value['estimate'],
+        'default_state': value['defaultState'],
+    };
+}

package/dist/models/ProjectCreateRequest.d.ts

@@ -0,0 +1,131 @@
+/**
+ * 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 projects with workspace validation.
+ *
+ * Handles project creation including identifier validation, member verification,
+ * and workspace association for new project initialization.
+ * @export
+ * @interface ProjectCreateRequest
+ */
+export interface ProjectCreateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    projectLead?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    defaultAssignee?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    identifier: string;
+    /**
+     *
+     * @type {any}
+     * @memberof ProjectCreateRequest
+     */
+    iconProp?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    emoji?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectCreateRequest
+     */
+    coverImage?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    moduleView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    cycleView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    issueViewsView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    pageView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    intakeView?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectCreateRequest
+     */
+    guestViewAllFeatures?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectCreateRequest
+     */
+    archiveIn?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectCreateRequest
+     */
+    closeIn?: number;
+    /**
+     *
+     * @type {TimezoneEnum}
+     * @memberof ProjectCreateRequest
+     */
+    timezone?: TimezoneEnum;
+}
+/**
+ * Check if a given object implements the ProjectCreateRequest interface.
+ */
+export declare function instanceOfProjectCreateRequest(value: object): value is ProjectCreateRequest;
+export declare function ProjectCreateRequestFromJSON(json: any): ProjectCreateRequest;
+export declare function ProjectCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectCreateRequest;
+export declare function ProjectCreateRequestToJSON(json: any): ProjectCreateRequest;
+export declare function ProjectCreateRequestToJSONTyped(value?: ProjectCreateRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ProjectCreateRequest.js

@@ -0,0 +1,85 @@
+"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.instanceOfProjectCreateRequest = instanceOfProjectCreateRequest;
+exports.ProjectCreateRequestFromJSON = ProjectCreateRequestFromJSON;
+exports.ProjectCreateRequestFromJSONTyped = ProjectCreateRequestFromJSONTyped;
+exports.ProjectCreateRequestToJSON = ProjectCreateRequestToJSON;
+exports.ProjectCreateRequestToJSONTyped = ProjectCreateRequestToJSONTyped;
+var TimezoneEnum_1 = require("./TimezoneEnum");
+/**
+ * Check if a given object implements the ProjectCreateRequest interface.
+ */
+function instanceOfProjectCreateRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('identifier' in value) || value['identifier'] === undefined)
+        return false;
+    return true;
+}
+function ProjectCreateRequestFromJSON(json) {
+    return ProjectCreateRequestFromJSONTyped(json, false);
+}
+function ProjectCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'projectLead': json['project_lead'] == null ? undefined : json['project_lead'],
+        'defaultAssignee': json['default_assignee'] == null ? undefined : json['default_assignee'],
+        'identifier': json['identifier'],
+        'iconProp': json['icon_prop'] == null ? undefined : json['icon_prop'],
+        'emoji': json['emoji'] == null ? undefined : json['emoji'],
+        'coverImage': json['cover_image'] == null ? undefined : json['cover_image'],
+        'moduleView': json['module_view'] == null ? undefined : json['module_view'],
+        'cycleView': json['cycle_view'] == null ? undefined : json['cycle_view'],
+        'issueViewsView': json['issue_views_view'] == null ? undefined : json['issue_views_view'],
+        'pageView': json['page_view'] == null ? undefined : json['page_view'],
+        'intakeView': json['intake_view'] == null ? undefined : json['intake_view'],
+        'guestViewAllFeatures': json['guest_view_all_features'] == null ? undefined : json['guest_view_all_features'],
+        'archiveIn': json['archive_in'] == null ? undefined : json['archive_in'],
+        'closeIn': json['close_in'] == null ? undefined : json['close_in'],
+        'timezone': json['timezone'] == null ? undefined : (0, TimezoneEnum_1.TimezoneEnumFromJSON)(json['timezone']),
+    };
+}
+function ProjectCreateRequestToJSON(json) {
+    return ProjectCreateRequestToJSONTyped(json, false);
+}
+function ProjectCreateRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'project_lead': value['projectLead'],
+        'default_assignee': value['defaultAssignee'],
+        'identifier': value['identifier'],
+        'icon_prop': value['iconProp'],
+        'emoji': value['emoji'],
+        'cover_image': value['coverImage'],
+        'module_view': value['moduleView'],
+        'cycle_view': value['cycleView'],
+        'issue_views_view': value['issueViewsView'],
+        'page_view': value['pageView'],
+        'intake_view': value['intakeView'],
+        'guest_view_all_features': value['guestViewAllFeatures'],
+        'archive_in': value['archiveIn'],
+        'close_in': value['closeIn'],
+        'timezone': (0, TimezoneEnum_1.TimezoneEnumToJSON)(value['timezone']),
+    };
+}

package/dist/models/ProjectWorklogSummary.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ * Serializer for project worklog summary with aggregated duration per issue
+ * @export
+ * @interface ProjectWorklogSummary
+ */
+export interface ProjectWorklogSummary {
+    /**
+     * ID of the work item
+     * @type {string}
+     * @memberof ProjectWorklogSummary
+     */
+    issueId: string;
+    /**
+     * Total duration logged for this work item in seconds
+     * @type {number}
+     * @memberof ProjectWorklogSummary
+     */
+    duration: number;
+}
+/**
+ * Check if a given object implements the ProjectWorklogSummary interface.
+ */
+export declare function instanceOfProjectWorklogSummary(value: object): value is ProjectWorklogSummary;
+export declare function ProjectWorklogSummaryFromJSON(json: any): ProjectWorklogSummary;
+export declare function ProjectWorklogSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectWorklogSummary;
+export declare function ProjectWorklogSummaryToJSON(json: any): ProjectWorklogSummary;
+export declare function ProjectWorklogSummaryToJSONTyped(value?: ProjectWorklogSummary | null, ignoreDiscriminator?: boolean): any;