@makeplane/plane-node-sdk 0.1.0

package/src/models/PatchedIssuePropertyOptionAPIRequest.ts

@@ -0,0 +1,112 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PatchedIssuePropertyOptionAPIRequest
+ */
+export interface PatchedIssuePropertyOptionAPIRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssuePropertyOptionAPIRequest
+     */
+    parent?: string | null;
+}
+
+/**
+ * Check if a given object implements the PatchedIssuePropertyOptionAPIRequest interface.
+ */
+export function instanceOfPatchedIssuePropertyOptionAPIRequest(value: object): value is PatchedIssuePropertyOptionAPIRequest {
+    return true;
+}
+
+export function PatchedIssuePropertyOptionAPIRequestFromJSON(json: any): PatchedIssuePropertyOptionAPIRequest {
+    return PatchedIssuePropertyOptionAPIRequestFromJSONTyped(json, false);
+}
+
+export function PatchedIssuePropertyOptionAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedIssuePropertyOptionAPIRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+    };
+}
+
+export function PatchedIssuePropertyOptionAPIRequestToJSON(json: any): PatchedIssuePropertyOptionAPIRequest {
+    return PatchedIssuePropertyOptionAPIRequestToJSONTyped(json, false);
+}
+
+export function PatchedIssuePropertyOptionAPIRequestToJSONTyped(value?: PatchedIssuePropertyOptionAPIRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'is_active': value['isActive'],
+        'is_default': value['isDefault'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'parent': value['parent'],
+    };
+}
+

package/src/models/PatchedIssueRequest.ts

@@ -0,0 +1,253 @@
+/* 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 PatchedIssueRequest
+ */
+export interface PatchedIssueRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PatchedIssueRequest
+     */
+    assignees?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PatchedIssueRequest
+     */
+    labels?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    typeId?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedIssueRequest
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedIssueRequest
+     */
+    point?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    descriptionHtml?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    descriptionStripped?: string | null;
+    /**
+     * 
+     * @type {PriorityEnum}
+     * @memberof PatchedIssueRequest
+     */
+    priority?: PriorityEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedIssueRequest
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedIssueRequest
+     */
+    targetDate?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedIssueRequest
+     */
+    sequenceId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedIssueRequest
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedIssueRequest
+     */
+    completedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedIssueRequest
+     */
+    archivedAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedIssueRequest
+     */
+    isDraft?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    estimatePoint?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueRequest
+     */
+    type?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the PatchedIssueRequest interface.
+ */
+export function instanceOfPatchedIssueRequest(value: object): value is PatchedIssueRequest {
+    return true;
+}
+
+export function PatchedIssueRequestFromJSON(json: any): PatchedIssueRequest {
+    return PatchedIssueRequestFromJSONTyped(json, false);
+}
+
+export function PatchedIssueRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedIssueRequest {
+    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'] == null ? undefined : 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 : 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'],
+    };
+}
+
+export function PatchedIssueRequestToJSON(json: any): PatchedIssueRequest {
+    return PatchedIssueRequestToJSONTyped(json, false);
+}
+
+export function PatchedIssueRequestToJSONTyped(value?: PatchedIssueRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'assignees': value['assignees'],
+        'labels': value['labels'],
+        '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'],
+    };
+}
+

package/src/models/PatchedIssueTypeAPIRequest.ts

