@makeplane/plane-node-sdk 0.1.0

package/src/models/IssueActivity.ts

@@ -0,0 +1,202 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for work item activity and change history.
+ * 
+ * Tracks and represents work item modifications, state changes,
+ * and user interactions for audit trails and activity feeds.
+ * @export
+ * @interface IssueActivity
+ */
+export interface IssueActivity {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueActivity
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueActivity
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueActivity
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    verb?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    field?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    oldValue?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    newValue?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    comment?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IssueActivity
+     */
+    attachments?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    oldIdentifier?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    newIdentifier?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueActivity
+     */
+    epoch?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    project: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    workspace: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    issue?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    issueComment?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueActivity
+     */
+    actor?: string | null;
+}
+
+/**
+ * Check if a given object implements the IssueActivity interface.
+ */
+export function instanceOfIssueActivity(value: object): value is IssueActivity {
+    if (!('project' in value) || value['project'] === undefined) return false;
+    if (!('workspace' in value) || value['workspace'] === undefined) return false;
+    return true;
+}
+
+export function IssueActivityFromJSON(json: any): IssueActivity {
+    return IssueActivityFromJSONTyped(json, false);
+}
+
+export function IssueActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueActivity {
+    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'])),
+        'verb': json['verb'] == null ? undefined : json['verb'],
+        'field': json['field'] == null ? undefined : json['field'],
+        'oldValue': json['old_value'] == null ? undefined : json['old_value'],
+        'newValue': json['new_value'] == null ? undefined : json['new_value'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'oldIdentifier': json['old_identifier'] == null ? undefined : json['old_identifier'],
+        'newIdentifier': json['new_identifier'] == null ? undefined : json['new_identifier'],
+        'epoch': json['epoch'] == null ? undefined : json['epoch'],
+        'project': json['project'],
+        'workspace': json['workspace'],
+        'issue': json['issue'] == null ? undefined : json['issue'],
+        'issueComment': json['issue_comment'] == null ? undefined : json['issue_comment'],
+        'actor': json['actor'] == null ? undefined : json['actor'],
+    };
+}
+
+export function IssueActivityToJSON(json: any): IssueActivity {
+    return IssueActivityToJSONTyped(json, false);
+}
+
+export function IssueActivityToJSONTyped(value?: Omit<IssueActivity, 'id'|'created_at'|'updated_at'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deleted_at': value['deletedAt'] == null ? undefined : ((value['deletedAt'] as any).toISOString()),
+        'verb': value['verb'],
+        'field': value['field'],
+        'old_value': value['oldValue'],
+        'new_value': value['newValue'],
+        'comment': value['comment'],
+        'attachments': value['attachments'],
+        'old_identifier': value['oldIdentifier'],
+        'new_identifier': value['newIdentifier'],
+        'epoch': value['epoch'],
+        'project': value['project'],
+        'workspace': value['workspace'],
+        'issue': value['issue'],
+        'issue_comment': value['issueComment'],
+        'actor': value['actor'],
+    };
+}
+

package/src/models/IssueAttachment.ts

@@ -0,0 +1,245 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfIssueAttachment(value: object): value is IssueAttachment {
+    if (!('asset' in value) || value['asset'] === undefined) return false;
+    return true;
+}
+
+export function IssueAttachmentFromJSON(json: any): IssueAttachment {
+    return IssueAttachmentFromJSONTyped(json, false);
+}
+
+export function IssueAttachmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueAttachment {
+    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'],
+    };
+}
+
+export function IssueAttachmentToJSON(json: any): IssueAttachment {
+    return IssueAttachmentToJSONTyped(json, false);
+}
+
+export function IssueAttachmentToJSONTyped(value?: Omit<IssueAttachment, 'id'|'created_at'|'updated_at'|'updated_by'|'workspace'|'project'|'issue'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deleted_at': value['deletedAt'] == null ? undefined : ((value['deletedAt'] as any).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/src/models/IssueAttachmentUploadRequest.ts

@@ -0,0 +1,101 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfIssueAttachmentUploadRequest(value: object): value is IssueAttachmentUploadRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('size' in value) || value['size'] === undefined) return false;
+    return true;
+}
+
+export function IssueAttachmentUploadRequestFromJSON(json: any): IssueAttachmentUploadRequest {
+    return IssueAttachmentUploadRequestFromJSONTyped(json, false);
+}
+
+export function IssueAttachmentUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueAttachmentUploadRequest {
+    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'],
+    };
+}
+
+export function IssueAttachmentUploadRequestToJSON(json: any): IssueAttachmentUploadRequest {
+    return IssueAttachmentUploadRequestToJSONTyped(json, false);
+}
+
+export function IssueAttachmentUploadRequestToJSONTyped(value?: IssueAttachmentUploadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'type': value['type'],
+        'size': value['size'],
+        'external_id': value['externalId'],
+        'external_source': value['externalSource'],
+    };
+}
+