@makeplane/plane-node-sdk 0.1.0

package/dist/models/IssueRequest.d.ts

@@ -0,0 +1,167 @@
+/**
+ * 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 { PriorityEnum } from './PriorityEnum';
+/**
+ * Comprehensive work item serializer with full relationship management.
+ *
+ * Handles complete work item lifecycle including assignees, labels, validation,
+ * and related model updates. Supports dynamic field expansion and HTML content processing.
+ * @export
+ * @interface IssueRequest
+ */
+export interface IssueRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof IssueRequest
+     */
+    assignees?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof IssueRequest
+     */
+    labels?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    typeId?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueRequest
+     */
+    deletedAt?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueRequest
+     */
+    point?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    descriptionHtml?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    descriptionStripped?: string | null;
+    /**
+     *
+     * @type {PriorityEnum}
+     * @memberof IssueRequest
+     */
+    priority?: PriorityEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueRequest
+     */
+    startDate?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueRequest
+     */
+    targetDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueRequest
+     */
+    sequenceId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueRequest
+     */
+    sortOrder?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueRequest
+     */
+    completedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueRequest
+     */
+    archivedAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueRequest
+     */
+    isDraft?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    parent?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    state?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    estimatePoint?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueRequest
+     */
+    type?: string | null;
+}
+/**
+ * Check if a given object implements the IssueRequest interface.
+ */
+export declare function instanceOfIssueRequest(value: object): value is IssueRequest;
+export declare function IssueRequestFromJSON(json: any): IssueRequest;
+export declare function IssueRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRequest;
+export declare function IssueRequestToJSON(json: any): IssueRequest;
+export declare function IssueRequestToJSONTyped(value?: IssueRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueRequest.js

@@ -0,0 +1,95 @@
+"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.instanceOfIssueRequest = instanceOfIssueRequest;
+exports.IssueRequestFromJSON = IssueRequestFromJSON;
+exports.IssueRequestFromJSONTyped = IssueRequestFromJSONTyped;
+exports.IssueRequestToJSON = IssueRequestToJSON;
+exports.IssueRequestToJSONTyped = IssueRequestToJSONTyped;
+var PriorityEnum_1 = require("./PriorityEnum");
+/**
+ * Check if a given object implements the IssueRequest interface.
+ */
+function instanceOfIssueRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function IssueRequestFromJSON(json) {
+    return IssueRequestFromJSONTyped(json, false);
+}
+function IssueRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'assignees': json['assignees'] == null ? undefined : json['assignees'],
+        'labels': json['labels'] == null ? undefined : json['labels'],
+        'typeId': json['type_id'] == null ? undefined : json['type_id'],
+        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
+        'point': json['point'] == null ? undefined : json['point'],
+        'name': json['name'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'descriptionStripped': json['description_stripped'] == null ? undefined : json['description_stripped'],
+        'priority': json['priority'] == null ? undefined : (0, PriorityEnum_1.PriorityEnumFromJSON)(json['priority']),
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'targetDate': json['target_date'] == null ? undefined : (new Date(json['target_date'])),
+        'sequenceId': json['sequence_id'] == null ? undefined : json['sequence_id'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
+        'archivedAt': json['archived_at'] == null ? undefined : (new Date(json['archived_at'])),
+        'isDraft': json['is_draft'] == null ? undefined : json['is_draft'],
+        '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'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'estimatePoint': json['estimate_point'] == null ? undefined : json['estimate_point'],
+        'type': json['type'] == null ? undefined : json['type'],
+    };
+}
+function IssueRequestToJSON(json) {
+    return IssueRequestToJSONTyped(json, false);
+}
+function IssueRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'assignees': value['assignees'],
+        'labels': value['labels'],
+        'type_id': value['typeId'],
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'point': value['point'],
+        'name': value['name'],
+        'description_html': value['descriptionHtml'],
+        'description_stripped': value['descriptionStripped'],
+        'priority': (0, PriorityEnum_1.PriorityEnumToJSON)(value['priority']),
+        'start_date': value['startDate'] == null ? undefined : (value['startDate'].toISOString().substring(0, 10)),
+        'target_date': value['targetDate'] == null ? undefined : (value['targetDate'].toISOString().substring(0, 10)),
+        'sequence_id': value['sequenceId'],
+        'sort_order': value['sortOrder'],
+        'completed_at': value['completedAt'] == null ? undefined : (value['completedAt'].toISOString()),
+        'archived_at': value['archivedAt'] == null ? undefined : (value['archivedAt'].toISOString().substring(0, 10)),
+        'is_draft': value['isDraft'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'created_by': value['createdBy'],
+        'parent': value['parent'],
+        'state': value['state'],
+        'estimate_point': value['estimatePoint'],
+        'type': value['type'],
+    };
+}

package/dist/models/IssueSearch.d.ts

