@makeplane/plane-node-sdk 0.1.0

package/dist/models/IssueAttachment.d.ts

@@ -0,0 +1,172 @@
+/**
+ * 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 file attachments.
+ *
+ * Manages file asset associations with work items including metadata,
+ * storage information, and access control for document management.
+ * @export
+ * @interface IssueAttachment
+ */
+export interface IssueAttachment {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueAttachment
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueAttachment
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueAttachment
+     */
+    deletedAt?: Date | null;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueAttachment
+     */
+    attributes?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    asset: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    entityType?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    entityIdentifier?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueAttachment
+     */
+    isDeleted?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueAttachment
+     */
+    isArchived?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof IssueAttachment
+     */
+    size?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueAttachment
+     */
+    isUploaded?: boolean;
+    /**
+     *
+     * @type {any}
+     * @memberof IssueAttachment
+     */
+    storageMetadata?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    user?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    readonly workspace?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    draftIssue?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    readonly project?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    readonly issue?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    comment?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueAttachment
+     */
+    page?: string | null;
+}
+/**
+ * Check if a given object implements the IssueAttachment interface.
+ */
+export declare function instanceOfIssueAttachment(value: object): value is IssueAttachment;
+export declare function IssueAttachmentFromJSON(json: any): IssueAttachment;
+export declare function IssueAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueAttachment;
+export declare function IssueAttachmentToJSON(json: any): IssueAttachment;
+export declare function IssueAttachmentToJSONTyped(value?: Omit<IssueAttachment, 'id' | 'created_at' | 'updated_at' | 'updated_by' | 'workspace' | 'project' | 'issue'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueAttachment.js

@@ -0,0 +1,89 @@
+"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.instanceOfIssueAttachment = instanceOfIssueAttachment;
+exports.IssueAttachmentFromJSON = IssueAttachmentFromJSON;
+exports.IssueAttachmentFromJSONTyped = IssueAttachmentFromJSONTyped;
+exports.IssueAttachmentToJSON = IssueAttachmentToJSON;
+exports.IssueAttachmentToJSONTyped = IssueAttachmentToJSONTyped;
+/**
+ * Check if a given object implements the IssueAttachment interface.
+ */
+function instanceOfIssueAttachment(value) {
+    if (!('asset' in value) || value['asset'] === undefined)
+        return false;
+    return true;
+}
+function IssueAttachmentFromJSON(json) {
+    return IssueAttachmentFromJSONTyped(json, false);
+}
+function IssueAttachmentFromJSONTyped(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'])),
+        'attributes': json['attributes'] == null ? undefined : json['attributes'],
+        'asset': json['asset'],
+        'entityType': json['entity_type'] == null ? undefined : json['entity_type'],
+        'entityIdentifier': json['entity_identifier'] == null ? undefined : json['entity_identifier'],
+        'isDeleted': json['is_deleted'] == null ? undefined : json['is_deleted'],
+        'isArchived': json['is_archived'] == null ? undefined : json['is_archived'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'size': json['size'] == null ? undefined : json['size'],
+        'isUploaded': json['is_uploaded'] == null ? undefined : json['is_uploaded'],
+        'storageMetadata': json['storage_metadata'] == null ? undefined : json['storage_metadata'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+        'user': json['user'] == null ? undefined : json['user'],
+        'workspace': json['workspace'] == null ? undefined : json['workspace'],
+        'draftIssue': json['draft_issue'] == null ? undefined : json['draft_issue'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'issue': json['issue'] == null ? undefined : json['issue'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'page': json['page'] == null ? undefined : json['page'],
+    };
+}
+function IssueAttachmentToJSON(json) {
+    return IssueAttachmentToJSONTyped(json, false);
+}
+function IssueAttachmentToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'attributes': value['attributes'],
+        'asset': value['asset'],
+        'entity_type': value['entityType'],
+        'entity_identifier': value['entityIdentifier'],
+        'is_deleted': value['isDeleted'],
+        'is_archived': value['isArchived'],
+        'external_id': value['externalId'],
+        'external_source': value['externalSource'],
+        'size': value['size'],
+        'is_uploaded': value['isUploaded'],
+        'storage_metadata': value['storageMetadata'],
+        'created_by': value['createdBy'],
+        'user': value['user'],
+        'draft_issue': value['draftIssue'],
+        'comment': value['comment'],
+        'page': value['page'],
+    };
+}

package/dist/models/IssueAttachmentUploadRequest.d.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 attachment upload request validation.
+ *
+ * Handles file upload metadata validation including size, type, and external
+ * integration tracking for secure work item document attachment workflows.
+ * @export
+ * @interface IssueAttachmentUploadRequest
+ */
+export interface IssueAttachmentUploadRequest {
+    /**
+     * Original filename of the asset
+     * @type {string}
+     * @memberof IssueAttachmentUploadRequest
+     */
+    name: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof IssueAttachmentUploadRequest
+     */
+    type?: string;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof IssueAttachmentUploadRequest
+     */
+    size: number;
+    /**
+     * External identifier for the asset (for integration tracking)
+     * @type {string}
+     * @memberof IssueAttachmentUploadRequest
+     */
+    externalId?: string;
+    /**
+     * External source system (for integration tracking)
+     * @type {string}
+     * @memberof IssueAttachmentUploadRequest
+     */
+    externalSource?: string;
+}
+/**
+ * Check if a given object implements the IssueAttachmentUploadRequest interface.
+ */
+export declare function instanceOfIssueAttachmentUploadRequest(value: object): value is IssueAttachmentUploadRequest;
+export declare function IssueAttachmentUploadRequestFromJSON(json: any): IssueAttachmentUploadRequest;
+export declare function IssueAttachmentUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueAttachmentUploadRequest;
+export declare function IssueAttachmentUploadRequestToJSON(json: any): IssueAttachmentUploadRequest;
+export declare function IssueAttachmentUploadRequestToJSONTyped(value?: IssueAttachmentUploadRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueAttachmentUploadRequest.js

@@ -0,0 +1,60 @@
+"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.instanceOfIssueAttachmentUploadRequest = instanceOfIssueAttachmentUploadRequest;
+exports.IssueAttachmentUploadRequestFromJSON = IssueAttachmentUploadRequestFromJSON;
+exports.IssueAttachmentUploadRequestFromJSONTyped = IssueAttachmentUploadRequestFromJSONTyped;
+exports.IssueAttachmentUploadRequestToJSON = IssueAttachmentUploadRequestToJSON;
+exports.IssueAttachmentUploadRequestToJSONTyped = IssueAttachmentUploadRequestToJSONTyped;
+/**
+ * Check if a given object implements the IssueAttachmentUploadRequest interface.
+ */
+function instanceOfIssueAttachmentUploadRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+function IssueAttachmentUploadRequestFromJSON(json) {
+    return IssueAttachmentUploadRequestFromJSONTyped(json, false);
+}
+function IssueAttachmentUploadRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'size': json['size'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+    };
+}
+function IssueAttachmentUploadRequestToJSON(json) {
+    return IssueAttachmentUploadRequestToJSONTyped(json, false);
+}
+function IssueAttachmentUploadRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'type': value['type'],
+        'size': value['size'],
+        'external_id': value['externalId'],
+        'external_source': value['externalSource'],
+    };
+}

