@makeplane/plane-node-sdk 0.1.0

package/src/models/IntakeIssue.ts

@@ -0,0 +1,227 @@
+/* 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';
+import type { IntakeWorkItemStatusEnum } from './IntakeWorkItemStatusEnum';
+import {
+    IntakeWorkItemStatusEnumFromJSON,
+    IntakeWorkItemStatusEnumFromJSONTyped,
+    IntakeWorkItemStatusEnumToJSON,
+    IntakeWorkItemStatusEnumToJSONTyped,
+} from './IntakeWorkItemStatusEnum';
+import type { IssueExpand } from './IssueExpand';
+import {
+    IssueExpandFromJSON,
+    IssueExpandFromJSONTyped,
+    IssueExpandToJSON,
+    IssueExpandToJSONTyped,
+} from './IssueExpand';
+
+/**
+ * Comprehensive serializer for intake work items with expanded issue details.
+ * 
+ * Provides full intake work item data including embedded issue information,
+ * status tracking, and triage metadata for issue queue management.
+ * @export
+ * @interface IntakeIssue
+ */
+export interface IntakeIssue {
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {IssueExpand}
+     * @memberof IntakeIssue
+     */
+    readonly issueDetail?: IssueExpand;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly inbox?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntakeIssue
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntakeIssue
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntakeIssue
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {IntakeWorkItemStatusEnum}
+     * @memberof IntakeIssue
+     */
+    status?: IntakeWorkItemStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntakeIssue
+     */
+    snoozedTill?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    source?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    sourceEmail?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {any}
+     * @memberof IntakeIssue
+     */
+    extra?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly project?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    intake: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    readonly issue?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssue
+     */
+    duplicateTo?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the IntakeIssue interface.
+ */
+export function instanceOfIntakeIssue(value: object): value is IntakeIssue {
+    if (!('intake' in value) || value['intake'] === undefined) return false;
+    return true;
+}
+
+export function IntakeIssueFromJSON(json: any): IntakeIssue {
+    return IntakeIssueFromJSONTyped(json, false);
+}
+
+export function IntakeIssueFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntakeIssue {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'issueDetail': json['issue_detail'] == null ? undefined : IssueExpandFromJSON(json['issue_detail']),
+        'inbox': json['inbox'] == null ? undefined : json['inbox'],
+        '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'])),
+        'status': json['status'] == null ? undefined : IntakeWorkItemStatusEnumFromJSON(json['status']),
+        'snoozedTill': json['snoozed_till'] == null ? undefined : (new Date(json['snoozed_till'])),
+        'source': json['source'] == null ? undefined : json['source'],
+        'sourceEmail': json['source_email'] == null ? undefined : json['source_email'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'extra': json['extra'] == null ? undefined : json['extra'],
+        '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'],
+        'intake': json['intake'],
+        'issue': json['issue'] == null ? undefined : json['issue'],
+        'duplicateTo': json['duplicate_to'] == null ? undefined : json['duplicate_to'],
+    };
+}
+
+export function IntakeIssueToJSON(json: any): IntakeIssue {
+    return IntakeIssueToJSONTyped(json, false);
+}
+
+export function IntakeIssueToJSONTyped(value?: Omit<IntakeIssue, 'id'|'issue_detail'|'inbox'|'created_at'|'updated_at'|'created_by'|'updated_by'|'project'|'workspace'|'issue'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deleted_at': value['deletedAt'] == null ? undefined : ((value['deletedAt'] as any).toISOString()),
+        'status': IntakeWorkItemStatusEnumToJSON(value['status']),
+        'snoozed_till': value['snoozedTill'] == null ? undefined : ((value['snoozedTill'] as any).toISOString()),
+        'source': value['source'],
+        'source_email': value['sourceEmail'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'extra': value['extra'],
+        'intake': value['intake'],
+        'duplicate_to': value['duplicateTo'],
+    };
+}
+

package/src/models/IntakeIssueCreateRequest.ts

