@makeplane/plane-node-sdk 0.1.0

package/src/models/IssueTypeAPIRequest.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';
+/**
+ * 
+ * @export
+ * @interface IssueTypeAPIRequest
+ */
+export interface IssueTypeAPIRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IssueTypeAPIRequest
+     */
+    projectIds?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueTypeAPIRequest
+     */
+    isEpic?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueTypeAPIRequest
+     */
+    isActive?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueTypeAPIRequest
+     */
+    externalId?: string | null;
+}
+
+/**
+ * Check if a given object implements the IssueTypeAPIRequest interface.
+ */
+export function instanceOfIssueTypeAPIRequest(value: object): value is IssueTypeAPIRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IssueTypeAPIRequestFromJSON(json: any): IssueTypeAPIRequest {
+    return IssueTypeAPIRequestFromJSONTyped(json, false);
+}
+
+export function IssueTypeAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueTypeAPIRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'projectIds': json['project_ids'] == null ? undefined : json['project_ids'],
+        'name': 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 IssueTypeAPIRequestToJSON(json: any): IssueTypeAPIRequest {
+    return IssueTypeAPIRequestToJSONTyped(json, false);
+}
+
+export function IssueTypeAPIRequestToJSONTyped(value?: IssueTypeAPIRequest | 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/IssueWorkLogAPI.ts

@@ -0,0 +1,130 @@
+/* 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 IssueWorkLogAPI
+ */
+export interface IssueWorkLogAPI {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    description?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueWorkLogAPI
+     */
+    duration?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly projectId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly workspaceId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPI
+     */
+    readonly loggedBy?: string;
+}
+
+/**
+ * Check if a given object implements the IssueWorkLogAPI interface.
+ */
+export function instanceOfIssueWorkLogAPI(value: object): value is IssueWorkLogAPI {
+    return true;
+}
+
+export function IssueWorkLogAPIFromJSON(json: any): IssueWorkLogAPI {
+    return IssueWorkLogAPIFromJSONTyped(json, false);
+}
+
+export function IssueWorkLogAPIFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueWorkLogAPI {
+    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'])),
+        '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'],
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'workspaceId': json['workspace_id'] == null ? undefined : json['workspace_id'],
+        'loggedBy': json['logged_by'] == null ? undefined : json['logged_by'],
+    };
+}
+
+export function IssueWorkLogAPIToJSON(json: any): IssueWorkLogAPI {
+    return IssueWorkLogAPIToJSONTyped(json, false);
+}
+
+export function IssueWorkLogAPIToJSONTyped(value?: Omit<IssueWorkLogAPI, 'id'|'created_at'|'updated_at'|'project_id'|'workspace_id'|'logged_by'> | 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/IssueWorkLogAPIRequest.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 IssueWorkLogAPIRequest
+ */
+export interface IssueWorkLogAPIRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPIRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueWorkLogAPIRequest
+     */
+    duration?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPIRequest
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueWorkLogAPIRequest
+     */
+    updatedBy?: string | null;
+}
+
+/**
+ * Check if a given object implements the IssueWorkLogAPIRequest interface.
+ */
+export function instanceOfIssueWorkLogAPIRequest(value: object): value is IssueWorkLogAPIRequest {
+    return true;
+}
+
+export function IssueWorkLogAPIRequestFromJSON(json: any): IssueWorkLogAPIRequest {
+    return IssueWorkLogAPIRequestFromJSONTyped(json, false);
+}
+
+export function IssueWorkLogAPIRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueWorkLogAPIRequest {
+    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 IssueWorkLogAPIRequestToJSON(json: any): IssueWorkLogAPIRequest {
+    return IssueWorkLogAPIRequestToJSONTyped(json, false);
+}
+
+export function IssueWorkLogAPIRequestToJSONTyped(value?: IssueWorkLogAPIRequest | 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/Label.ts

@@ -0,0 +1,172 @@
+/* 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 labels with complete metadata.
+ * 
+ * Provides comprehensive label information including hierarchical relationships,
+ * visual properties, and organizational data for work item tagging.
+ * @export
+ * @interface Label
+ */
+export interface Label {
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Label
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Label
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof Label
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    color?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Label
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    readonly project?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Label
+     */
+    parent?: string | null;
+}
+
+/**
+ * Check if a given object implements the Label interface.
+ */
+export function instanceOfLabel(value: object): value is Label {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function LabelFromJSON(json: any): Label {
+    return LabelFromJSONTyped(json, false);
+}
+
+export function LabelFromJSONTyped(json: any, ignoreDiscriminator: boolean): Label {
+    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'])),
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'color': json['color'] == null ? undefined : json['color'],
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        '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'],
+        'parent': json['parent'] == null ? undefined : json['parent'],
+    };
+}
+
+export function LabelToJSON(json: any): Label {
+    return LabelToJSONTyped(json, false);
+}
+
+export function LabelToJSONTyped(value?: Omit<Label, 'id'|'created_at'|'updated_at'|'deleted_at'|'created_by'|'updated_by'|'workspace'|'project'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'color': value['color'],
+        'sort_order': value['sortOrder'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'parent': value['parent'],
+    };
+}
+

package/src/models/LabelCreateUpdateRequest.ts

@@ -0,0 +1,116 @@
+/* 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 LabelCreateUpdateRequest
+ */
+export interface LabelCreateUpdateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    color?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelCreateUpdateRequest
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof LabelCreateUpdateRequest
+     */
+    sortOrder?: number;
+}
+
+/**
+ * Check if a given object implements the LabelCreateUpdateRequest interface.
+ */
+export function instanceOfLabelCreateUpdateRequest(value: object): value is LabelCreateUpdateRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function LabelCreateUpdateRequestFromJSON(json: any): LabelCreateUpdateRequest {
+    return LabelCreateUpdateRequestFromJSONTyped(json, false);
+}
+
+export function LabelCreateUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabelCreateUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': 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 LabelCreateUpdateRequestToJSON(json: any): LabelCreateUpdateRequest {
+    return LabelCreateUpdateRequestToJSONTyped(json, false);
+}
+
+export function LabelCreateUpdateRequestToJSONTyped(value?: LabelCreateUpdateRequest | 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'],
+    };
+}
+

package/src/models/LabelLite.ts

@@ -0,0 +1,83 @@
+/* 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';
+/**
+ * Lightweight label serializer for minimal data transfer.
+ * 
+ * Provides essential label information with visual properties,
+ * optimized for UI display and performance-critical operations.
+ * @export
+ * @interface LabelLite
+ */
+export interface LabelLite {
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelLite
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelLite
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LabelLite
+     */
+    color?: string;
+}
+
+/**
+ * Check if a given object implements the LabelLite interface.
+ */
+export function instanceOfLabelLite(value: object): value is LabelLite {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function LabelLiteFromJSON(json: any): LabelLite {
+    return LabelLiteFromJSONTyped(json, false);
+}
+
+export function LabelLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabelLite {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'],
+        'color': json['color'] == null ? undefined : json['color'],
+    };
+}
+
+export function LabelLiteToJSON(json: any): LabelLite {
+    return LabelLiteToJSONTyped(json, false);
+}
+
+export function LabelLiteToJSONTyped(value?: Omit<LabelLite, 'id'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'color': value['color'],
+    };
+}
+