@makeplane/plane-node-sdk 0.1.0

package/src/models/IssueForIntakeRequest.ts

@@ -0,0 +1,102 @@
+/* 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';
+
+/**
+ * Serializer for work item data within intake submissions.
+ * 
+ * Handles essential work item fields for intake processing including
+ * content validation and priority assignment for triage workflows.
+ * @export
+ * @interface IssueForIntakeRequest
+ */
+export interface IssueForIntakeRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueForIntakeRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssueForIntakeRequest
+     */
+    description?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueForIntakeRequest
+     */
+    descriptionHtml?: string;
+    /**
+     * 
+     * @type {PriorityEnum}
+     * @memberof IssueForIntakeRequest
+     */
+    priority?: PriorityEnum;
+}
+
+
+
+/**
+ * Check if a given object implements the IssueForIntakeRequest interface.
+ */
+export function instanceOfIssueForIntakeRequest(value: object): value is IssueForIntakeRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IssueForIntakeRequestFromJSON(json: any): IssueForIntakeRequest {
+    return IssueForIntakeRequestFromJSONTyped(json, false);
+}
+
+export function IssueForIntakeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueForIntakeRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'descriptionHtml': json['description_html'] == null ? undefined : json['description_html'],
+        'priority': json['priority'] == null ? undefined : PriorityEnumFromJSON(json['priority']),
+    };
+}
+
+export function IssueForIntakeRequestToJSON(json: any): IssueForIntakeRequest {
+    return IssueForIntakeRequestToJSONTyped(json, false);
+}
+
+export function IssueForIntakeRequestToJSONTyped(value?: IssueForIntakeRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'description_html': value['descriptionHtml'],
+        'priority': PriorityEnumToJSON(value['priority']),
+    };
+}
+

package/src/models/IssueLink.ts

@@ -0,0 +1,148 @@
+/* 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';
+/**
+ * Full serializer for work item external links.
+ * 
+ * Provides complete link information including metadata and timestamps
+ * for managing external resource associations with work items.
+ * @export
+ * @interface IssueLink
+ */
+export interface IssueLink {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueLink
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    title?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    url: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssueLink
+     */
+    metadata?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly project?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLink
+     */
+    readonly issue?: string;
+}
+
+/**
+ * Check if a given object implements the IssueLink interface.
+ */
+export function instanceOfIssueLink(value: object): value is IssueLink {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function IssueLinkFromJSON(json: any): IssueLink {
+    return IssueLinkFromJSONTyped(json, false);
+}
+
+export function IssueLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueLink {
+    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'])),
+        'title': json['title'] == null ? undefined : json['title'],
+        'url': json['url'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        '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'],
+    };
+}
+
+export function IssueLinkToJSON(json: any): IssueLink {
+    return IssueLinkToJSONTyped(json, false);
+}
+
+export function IssueLinkToJSONTyped(value?: Omit<IssueLink, 'id'|'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()),
+        'title': value['title'],
+        'url': value['url'],
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/IssueLinkCreateRequest.ts

@@ -0,0 +1,68 @@
+/* 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 work item external links with validation.
+ * 
+ * Handles URL validation, format checking, and duplicate prevention
+ * for attaching external resources to work items.
+ * @export
+ * @interface IssueLinkCreateRequest
+ */
+export interface IssueLinkCreateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueLinkCreateRequest
+     */
+    url: string;
+}
+
+/**
+ * Check if a given object implements the IssueLinkCreateRequest interface.
+ */
+export function instanceOfIssueLinkCreateRequest(value: object): value is IssueLinkCreateRequest {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function IssueLinkCreateRequestFromJSON(json: any): IssueLinkCreateRequest {
+    return IssueLinkCreateRequestFromJSONTyped(json, false);
+}
+
+export function IssueLinkCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueLinkCreateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+    };
+}
+
+export function IssueLinkCreateRequestToJSON(json: any): IssueLinkCreateRequest {
+    return IssueLinkCreateRequestToJSONTyped(json, false);
+}
+
+export function IssueLinkCreateRequestToJSONTyped(value?: IssueLinkCreateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+    };
+}
+

package/src/models/IssuePropertyAPI.ts