@@ -0,0 +1,134 @@
+/* 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';
+import type { IssueForIntakeRequest } from './IssueForIntakeRequest';
+import {
+    IssueForIntakeRequestFromJSON,
+    IssueForIntakeRequestFromJSONTyped,
+    IssueForIntakeRequestToJSON,
+    IssueForIntakeRequestToJSONTyped,
+} from './IssueForIntakeRequest';
+import type { IntakeWorkItemStatusEnum } from './IntakeWorkItemStatusEnum';
+import {
+    IntakeWorkItemStatusEnumFromJSON,
+    IntakeWorkItemStatusEnumFromJSONTyped,
+    IntakeWorkItemStatusEnumToJSON,
+    IntakeWorkItemStatusEnumToJSONTyped,
+} from './IntakeWorkItemStatusEnum';
+
+/**
+ * Serializer for creating intake work items with embedded issue data.
+ * 
+ * Manages intake work item creation including nested issue creation,
+ * status assignment, and source tracking for issue queue management.
+ * @export
+ * @interface IntakeIssueCreateRequest
+ */
+export interface IntakeIssueCreateRequest {
+    /**
+     * Issue data for the intake issue
+     * @type {IssueForIntakeRequest}
+     * @memberof IntakeIssueCreateRequest
+     */
+    issue: IssueForIntakeRequest;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssueCreateRequest
+     */
+    intake: string;
+    /**
+     * 
+     * @type {IntakeWorkItemStatusEnum}
+     * @memberof IntakeIssueCreateRequest
+     */
+    status?: IntakeWorkItemStatusEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IntakeIssueCreateRequest
+     */
+    snoozedTill?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssueCreateRequest
+     */
+    duplicateTo?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssueCreateRequest
+     */
+    source?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IntakeIssueCreateRequest
+     */
+    sourceEmail?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the IntakeIssueCreateRequest interface.
+ */
+export function instanceOfIntakeIssueCreateRequest(value: object): value is IntakeIssueCreateRequest {
+    if (!('issue' in value) || value['issue'] === undefined) return false;
+    if (!('intake' in value) || value['intake'] === undefined) return false;
+    return true;
+}
+
+export function IntakeIssueCreateRequestFromJSON(json: any): IntakeIssueCreateRequest {
+    return IntakeIssueCreateRequestFromJSONTyped(json, false);
+}
+
+export function IntakeIssueCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntakeIssueCreateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'issue': IssueForIntakeRequestFromJSON(json['issue']),
+        'intake': json['intake'],
+        'status': json['status'] == null ? undefined : IntakeWorkItemStatusEnumFromJSON(json['status']),
+        'snoozedTill': json['snoozed_till'] == null ? undefined : (new Date(json['snoozed_till'])),
+        'duplicateTo': json['duplicate_to'] == null ? undefined : json['duplicate_to'],
+        'source': json['source'] == null ? undefined : json['source'],
+        'sourceEmail': json['source_email'] == null ? undefined : json['source_email'],
+    };
+}
+
+export function IntakeIssueCreateRequestToJSON(json: any): IntakeIssueCreateRequest {
+    return IntakeIssueCreateRequestToJSONTyped(json, false);
+}
+
+export function IntakeIssueCreateRequestToJSONTyped(value?: IntakeIssueCreateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'issue': IssueForIntakeRequestToJSON(value['issue']),
+        'intake': value['intake'],
+        'status': IntakeWorkItemStatusEnumToJSON(value['status']),
+        'snoozed_till': value['snoozedTill'] == null ? undefined : ((value['snoozedTill'] as any).toISOString()),
+        'duplicate_to': value['duplicateTo'],
+        'source': value['source'],
+        'source_email': value['sourceEmail'],
+    };
+}
+

package/src/models/IntakeWorkItemStatusEnum.ts