@@ -0,0 +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.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+/**
+ * Serializer for work item search result data formatting.
+ *
+ * Provides standardized search result structure including work item identifiers,
+ * project context, and workspace information for search API responses.
+ * @export
+ * @interface IssueSearch
+ */
+export interface IssueSearch {
+    /**
+     * Issue ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    id: string;
+    /**
+     * Issue name
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    name: string;
+    /**
+     * Issue sequence ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    sequenceId: string;
+    /**
+     * Project identifier
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    projectIdentifier: string;
+    /**
+     * Project ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    projectId: string;
+    /**
+     * Workspace slug
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    workspaceSlug: string;
+}
+/**
+ * Check if a given object implements the IssueSearch interface.
+ */
+export declare function instanceOfIssueSearch(value: object): value is IssueSearch;
+export declare function IssueSearchFromJSON(json: any): IssueSearch;
+export declare function IssueSearchFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueSearch;
+export declare function IssueSearchToJSON(json: any): IssueSearch;
+export declare function IssueSearchToJSONTyped(value?: IssueSearch | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueSearch.js

@@ -0,0 +1,70 @@
+"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.instanceOfIssueSearch = instanceOfIssueSearch;
+exports.IssueSearchFromJSON = IssueSearchFromJSON;
+exports.IssueSearchFromJSONTyped = IssueSearchFromJSONTyped;
+exports.IssueSearchToJSON = IssueSearchToJSON;
+exports.IssueSearchToJSONTyped = IssueSearchToJSONTyped;
+/**
+ * Check if a given object implements the IssueSearch interface.
+ */
+function instanceOfIssueSearch(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('sequenceId' in value) || value['sequenceId'] === undefined)
+        return false;
+    if (!('projectIdentifier' in value) || value['projectIdentifier'] === undefined)
+        return false;
+    if (!('projectId' in value) || value['projectId'] === undefined)
+        return false;
+    if (!('workspaceSlug' in value) || value['workspaceSlug'] === undefined)
+        return false;
+    return true;
+}
+function IssueSearchFromJSON(json) {
+    return IssueSearchFromJSONTyped(json, false);
+}
+function IssueSearchFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'sequenceId': json['sequence_id'],
+        'projectIdentifier': json['project__identifier'],
+        'projectId': json['project_id'],
+        'workspaceSlug': json['workspace__slug'],
+    };
+}
+function IssueSearchToJSON(json) {
+    return IssueSearchToJSONTyped(json, false);
+}
+function IssueSearchToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'sequence_id': value['sequenceId'],
+        'project__identifier': value['projectIdentifier'],
+        'project_id': value['projectId'],
+        'workspace__slug': value['workspaceSlug'],
+    };
+}

package/dist/models/IssueTypeAPI.d.ts

@@ -0,0 +1,127 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface IssueTypeAPI
+ */
+export interface IssueTypeAPI {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof IssueTypeAPI
+     */
+    projectIds?: Array<string>;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    description?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueTypeAPI
+     */
+    readonly logoProps?: any | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    isEpic?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    readonly isDefault?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    isActive?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueTypeAPI
+     */
+    readonly level?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly workspace?: string;
+}
+/**
+ * Check if a given object implements the IssueTypeAPI interface.
+ */
+export declare function instanceOfIssueTypeAPI(value: object): value is IssueTypeAPI;
+export declare function IssueTypeAPIFromJSON(json: any): IssueTypeAPI;
+export declare function IssueTypeAPIFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueTypeAPI;
+export declare function IssueTypeAPIToJSON(json: any): IssueTypeAPI;
+export declare function IssueTypeAPIToJSONTyped(value?: Omit<IssueTypeAPI, 'id' | 'deleted_at' | 'created_at' | 'updated_at' | 'logo_props' | 'is_default' | 'level' | 'created_by' | 'updated_by' | 'workspace'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueTypeAPI.js

@@ -0,0 +1,72 @@
+"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.instanceOfIssueTypeAPI = instanceOfIssueTypeAPI;
+exports.IssueTypeAPIFromJSON = IssueTypeAPIFromJSON;
+exports.IssueTypeAPIFromJSONTyped = IssueTypeAPIFromJSONTyped;
+exports.IssueTypeAPIToJSON = IssueTypeAPIToJSON;
+exports.IssueTypeAPIToJSONTyped = IssueTypeAPIToJSONTyped;
+/**
+ * Check if a given object implements the IssueTypeAPI interface.
+ */
+function instanceOfIssueTypeAPI(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function IssueTypeAPIFromJSON(json) {
+    return IssueTypeAPIFromJSONTyped(json, false);
+}
+function IssueTypeAPIFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
+        'projectIds': json['project_ids'] == null ? undefined : json['project_ids'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
+        'isEpic': json['is_epic'] == null ? undefined : json['is_epic'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'level': json['level'] == null ? undefined : json['level'],
+        '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'],
+    };
+}
+function IssueTypeAPIToJSON(json) {
+    return IssueTypeAPIToJSONTyped(json, false);
+}
+function IssueTypeAPIToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'project_ids': value['projectIds'],
+        'name': value['name'],
+        'description': value['description'],
+        'is_epic': value['isEpic'],
+        'is_active': value['isActive'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+    };
+}

package/dist/models/IssueTypeAPIRequest.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface IssueTypeAPIRequest
+ */
+export interface IssueTypeAPIRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof IssueTypeAPIRequest
+     */
+    projectIds?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueTypeAPIRequest
+     */
+    isEpic?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueTypeAPIRequest
+     */
+    isActive?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    externalId?: string | null;
+}
+/**
+ * Check if a given object implements the IssueTypeAPIRequest interface.
+ */
+export declare function instanceOfIssueTypeAPIRequest(value: object): value is IssueTypeAPIRequest;
+export declare function IssueTypeAPIRequestFromJSON(json: any): IssueTypeAPIRequest;
+export declare function IssueTypeAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueTypeAPIRequest;
+export declare function IssueTypeAPIRequestToJSON(json: any): IssueTypeAPIRequest;
+export declare function IssueTypeAPIRequestToJSONTyped(value?: IssueTypeAPIRequest | null, ignoreDiscriminator?: boolean): any;