package/dist/models/IssueComment.d.ts

@@ -0,0 +1,137 @@
+/**
+ * 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 { AccessEnum } from './AccessEnum';
+/**
+ * Full serializer for work item comments with membership context.
+ *
+ * Provides complete comment data including member status, content formatting,
+ * and edit tracking for collaborative work item discussions.
+ * @export
+ * @interface IssueComment
+ */
+export interface IssueComment {
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof IssueComment
+     */
+    readonly isMember?: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueComment
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueComment
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueComment
+     */
+    deletedAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    commentStripped?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    commentHtml?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof IssueComment
+     */
+    attachments?: Array<string>;
+    /**
+     *
+     * @type {AccessEnum}
+     * @memberof IssueComment
+     */
+    access?: AccessEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof IssueComment
+     */
+    editedAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly project?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly workspace?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    readonly issue?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueComment
+     */
+    actor?: string | null;
+}
+/**
+ * Check if a given object implements the IssueComment interface.
+ */
+export declare function instanceOfIssueComment(value: object): value is IssueComment;
+export declare function IssueCommentFromJSON(json: any): IssueComment;
+export declare function IssueCommentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueComment;
+export declare function IssueCommentToJSON(json: any): IssueComment;
+export declare function IssueCommentToJSONTyped(value?: Omit<IssueComment, 'id' | 'is_member' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by' | 'project' | 'workspace' | 'issue'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/IssueComment.js

@@ -0,0 +1,74 @@
+"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.instanceOfIssueComment = instanceOfIssueComment;
+exports.IssueCommentFromJSON = IssueCommentFromJSON;
+exports.IssueCommentFromJSONTyped = IssueCommentFromJSONTyped;
+exports.IssueCommentToJSON = IssueCommentToJSON;
+exports.IssueCommentToJSONTyped = IssueCommentToJSONTyped;
+var AccessEnum_1 = require("./AccessEnum");
+/**
+ * Check if a given object implements the IssueComment interface.
+ */
+function instanceOfIssueComment(value) {
+    return true;
+}
+function IssueCommentFromJSON(json) {
+    return IssueCommentFromJSONTyped(json, false);
+}
+function IssueCommentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'isMember': json['is_member'] == null ? undefined : json['is_member'],
+        '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'])),
+        'commentStripped': json['comment_stripped'] == null ? undefined : json['comment_stripped'],
+        'commentHtml': json['comment_html'] == null ? undefined : json['comment_html'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        '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'],
+        'editedAt': json['edited_at'] == null ? undefined : (new Date(json['edited_at'])),
+        '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'],
+        'actor': json['actor'] == null ? undefined : json['actor'],
+    };
+}
+function IssueCommentToJSON(json) {
+    return IssueCommentToJSONTyped(json, false);
+}
+function IssueCommentToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'comment_stripped': value['commentStripped'],
+        'comment_html': value['commentHtml'],
+        'attachments': value['attachments'],
+        'access': (0, AccessEnum_1.AccessEnumToJSON)(value['access']),
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'edited_at': value['editedAt'] == null ? undefined : (value['editedAt'].toISOString()),
+        'actor': value['actor'],
+    };
+}