@@ -0,0 +1,112 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PatchedIssueTypeAPIRequest
+ */
+export interface PatchedIssueTypeAPIRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    projectIds?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    isEpic?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueTypeAPIRequest
+     */
+    externalId?: string | null;
+}
+
+/**
+ * Check if a given object implements the PatchedIssueTypeAPIRequest interface.
+ */
+export function instanceOfPatchedIssueTypeAPIRequest(value: object): value is PatchedIssueTypeAPIRequest {
+    return true;
+}
+
+export function PatchedIssueTypeAPIRequestFromJSON(json: any): PatchedIssueTypeAPIRequest {
+    return PatchedIssueTypeAPIRequestFromJSONTyped(json, false);
+}
+
+export function PatchedIssueTypeAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedIssueTypeAPIRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectIds': json['project_ids'] == null ? undefined : json['project_ids'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isEpic': json['is_epic'] == null ? undefined : json['is_epic'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+
+export function PatchedIssueTypeAPIRequestToJSON(json: any): PatchedIssueTypeAPIRequest {
+    return PatchedIssueTypeAPIRequestToJSONTyped(json, false);
+}
+
+export function PatchedIssueTypeAPIRequestToJSONTyped(value?: PatchedIssueTypeAPIRequest | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PatchedIssueWorkLogAPIRequest.ts

@@ -0,0 +1,88 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PatchedIssueWorkLogAPIRequest
+ */
+export interface PatchedIssueWorkLogAPIRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueWorkLogAPIRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedIssueWorkLogAPIRequest
+     */
+    duration?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueWorkLogAPIRequest
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedIssueWorkLogAPIRequest
+     */
+    updatedBy?: string | null;
+}
+
+/**
+ * Check if a given object implements the PatchedIssueWorkLogAPIRequest interface.
+ */
+export function instanceOfPatchedIssueWorkLogAPIRequest(value: object): value is PatchedIssueWorkLogAPIRequest {
+    return true;
+}
+
+export function PatchedIssueWorkLogAPIRequestFromJSON(json: any): PatchedIssueWorkLogAPIRequest {
+    return PatchedIssueWorkLogAPIRequestFromJSONTyped(json, false);
+}
+
+export function PatchedIssueWorkLogAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedIssueWorkLogAPIRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'duration': json['duration'] == null ? undefined : json['duration'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+    };
+}
+
+export function PatchedIssueWorkLogAPIRequestToJSON(json: any): PatchedIssueWorkLogAPIRequest {
+    return PatchedIssueWorkLogAPIRequestToJSONTyped(json, false);
+}
+
+export function PatchedIssueWorkLogAPIRequestToJSONTyped(value?: PatchedIssueWorkLogAPIRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'duration': value['duration'],
+        'created_by': value['createdBy'],
+        'updated_by': value['updatedBy'],
+    };
+}
+

package/src/models/PatchedLabelCreateUpdateRequest.ts

@@ -0,0 +1,115 @@
+/* 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 creating and updating work item labels.
+ * 
+ * Manages label metadata including colors, descriptions, hierarchy,
+ * and sorting for work item categorization and filtering.
+ * @export
+ * @interface PatchedLabelCreateUpdateRequest
+ */
+export interface PatchedLabelCreateUpdateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    color?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedLabelCreateUpdateRequest
+     */
+    sortOrder?: number;
+}
+
+/**
+ * Check if a given object implements the PatchedLabelCreateUpdateRequest interface.
+ */
+export function instanceOfPatchedLabelCreateUpdateRequest(value: object): value is PatchedLabelCreateUpdateRequest {
+    return true;
+}
+
+export function PatchedLabelCreateUpdateRequestFromJSON(json: any): PatchedLabelCreateUpdateRequest {
+    return PatchedLabelCreateUpdateRequestFromJSONTyped(json, false);
+}
+
+export function PatchedLabelCreateUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedLabelCreateUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'color': json['color'] == null ? undefined : json['color'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+    };
+}
+
+export function PatchedLabelCreateUpdateRequestToJSON(json: any): PatchedLabelCreateUpdateRequest {
+    return PatchedLabelCreateUpdateRequestToJSONTyped(json, false);
+}
+
+export function PatchedLabelCreateUpdateRequestToJSONTyped(value?: PatchedLabelCreateUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'color': value['color'],
+        'description': value['description'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'parent': value['parent'],
+        'sort_order': value['sortOrder'],
+    };
+}
+