@makeplane/plane-node-sdk 0.1.3 → 0.1.5

package/src/models/IssueDetail.ts

@@ -0,0 +1,319 @@
+/* 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.2
+ * 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';
+import type { Label } from './Label';
+import {
+    LabelFromJSON,
+    LabelFromJSONTyped,
+    LabelToJSON,
+    LabelToJSONTyped,
+} from './Label';
+import type { UserLite } from './UserLite';
+import {
+    UserLiteFromJSON,
+    UserLiteFromJSONTyped,
+    UserLiteToJSON,
+    UserLiteToJSONTyped,
+} from './UserLite';
+
+/**
+ * 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 IssueDetail
+ */
+export interface IssueDetail {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Array<UserLite>}
+     * @memberof IssueDetail
+     */
+    assignees: Array<UserLite>;
+    /**
+     * 
+     * @type {Array<Label>}
+     * @memberof IssueDetail
+     */
+    labels: Array<Label>;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    typeId?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueDetail
+     */
+    point?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    descriptionHtml?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    descriptionStripped?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    readonly descriptionBinary?: string | null;
+    /**
+     * 
+     * @type {PriorityEnum}
+     * @memberof IssueDetail
+     */
+    priority?: PriorityEnum;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    targetDate?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueDetail
+     */
+    sequenceId?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueDetail
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    completedAt?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueDetail
+     */
+    archivedAt?: Date | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueDetail
+     */
+    isDraft?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    readonly project?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    readonly workspace?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    parent?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    estimatePoint?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueDetail
+     */
+    type?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the IssueDetail interface.
+ */
+export function instanceOfIssueDetail(value: object): value is IssueDetail {
+    if (!('assignees' in value) || value['assignees'] === undefined) return false;
+    if (!('labels' in value) || value['labels'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function IssueDetailFromJSON(json: any): IssueDetail {
+    return IssueDetailFromJSONTyped(json, false);
+}
+
+export function IssueDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'assignees': ((json['assignees'] as Array<any>).map(UserLiteFromJSON)),
+        'labels': ((json['labels'] as Array<any>).map(LabelFromJSON)),
+        '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 IssueDetailToJSON(json: any): IssueDetail {
+    return IssueDetailToJSONTyped(json, false);
+}
+
+export function IssueDetailToJSONTyped(value?: Omit<IssueDetail, 'id'|'created_at'|'updated_at'|'description_binary'|'updated_by'|'project'|'workspace'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'assignees': ((value['assignees'] as Array<any>).map(UserLiteToJSON)),
+        'labels': ((value['labels'] as Array<any>).map(LabelToJSON)),
+        '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/IssueExpand.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.
@@ -26,13 +26,6 @@ import {
     StateLiteToJSON,
     StateLiteToJSONTyped,
 } from './StateLite';
-import type { LabelLite } from './LabelLite';
-import {
-    LabelLiteFromJSON,
-    LabelLiteFromJSONTyped,
-    LabelLiteToJSON,
-    LabelLiteToJSONTyped,
-} from './LabelLite';
 import type { CycleLite } from './CycleLite';
 import {
     CycleLiteFromJSON,
@@ -47,13 +40,6 @@ import {
     ModuleLiteToJSON,
     ModuleLiteToJSONTyped,
 } from './ModuleLite';
-import type { UserLite } from './UserLite';
-import {
-    UserLiteFromJSON,
-    UserLiteFromJSONTyped,
-    UserLiteToJSON,
-    UserLiteToJSONTyped,
-} from './UserLite';
 
 /**
  * Extended work item serializer with full relationship expansion.
@@ -84,16 +70,16 @@ export interface IssueExpand {
     readonly module?: ModuleLite;
     /**
      * 
-     * @type {Array<LabelLite>}
+     * @type {string}
      * @memberof IssueExpand
      */
-    readonly labels?: Array<LabelLite>;
+    readonly labels?: string;
     /**
      * 
-     * @type {Array<UserLite>}
+     * @type {string}
      * @memberof IssueExpand
      */
-    readonly assignees?: Array<UserLite>;
+    readonly assignees?: string;
     /**
      * 
      * @type {StateLite}
@@ -281,8 +267,8 @@ export function IssueExpandFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'id': json['id'] == null ? undefined : json['id'],
         'cycle': json['cycle'] == null ? undefined : CycleLiteFromJSON(json['cycle']),
         'module': json['module'] == null ? undefined : ModuleLiteFromJSON(json['module']),
-        'labels': json['labels'] == null ? undefined : ((json['labels'] as Array<any>).map(LabelLiteFromJSON)),
-        'assignees': json['assignees'] == null ? undefined : ((json['assignees'] as Array<any>).map(UserLiteFromJSON)),
+        'labels': json['labels'] == null ? undefined : json['labels'],
+        'assignees': json['assignees'] == null ? undefined : json['assignees'],
         'state': json['state'] == null ? undefined : StateLiteFromJSON(json['state']),
         'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
         'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),

package/src/models/IssueForIntakeRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueLink.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueLinkCreateRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssuePropertyAPI.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.
@@ -12,13 +12,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { RelationTypeEnum } from './RelationTypeEnum';
+import type { IssuePropertyAPIRelationTypeEnum } from './IssuePropertyAPIRelationTypeEnum';
 import {
-    RelationTypeEnumFromJSON,
-    RelationTypeEnumFromJSONTyped,
-    RelationTypeEnumToJSON,
-    RelationTypeEnumToJSONTyped,
-} from './RelationTypeEnum';
+    IssuePropertyAPIRelationTypeEnumFromJSON,
+    IssuePropertyAPIRelationTypeEnumFromJSONTyped,
+    IssuePropertyAPIRelationTypeEnumToJSON,
+    IssuePropertyAPIRelationTypeEnumToJSONTyped,
+} from './IssuePropertyAPIRelationTypeEnum';
 import type { PropertyTypeEnum } from './PropertyTypeEnum';
 import {
     PropertyTypeEnumFromJSON,
@@ -47,10 +47,10 @@ export interface IssuePropertyAPI {
     readonly deletedAt?: Date | null;
     /**
      * 
-     * @type {RelationTypeEnum}
+     * @type {IssuePropertyAPIRelationTypeEnum}
      * @memberof IssuePropertyAPI
      */
-    relationType?: RelationTypeEnum;
+    relationType?: IssuePropertyAPIRelationTypeEnum | null;
     /**
      * 
      * @type {Date}
@@ -202,7 +202,7 @@ export function IssuePropertyAPIFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         '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']),
+        'relationType': json['relation_type'] == null ? undefined : IssuePropertyAPIRelationTypeEnumFromJSON(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'],
@@ -238,7 +238,7 @@ export function IssuePropertyAPIToJSONTyped(value?: Omit<IssuePropertyAPI, 'id'|
 
     return {
         
-        'relation_type': RelationTypeEnumToJSON(value['relationType']),
+        'relation_type': IssuePropertyAPIRelationTypeEnumToJSON(value['relationType']),
         'display_name': value['displayName'],
         'description': value['description'],
         'property_type': PropertyTypeEnumToJSON(value['propertyType']),

package/src/models/IssuePropertyAPIRelationTypeEnum.ts

@@ -0,0 +1,53 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * * `ISSUE` - Issue
+ * * `USER` - User
+ * @export
+ */
+export const IssuePropertyAPIRelationTypeEnum = {
+    Issue: 'ISSUE',
+    User: 'USER'
+} as const;
+export type IssuePropertyAPIRelationTypeEnum = typeof IssuePropertyAPIRelationTypeEnum[keyof typeof IssuePropertyAPIRelationTypeEnum];
+
+
+export function instanceOfIssuePropertyAPIRelationTypeEnum(value: any): boolean {
+    for (const key in IssuePropertyAPIRelationTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(IssuePropertyAPIRelationTypeEnum, key)) {
+            if (IssuePropertyAPIRelationTypeEnum[key as keyof typeof IssuePropertyAPIRelationTypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function IssuePropertyAPIRelationTypeEnumFromJSON(json: any): IssuePropertyAPIRelationTypeEnum {
+    return IssuePropertyAPIRelationTypeEnumFromJSONTyped(json, false);
+}
+
+export function IssuePropertyAPIRelationTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssuePropertyAPIRelationTypeEnum {
+    return json as IssuePropertyAPIRelationTypeEnum;
+}
+
+export function IssuePropertyAPIRelationTypeEnumToJSON(value?: IssuePropertyAPIRelationTypeEnum | null): any {
+    return value as any;
+}
+
+export function IssuePropertyAPIRelationTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): IssuePropertyAPIRelationTypeEnum {
+    return value as IssuePropertyAPIRelationTypeEnum;
+}
+

package/src/models/IssuePropertyAPIRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.
@@ -12,13 +12,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { RelationTypeEnum } from './RelationTypeEnum';
+import type { IssuePropertyAPIRelationTypeEnum } from './IssuePropertyAPIRelationTypeEnum';
 import {
-    RelationTypeEnumFromJSON,
-    RelationTypeEnumFromJSONTyped,
-    RelationTypeEnumToJSON,
-    RelationTypeEnumToJSONTyped,
-} from './RelationTypeEnum';
+    IssuePropertyAPIRelationTypeEnumFromJSON,
+    IssuePropertyAPIRelationTypeEnumFromJSONTyped,
+    IssuePropertyAPIRelationTypeEnumToJSON,
+    IssuePropertyAPIRelationTypeEnumToJSONTyped,
+} from './IssuePropertyAPIRelationTypeEnum';
 import type { PropertyTypeEnum } from './PropertyTypeEnum';
 import {
     PropertyTypeEnumFromJSON,
@@ -35,10 +35,10 @@ import {
 export interface IssuePropertyAPIRequest {
     /**
      * 
-     * @type {RelationTypeEnum}
+     * @type {IssuePropertyAPIRelationTypeEnum}
      * @memberof IssuePropertyAPIRequest
      */
-    relationType?: RelationTypeEnum;
+    relationType?: IssuePropertyAPIRelationTypeEnum | null;
     /**
      * 
      * @type {string}
@@ -128,7 +128,7 @@ export function IssuePropertyAPIRequestFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'relationType': json['relation_type'] == null ? undefined : RelationTypeEnumFromJSON(json['relation_type']),
+        'relationType': json['relation_type'] == null ? undefined : IssuePropertyAPIRelationTypeEnumFromJSON(json['relation_type']),
         'displayName': json['display_name'],
         'description': json['description'] == null ? undefined : json['description'],
         'propertyType': PropertyTypeEnumFromJSON(json['property_type']),
@@ -154,7 +154,7 @@ export function IssuePropertyAPIRequestToJSONTyped(value?: IssuePropertyAPIReque
 
     return {
         
-        'relation_type': RelationTypeEnumToJSON(value['relationType']),
+        'relation_type': IssuePropertyAPIRelationTypeEnumToJSON(value['relationType']),
         'display_name': value['displayName'],
         'description': value['description'],
         'property_type': PropertyTypeEnumToJSON(value['propertyType']),

package/src/models/IssuePropertyOptionAPI.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssuePropertyOptionAPIRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssuePropertyValueAPI.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.