@@ -0,0 +1,255 @@
+/* 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 { RelationTypeEnum } from './RelationTypeEnum';
+import {
+    RelationTypeEnumFromJSON,
+    RelationTypeEnumFromJSONTyped,
+    RelationTypeEnumToJSON,
+    RelationTypeEnumToJSONTyped,
+} from './RelationTypeEnum';
+import type { PropertyTypeEnum } from './PropertyTypeEnum';
+import {
+    PropertyTypeEnumFromJSON,
+    PropertyTypeEnumFromJSONTyped,
+    PropertyTypeEnumToJSON,
+    PropertyTypeEnumToJSONTyped,
+} from './PropertyTypeEnum';
+
+/**
+ * 
+ * @export
+ * @interface IssuePropertyAPI
+ */
+export interface IssuePropertyAPI {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssuePropertyAPI
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     * 
+     * @type {RelationTypeEnum}
+     * @memberof IssuePropertyAPI
+     */
+    relationType?: RelationTypeEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssuePropertyAPI
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssuePropertyAPI
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    displayName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssuePropertyAPI
+     */
+    readonly logoProps?: any | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssuePropertyAPI
+     */
+    readonly sortOrder?: number;
+    /**
+     * 
+     * @type {PropertyTypeEnum}
+     * @memberof IssuePropertyAPI
+     */
+    propertyType: PropertyTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssuePropertyAPI
+     */
+    isRequired?: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IssuePropertyAPI
+     */
+    defaultValue?: Array<string>;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssuePropertyAPI
+     */
+    settings?: any | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssuePropertyAPI
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssuePropertyAPI
+     */
+    isMulti?: boolean;
+    /**
+     * 
+     * @type {any}
+     * @memberof IssuePropertyAPI
+     */
+    validationRules?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly project?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssuePropertyAPI
+     */
+    readonly issueType?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the IssuePropertyAPI interface.
+ */
+export function instanceOfIssuePropertyAPI(value: object): value is IssuePropertyAPI {
+    if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('propertyType' in value) || value['propertyType'] === undefined) return false;
+    return true;
+}
+
+export function IssuePropertyAPIFromJSON(json: any): IssuePropertyAPI {
+    return IssuePropertyAPIFromJSONTyped(json, false);
+}
+
+export function IssuePropertyAPIFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssuePropertyAPI {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'deletedAt': json['deleted_at'] == null ? undefined : (new Date(json['deleted_at'])),
+        'relationType': json['relation_type'] == null ? undefined : RelationTypeEnumFromJSON(json['relation_type']),
+        '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'] == null ? undefined : json['name'],
+        'displayName': json['display_name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        'propertyType': PropertyTypeEnumFromJSON(json['property_type']),
+        'isRequired': json['is_required'] == null ? undefined : json['is_required'],
+        'defaultValue': json['default_value'] == null ? undefined : json['default_value'],
+        'settings': json['settings'] == null ? undefined : json['settings'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'isMulti': json['is_multi'] == null ? undefined : json['is_multi'],
+        'validationRules': json['validation_rules'] == null ? undefined : json['validation_rules'],
+        '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'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'issueType': json['issue_type'] == null ? undefined : json['issue_type'],
+    };
+}
+
+export function IssuePropertyAPIToJSON(json: any): IssuePropertyAPI {
+    return IssuePropertyAPIToJSONTyped(json, false);
+}
+
+export function IssuePropertyAPIToJSONTyped(value?: Omit<IssuePropertyAPI, 'id'|'deleted_at'|'created_at'|'updated_at'|'name'|'logo_props'|'sort_order'|'created_by'|'updated_by'|'workspace'|'project'|'issue_type'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'relation_type': RelationTypeEnumToJSON(value['relationType']),
+        'display_name': value['displayName'],
+        'description': value['description'],
+        'property_type': PropertyTypeEnumToJSON(value['propertyType']),
+        'is_required': value['isRequired'],
+        'default_value': value['defaultValue'],
+        'settings': value['settings'],
+        'is_active': value['isActive'],
+        'is_multi': value['isMulti'],
+        'validation_rules': value['validationRules'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+    };
+}
+