@makeplane/plane-node-sdk 0.1.0

package/dist/models/IssueCommentCreateRequest.js

@@ -0,0 +1,57 @@
+"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.instanceOfIssueCommentCreateRequest = instanceOfIssueCommentCreateRequest;
+exports.IssueCommentCreateRequestFromJSON = IssueCommentCreateRequestFromJSON;
+exports.IssueCommentCreateRequestFromJSONTyped = IssueCommentCreateRequestFromJSONTyped;
+exports.IssueCommentCreateRequestToJSON = IssueCommentCreateRequestToJSON;
+exports.IssueCommentCreateRequestToJSONTyped = IssueCommentCreateRequestToJSONTyped;
+var AccessEnum_1 = require("./AccessEnum");
+/**
+ * Check if a given object implements the IssueCommentCreateRequest interface.
+ */
+function instanceOfIssueCommentCreateRequest(value) {
+    return true;
+}
+function IssueCommentCreateRequestFromJSON(json) {
+    return IssueCommentCreateRequestFromJSONTyped(json, false);
+}
+function IssueCommentCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'commentJson': json['comment_json'] == null ? undefined : json['comment_json'],
+        'commentHtml': json['comment_html'] == null ? undefined : json['comment_html'],
+        'access': json['access'] == null ? undefined : (0, AccessEnum_1.AccessEnumFromJSON)(json['access']),
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+function IssueCommentCreateRequestToJSON(json) {
+    return IssueCommentCreateRequestToJSONTyped(json, false);
+}
+function IssueCommentCreateRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'comment_json': value['commentJson'],
+        'comment_html': value['commentHtml'],
+        'access': (0, AccessEnum_1.AccessEnumToJSON)(value['access']),
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+    };
+}

package/dist/models/IssueExpand.d.ts

@@ -0,0 +1,226 @@
+/**
+ * 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';
+import type { StateLite } from './StateLite';
+import type { LabelLite } from './LabelLite';
+import type { CycleLite } from './CycleLite';
+import type { ModuleLite } from './ModuleLite';
+import type { UserLite } from './UserLite';
+/**
+ * Extended work item serializer with full relationship expansion.
+ *
+ * Provides work items with expanded related data including cycles, modules,
+ * labels, assignees, and states for comprehensive data representation.
+ * @export
+ * @interface IssueExpand
+ */
+export interface IssueExpand {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {CycleLite}
+     * @memberof IssueExpand
+     */
+    readonly cycle?: CycleLite;
+    /**
+     *
+     * @type {ModuleLite}
+     * @memberof IssueExpand
+     */
+    readonly module?: ModuleLite;
+    /**
+     *
+     * @type {Array<LabelLite>}
+     * @memberof IssueExpand
+     */
+    readonly labels?: Array<LabelLite>;
+    /**
+     *
+     * @type {Array<UserLite>}
+     * @memberof IssueExpand
+     */
+    readonly assignees?: Array<UserLite>;
+    /**
+     *
+     * @type {StateLite}
+     * @memberof IssueExpand
+     */
+    readonly state?: StateLite;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    deletedAt?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueExpand
+     */
+    point?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    name: string;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueExpand
+     */
+    description?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    descriptionHtml?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    descriptionStripped?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly descriptionBinary?: string | null;
+    /**
+     *
+     * @type {PriorityEnum}
+     * @memberof IssueExpand
+     */
+    priority?: PriorityEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    startDate?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    targetDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueExpand
+     */
+    sequenceId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueExpand
+     */
+    sortOrder?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    completedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueExpand
+     */
+    archivedAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueExpand
+     */
+    isDraft?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly project?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    readonly workspace?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    parent?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    estimatePoint?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueExpand
+     */
+    type?: string | null;
+}
+/**
+ * Check if a given object implements the IssueExpand interface.
+ */
+export declare function instanceOfIssueExpand(value: object): value is IssueExpand;
+export declare function IssueExpandFromJSON(json: any): IssueExpand;
+export declare function IssueExpandFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueExpand;
+export declare function IssueExpandToJSON(json: any): IssueExpand;
+export declare function IssueExpandToJSONTyped(value?: Omit<IssueExpand, 'id' | 'cycle' | 'module' | 'labels' | 'assignees' | 'state' | 'created_at' | 'updated_at' | 'description_binary' | 'created_by' | 'updated_by' | 'project' | 'workspace'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueExpand.js

@@ -0,0 +1,105 @@
+"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.instanceOfIssueExpand = instanceOfIssueExpand;
+exports.IssueExpandFromJSON = IssueExpandFromJSON;
+exports.IssueExpandFromJSONTyped = IssueExpandFromJSONTyped;
+exports.IssueExpandToJSON = IssueExpandToJSON;
+exports.IssueExpandToJSONTyped = IssueExpandToJSONTyped;
+var PriorityEnum_1 = require("./PriorityEnum");
+var StateLite_1 = require("./StateLite");
+var LabelLite_1 = require("./LabelLite");
+var CycleLite_1 = require("./CycleLite");
+var ModuleLite_1 = require("./ModuleLite");
+var UserLite_1 = require("./UserLite");
+/**
+ * Check if a given object implements the IssueExpand interface.
+ */
+function instanceOfIssueExpand(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function IssueExpandFromJSON(json) {
+    return IssueExpandFromJSONTyped(json, false);
+}
+function IssueExpandFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'cycle': json['cycle'] == null ? undefined : (0, CycleLite_1.CycleLiteFromJSON)(json['cycle']),
+        'module': json['module'] == null ? undefined : (0, ModuleLite_1.ModuleLiteFromJSON)(json['module']),
+        'labels': json['labels'] == null ? undefined : (json['labels'].map(LabelLite_1.LabelLiteFromJSON)),
+        'assignees': json['assignees'] == null ? undefined : (json['assignees'].map(UserLite_1.UserLiteFromJSON)),
+        'state': json['state'] == null ? undefined : (0, StateLite_1.StateLiteFromJSON)(json['state']),
+        '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'])),
+        'point': json['point'] == null ? undefined : json['point'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'descriptionStripped': json['description_stripped'] == null ? undefined : json['description_stripped'],
+        'descriptionBinary': json['description_binary'] == null ? undefined : json['description_binary'],
+        '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'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'workspace': json['workspace'] == null ? undefined : json['workspace'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+        'estimatePoint': json['estimate_point'] == null ? undefined : json['estimate_point'],
+        'type': json['type'] == null ? undefined : json['type'],
+    };
+}
+function IssueExpandToJSON(json) {
+    return IssueExpandToJSONTyped(json, false);
+}
+function IssueExpandToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'point': value['point'],
+        'name': value['name'],
+        'description': value['description'],
+        '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'],
+        'parent': value['parent'],
+        'estimate_point': value['estimatePoint'],
+        'type': value['type'],
+    };
+}

