@makeplane/plane-node-sdk 0.1.0

package/src/models/IssuePropertyValueAPIRequest.ts

@@ -0,0 +1,138 @@
+/* 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 IssuePropertyValueAPIRequest
+ */
+export interface IssuePropertyValueAPIRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueText?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueBoolean?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueDecimal?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueDatetime?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueUuid?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    issue: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    property: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyValueAPIRequest
+     */
+    valueOption?: string | null;
+}
+
+/**
+ * Check if a given object implements the IssuePropertyValueAPIRequest interface.
+ */
+export function instanceOfIssuePropertyValueAPIRequest(value: object): value is IssuePropertyValueAPIRequest {
+    if (!('issue' in value) || value['issue'] === undefined) return false;
+    if (!('property' in value) || value['property'] === undefined) return false;
+    return true;
+}
+
+export function IssuePropertyValueAPIRequestFromJSON(json: any): IssuePropertyValueAPIRequest {
+    return IssuePropertyValueAPIRequestFromJSONTyped(json, false);
+}
+
+export function IssuePropertyValueAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssuePropertyValueAPIRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'valueText': json['value_text'] == null ? undefined : json['value_text'],
+        'valueBoolean': json['value_boolean'] == null ? undefined : json['value_boolean'],
+        'valueDecimal': json['value_decimal'] == null ? undefined : json['value_decimal'],
+        'valueDatetime': json['value_datetime'] == null ? undefined : (new Date(json['value_datetime'])),
+        'valueUuid': json['value_uuid'] == null ? undefined : json['value_uuid'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'issue': json['issue'],
+        'property': json['property'],
+        'valueOption': json['value_option'] == null ? undefined : json['value_option'],
+    };
+}
+
+export function IssuePropertyValueAPIRequestToJSON(json: any): IssuePropertyValueAPIRequest {
+    return IssuePropertyValueAPIRequestToJSONTyped(json, false);
+}
+
+export function IssuePropertyValueAPIRequestToJSONTyped(value?: IssuePropertyValueAPIRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'value_text': value['valueText'],
+        'value_boolean': value['valueBoolean'],
+        'value_decimal': value['valueDecimal'],
+        'value_datetime': value['valueDatetime'] == null ? undefined : ((value['valueDatetime'] as any).toISOString()),
+        'value_uuid': value['valueUuid'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'issue': value['issue'],
+        'property': value['property'],
+        'value_option': value['valueOption'],
+    };
+}
+

package/src/models/IssueRequest.ts

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

@@ -0,0 +1,113 @@
+/* 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 search result data formatting.
+ * 
+ * Provides standardized search result structure including work item identifiers,
+ * project context, and workspace information for search API responses.
+ * @export
+ * @interface IssueSearch
+ */
+export interface IssueSearch {
+    /**
+     * Issue ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    id: string;
+    /**
+     * Issue name
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    name: string;
+    /**
+     * Issue sequence ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    sequenceId: string;
+    /**
+     * Project identifier
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    projectIdentifier: string;
+    /**
+     * Project ID
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    projectId: string;
+    /**
+     * Workspace slug
+     * @type {string}
+     * @memberof IssueSearch
+     */
+    workspaceSlug: string;
+}
+
+/**
+ * Check if a given object implements the IssueSearch interface.
+ */
+export function instanceOfIssueSearch(value: object): value is IssueSearch {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('sequenceId' in value) || value['sequenceId'] === undefined) return false;
+    if (!('projectIdentifier' in value) || value['projectIdentifier'] === undefined) return false;
+    if (!('projectId' in value) || value['projectId'] === undefined) return false;
+    if (!('workspaceSlug' in value) || value['workspaceSlug'] === undefined) return false;
+    return true;
+}
+
+export function IssueSearchFromJSON(json: any): IssueSearch {
+    return IssueSearchFromJSONTyped(json, false);
+}
+
+export function IssueSearchFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueSearch {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'sequenceId': json['sequence_id'],
+        'projectIdentifier': json['project__identifier'],
+        'projectId': json['project_id'],
+        'workspaceSlug': json['workspace__slug'],
+    };
+}
+
+export function IssueSearchToJSON(json: any): IssueSearch {
+    return IssueSearchToJSONTyped(json, false);
+}
+
+export function IssueSearchToJSONTyped(value?: IssueSearch | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'sequence_id': value['sequenceId'],
+        'project__identifier': value['projectIdentifier'],
+        'project_id': value['projectId'],
+        'workspace__slug': value['workspaceSlug'],
+    };
+}
+

package/src/models/IssueTypeAPI.ts

@@ -0,0 +1,183 @@
+/* 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 IssueTypeAPI
+ */
+export interface IssueTypeAPI {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IssueTypeAPI
+     */
+    projectIds?: Array<string>;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueTypeAPI
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    description?: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssueTypeAPI
+     */
+    readonly logoProps?: any | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    isEpic?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    readonly isDefault?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueTypeAPI
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueTypeAPI
+     */
+    readonly level?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPI
+     */
+    readonly workspace?: string;
+}
+
+/**
+ * Check if a given object implements the IssueTypeAPI interface.
+ */
+export function instanceOfIssueTypeAPI(value: object): value is IssueTypeAPI {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IssueTypeAPIFromJSON(json: any): IssueTypeAPI {
+    return IssueTypeAPIFromJSONTyped(json, false);
+}
+
+export function IssueTypeAPIFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueTypeAPI {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
+        'projectIds': json['project_ids'] == null ? undefined : json['project_ids'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
+        'isEpic': json['is_epic'] == null ? undefined : json['is_epic'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'level': json['level'] == null ? undefined : json['level'],
+        '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'],
+        'workspace': json['workspace'] == null ? undefined : json['workspace'],
+    };
+}
+
+export function IssueTypeAPIToJSON(json: any): IssueTypeAPI {
+    return IssueTypeAPIToJSONTyped(json, false);
+}
+
+export function IssueTypeAPIToJSONTyped(value?: Omit<IssueTypeAPI, 'id'|'deleted_at'|'created_at'|'updated_at'|'logo_props'|'is_default'|'level'|'created_by'|'updated_by'|'workspace'> | 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'],
+    };
+}
+