package/dist/models/IssueCommentCreateRequest.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { AccessEnum } from './AccessEnum';
+/**
+ * Serializer for creating work item comments.
+ *
+ * Handles comment creation with JSON and HTML content support,
+ * access control, and external integration tracking.
+ * @export
+ * @interface IssueCommentCreateRequest
+ */
+export interface IssueCommentCreateRequest {
+    /**
+     *
+     * @type {any}
+     * @memberof IssueCommentCreateRequest
+     */
+    commentJson?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueCommentCreateRequest
+     */
+    commentHtml?: string;
+    /**
+     *
+     * @type {AccessEnum}
+     * @memberof IssueCommentCreateRequest
+     */
+    access?: AccessEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueCommentCreateRequest
+     */
+    externalSource?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof IssueCommentCreateRequest
+     */
+    externalId?: string | null;
+}
+/**
+ * Check if a given object implements the IssueCommentCreateRequest interface.
+ */
+export declare function instanceOfIssueCommentCreateRequest(value: object): value is IssueCommentCreateRequest;
+export declare function IssueCommentCreateRequestFromJSON(json: any): IssueCommentCreateRequest;
+export declare function IssueCommentCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueCommentCreateRequest;
+export declare function IssueCommentCreateRequestToJSON(json: any): IssueCommentCreateRequest;
+export declare function IssueCommentCreateRequestToJSONTyped(value?: IssueCommentCreateRequest | null, ignoreDiscriminator?: boolean): any;