@@ -0,0 +1,59 @@
+/* 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.
+ */
+
+
+/**
+ * * `-2` - Pending
+ * * `-1` - Rejected
+ * * `0` - Snoozed
+ * * `1` - Accepted
+ * * `2` - Duplicate
+ * @export
+ */
+export const IntakeWorkItemStatusEnum = {
+    NUMBER_MINUS_2: -2,
+    NUMBER_MINUS_1: -1,
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+} as const;
+export type IntakeWorkItemStatusEnum = typeof IntakeWorkItemStatusEnum[keyof typeof IntakeWorkItemStatusEnum];
+
+
+export function instanceOfIntakeWorkItemStatusEnum(value: any): boolean {
+    for (const key in IntakeWorkItemStatusEnum) {
+        if (Object.prototype.hasOwnProperty.call(IntakeWorkItemStatusEnum, key)) {
+            if (IntakeWorkItemStatusEnum[key as keyof typeof IntakeWorkItemStatusEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function IntakeWorkItemStatusEnumFromJSON(json: any): IntakeWorkItemStatusEnum {
+    return IntakeWorkItemStatusEnumFromJSONTyped(json, false);
+}
+
+export function IntakeWorkItemStatusEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntakeWorkItemStatusEnum {
+    return json as IntakeWorkItemStatusEnum;
+}
+
+export function IntakeWorkItemStatusEnumToJSON(value?: IntakeWorkItemStatusEnum | null): any {
+    return value as any;
+}
+
+export function IntakeWorkItemStatusEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): IntakeWorkItemStatusEnum {
+    return value as IntakeWorkItemStatusEnum;
+}
+

package/src/models/Issue.ts

@@ -0,0 +1,287 @@
+/* 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';
+import type { PriorityEnum } from './PriorityEnum';
+import {
+    PriorityEnumFromJSON,
+    PriorityEnumFromJSONTyped,
+    PriorityEnumToJSON,
+    PriorityEnumToJSONTyped,
+} 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 Issue
+ */
+export interface Issue {
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    typeId?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Issue
+     */
+    point?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    descriptionHtml?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    descriptionStripped?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    readonly descriptionBinary?: string | null;
+    /**
+     * 
+     * @type {PriorityEnum}
+     * @memberof Issue
+     */
+    priority?: PriorityEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    targetDate?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Issue
+     */
+    sequenceId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Issue
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    completedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Issue
+     */
+    archivedAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Issue
+     */
+    isDraft?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    readonly project?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    estimatePoint?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Issue
+     */
+    type?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the Issue interface.
+ */
+export function instanceOfIssue(value: object): value is Issue {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IssueFromJSON(json: any): Issue {
+    return IssueFromJSONTyped(json, false);
+}
+
+export function IssueFromJSONTyped(json: any, ignoreDiscriminator: boolean): Issue {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'typeId': json['type_id'] == null ? undefined : json['type_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'])),
+        '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'],
+        'descriptionBinary': json['description_binary'] == null ? undefined : json['description_binary'],
+        'priority': json['priority'] == null ? undefined : 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'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'estimatePoint': json['estimate_point'] == null ? undefined : json['estimate_point'],
+        'type': json['type'] == null ? undefined : json['type'],
+    };
+}
+
+export function IssueToJSON(json: any): Issue {
+    return IssueToJSONTyped(json, false);
+}
+
+export function IssueToJSONTyped(value?: Omit<Issue, 'id'|'created_at'|'updated_at'|'description_binary'|'updated_by'|'project'|'workspace'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type_id': value['typeId'],
+        'deleted_at': value['deletedAt'] == null ? undefined : ((value['deletedAt'] as any).toISOString()),
+        'point': value['point'],
+        'name': value['name'],
+        'description_html': value['descriptionHtml'],
+        'description_stripped': value['descriptionStripped'],
+        'priority': PriorityEnumToJSON(value['priority']),
+        'start_date': value['startDate'] == null ? undefined : ((value['startDate'] as any).toISOString().substring(0,10)),
+        'target_date': value['targetDate'] == null ? undefined : ((value['targetDate'] as any).toISOString().substring(0,10)),
+        'sequence_id': value['sequenceId'],
+        'sort_order': value['sortOrder'],
+        'completed_at': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
+        'archived_at': value['archivedAt'] == null ? undefined : ((value['archivedAt'] as any).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'],
+    };
+}
+