package/dist/models/IssueForIntakeRequest.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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';
+/**
+ * Serializer for work item data within intake submissions.
+ *
+ * Handles essential work item fields for intake processing including
+ * content validation and priority assignment for triage workflows.
+ * @export
+ * @interface IssueForIntakeRequest
+ */
+export interface IssueForIntakeRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueForIntakeRequest
+     */
+    name: string;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueForIntakeRequest
+     */
+    description?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueForIntakeRequest
+     */
+    descriptionHtml?: string;
+    /**
+     *
+     * @type {PriorityEnum}
+     * @memberof IssueForIntakeRequest
+     */
+    priority?: PriorityEnum;
+}
+/**
+ * Check if a given object implements the IssueForIntakeRequest interface.
+ */
+export declare function instanceOfIssueForIntakeRequest(value: object): value is IssueForIntakeRequest;
+export declare function IssueForIntakeRequestFromJSON(json: any): IssueForIntakeRequest;
+export declare function IssueForIntakeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueForIntakeRequest;
+export declare function IssueForIntakeRequestToJSON(json: any): IssueForIntakeRequest;
+export declare function IssueForIntakeRequestToJSONTyped(value?: IssueForIntakeRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueForIntakeRequest.js

@@ -0,0 +1,57 @@
+"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.instanceOfIssueForIntakeRequest = instanceOfIssueForIntakeRequest;
+exports.IssueForIntakeRequestFromJSON = IssueForIntakeRequestFromJSON;
+exports.IssueForIntakeRequestFromJSONTyped = IssueForIntakeRequestFromJSONTyped;
+exports.IssueForIntakeRequestToJSON = IssueForIntakeRequestToJSON;
+exports.IssueForIntakeRequestToJSONTyped = IssueForIntakeRequestToJSONTyped;
+var PriorityEnum_1 = require("./PriorityEnum");
+/**
+ * Check if a given object implements the IssueForIntakeRequest interface.
+ */
+function instanceOfIssueForIntakeRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function IssueForIntakeRequestFromJSON(json) {
+    return IssueForIntakeRequestFromJSONTyped(json, false);
+}
+function IssueForIntakeRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'priority': json['priority'] == null ? undefined : (0, PriorityEnum_1.PriorityEnumFromJSON)(json['priority']),
+    };
+}
+function IssueForIntakeRequestToJSON(json) {
+    return IssueForIntakeRequestToJSONTyped(json, false);
+}
+function IssueForIntakeRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'description_html': value['descriptionHtml'],
+        'priority': (0, PriorityEnum_1.PriorityEnumToJSON)(value['priority']),
+    };
+}

package/dist/models/IssueLink.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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.
+ */
+/**
+ * Full serializer for work item external links.
+ *
+ * Provides complete link information including metadata and timestamps
+ * for managing external resource associations with work items.
+ * @export
+ * @interface IssueLink
+ */
+export interface IssueLink {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    deletedAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    title?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    url: string;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueLink
+     */
+    metadata?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly project?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly workspace?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly issue?: string;
+}
+/**
+ * Check if a given object implements the IssueLink interface.
+ */
+export declare function instanceOfIssueLink(value: object): value is IssueLink;
+export declare function IssueLinkFromJSON(json: any): IssueLink;
+export declare function IssueLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueLink;
+export declare function IssueLinkToJSON(json: any): IssueLink;
+export declare function IssueLinkToJSONTyped(value?: Omit<IssueLink, 'id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by' | 'project' | 'workspace' | 'issue'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueLink.js

@@ -0,0 +1,64 @@
+"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.instanceOfIssueLink = instanceOfIssueLink;
+exports.IssueLinkFromJSON = IssueLinkFromJSON;
+exports.IssueLinkFromJSONTyped = IssueLinkFromJSONTyped;
+exports.IssueLinkToJSON = IssueLinkToJSON;
+exports.IssueLinkToJSONTyped = IssueLinkToJSONTyped;
+/**
+ * Check if a given object implements the IssueLink interface.
+ */
+function instanceOfIssueLink(value) {
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    return true;
+}
+function IssueLinkFromJSON(json) {
+    return IssueLinkFromJSONTyped(json, false);
+}
+function IssueLinkFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        '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'])),
+        'title': json['title'] == null ? undefined : json['title'],
+        'url': json['url'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        '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'],
+        'issue': json['issue'] == null ? undefined : json['issue'],
+    };
+}
+function IssueLinkToJSON(json) {
+    return IssueLinkToJSONTyped(json, false);
+}
+function IssueLinkToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'title': value['title'],
+        'url': value['url'],
+        'metadata': value['metadata'],
+    };
+}