@makeplane/plane-node-sdk 0.1.0

package/src/models/PatchedModuleUpdateRequest.ts

@@ -0,0 +1,141 @@
+/* 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 { ModuleStatusEnum } from './ModuleStatusEnum';
+import {
+    ModuleStatusEnumFromJSON,
+    ModuleStatusEnumFromJSONTyped,
+    ModuleStatusEnumToJSON,
+    ModuleStatusEnumToJSONTyped,
+} from './ModuleStatusEnum';
+
+/**
+ * Serializer for updating modules with enhanced validation and member management.
+ * 
+ * Extends module creation with update-specific validations including member reassignment,
+ * name conflict checking, and relationship management for module modifications.
+ * @export
+ * @interface PatchedModuleUpdateRequest
+ */
+export interface PatchedModuleUpdateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    targetDate?: Date | null;
+    /**
+     * 
+     * @type {ModuleStatusEnum}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    status?: ModuleStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    lead?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    members?: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedModuleUpdateRequest
+     */
+    externalId?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the PatchedModuleUpdateRequest interface.
+ */
+export function instanceOfPatchedModuleUpdateRequest(value: object): value is PatchedModuleUpdateRequest {
+    return true;
+}
+
+export function PatchedModuleUpdateRequestFromJSON(json: any): PatchedModuleUpdateRequest {
+    return PatchedModuleUpdateRequestFromJSONTyped(json, false);
+}
+
+export function PatchedModuleUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedModuleUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'targetDate': json['target_date'] == null ? undefined : (new Date(json['target_date'])),
+        'status': json['status'] == null ? undefined : ModuleStatusEnumFromJSON(json['status']),
+        'lead': json['lead'] == null ? undefined : json['lead'],
+        'members': json['members'] == null ? undefined : json['members'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+
+export function PatchedModuleUpdateRequestToJSON(json: any): PatchedModuleUpdateRequest {
+    return PatchedModuleUpdateRequestToJSONTyped(json, false);
+}
+
+export function PatchedModuleUpdateRequestToJSONTyped(value?: PatchedModuleUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        '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)),
+        'status': ModuleStatusEnumToJSON(value['status']),
+        'lead': value['lead'],
+        'members': value['members'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+    };
+}
+

package/src/models/PatchedProjectUpdateRequest.ts

@@ -0,0 +1,221 @@
+/* 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 { TimezoneEnum } from './TimezoneEnum';
+import {
+    TimezoneEnumFromJSON,
+    TimezoneEnumFromJSONTyped,
+    TimezoneEnumToJSON,
+    TimezoneEnumToJSONTyped,
+} from './TimezoneEnum';
+
+/**
+ * Serializer for updating projects with enhanced state and estimation management.
+ * 
+ * Extends project creation with update-specific validations including default state
+ * assignment, estimation configuration, and project setting modifications.
+ * @export
+ * @interface PatchedProjectUpdateRequest
+ */
+export interface PatchedProjectUpdateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    projectLead?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    defaultAssignee?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    identifier?: string;
+    /**
+     * 
+     * @type {any}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    iconProp?: any | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    emoji?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    coverImage?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    moduleView?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    cycleView?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    issueViewsView?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    pageView?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    intakeView?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    guestViewAllFeatures?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    archiveIn?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    closeIn?: number;
+    /**
+     * 
+     * @type {TimezoneEnum}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    timezone?: TimezoneEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    defaultState?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedProjectUpdateRequest
+     */
+    estimate?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the PatchedProjectUpdateRequest interface.
+ */
+export function instanceOfPatchedProjectUpdateRequest(value: object): value is PatchedProjectUpdateRequest {
+    return true;
+}
+
+export function PatchedProjectUpdateRequestFromJSON(json: any): PatchedProjectUpdateRequest {
+    return PatchedProjectUpdateRequestFromJSONTyped(json, false);
+}
+
+export function PatchedProjectUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedProjectUpdateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'projectLead': json['project_lead'] == null ? undefined : json['project_lead'],
+        'defaultAssignee': json['default_assignee'] == null ? undefined : json['default_assignee'],
+        'identifier': json['identifier'] == null ? undefined : json['identifier'],
+        'iconProp': json['icon_prop'] == null ? undefined : json['icon_prop'],
+        'emoji': json['emoji'] == null ? undefined : json['emoji'],
+        'coverImage': json['cover_image'] == null ? undefined : json['cover_image'],
+        'moduleView': json['module_view'] == null ? undefined : json['module_view'],
+        'cycleView': json['cycle_view'] == null ? undefined : json['cycle_view'],
+        'issueViewsView': json['issue_views_view'] == null ? undefined : json['issue_views_view'],
+        'pageView': json['page_view'] == null ? undefined : json['page_view'],
+        'intakeView': json['intake_view'] == null ? undefined : json['intake_view'],
+        'guestViewAllFeatures': json['guest_view_all_features'] == null ? undefined : json['guest_view_all_features'],
+        'archiveIn': json['archive_in'] == null ? undefined : json['archive_in'],
+        'closeIn': json['close_in'] == null ? undefined : json['close_in'],
+        'timezone': json['timezone'] == null ? undefined : TimezoneEnumFromJSON(json['timezone']),
+        'defaultState': json['default_state'] == null ? undefined : json['default_state'],
+        'estimate': json['estimate'] == null ? undefined : json['estimate'],
+    };
+}
+
+export function PatchedProjectUpdateRequestToJSON(json: any): PatchedProjectUpdateRequest {
+    return PatchedProjectUpdateRequestToJSONTyped(json, false);
+}
+
+export function PatchedProjectUpdateRequestToJSONTyped(value?: PatchedProjectUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'project_lead': value['projectLead'],
+        'default_assignee': value['defaultAssignee'],
+        'identifier': value['identifier'],
+        'icon_prop': value['iconProp'],
+        'emoji': value['emoji'],
+        'cover_image': value['coverImage'],
+        'module_view': value['moduleView'],
+        'cycle_view': value['cycleView'],
+        'issue_views_view': value['issueViewsView'],
+        'page_view': value['pageView'],
+        'intake_view': value['intakeView'],
+        'guest_view_all_features': value['guestViewAllFeatures'],
+        'archive_in': value['archiveIn'],
+        'close_in': value['closeIn'],
+        'timezone': TimezoneEnumToJSON(value['timezone']),
+        'default_state': value['defaultState'],
+        'estimate': value['estimate'],
+    };
+}
+

package/src/models/PatchedStateRequest.ts

@@ -0,0 +1,141 @@
+/* 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 { GroupEnum } from './GroupEnum';
+import {
+    GroupEnumFromJSON,
+    GroupEnumFromJSONTyped,
+    GroupEnumToJSON,
+    GroupEnumToJSONTyped,
+} from './GroupEnum';
+
+/**
+ * Serializer for work item states with default state management.
+ * 
+ * Handles state creation and updates including default state validation
+ * and automatic default state switching for workflow management.
+ * @export
+ * @interface PatchedStateRequest
+ */
+export interface PatchedStateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedStateRequest
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedStateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedStateRequest
+     */
+    color?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PatchedStateRequest
+     */
+    sequence?: number;
+    /**
+     * 
+     * @type {GroupEnum}
+     * @memberof PatchedStateRequest
+     */
+    group?: GroupEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedStateRequest
+     */
+    isTriage?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PatchedStateRequest
+     */
+    _default?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedStateRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PatchedStateRequest
+     */
+    externalId?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the PatchedStateRequest interface.
+ */
+export function instanceOfPatchedStateRequest(value: object): value is PatchedStateRequest {
+    return true;
+}
+
+export function PatchedStateRequestFromJSON(json: any): PatchedStateRequest {
+    return PatchedStateRequestFromJSONTyped(json, false);
+}
+
+export function PatchedStateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PatchedStateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'color': json['color'] == null ? undefined : json['color'],
+        'sequence': json['sequence'] == null ? undefined : json['sequence'],
+        'group': json['group'] == null ? undefined : GroupEnumFromJSON(json['group']),
+        'isTriage': json['is_triage'] == null ? undefined : json['is_triage'],
+        '_default': json['default'] == null ? undefined : json['default'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+    };
+}
+
+export function PatchedStateRequestToJSON(json: any): PatchedStateRequest {
+    return PatchedStateRequestToJSONTyped(json, false);
+}
+
+export function PatchedStateRequestToJSONTyped(value?: PatchedStateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'color': value['color'],
+        'sequence': value['sequence'],
+        'group': GroupEnumToJSON(value['group']),
+        'is_triage': value['isTriage'],
+        'default': value['_default'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+    };
+}
+

package/src/models/PriorityEnum.ts

@@ -0,0 +1,59 @@
+/* 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.
+ */
+
+
+/**
+ * * `urgent` - Urgent
+ * * `high` - High
+ * * `medium` - Medium
+ * * `low` - Low
+ * * `none` - None
+ * @export
+ */
+export const PriorityEnum = {
+    Urgent: 'urgent',
+    High: 'high',
+    Medium: 'medium',
+    Low: 'low',
+    None: 'none'
+} as const;
+export type PriorityEnum = typeof PriorityEnum[keyof typeof PriorityEnum];
+
+
+export function instanceOfPriorityEnum(value: any): boolean {
+    for (const key in PriorityEnum) {
+        if (Object.prototype.hasOwnProperty.call(PriorityEnum, key)) {
+            if (PriorityEnum[key as keyof typeof PriorityEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PriorityEnumFromJSON(json: any): PriorityEnum {
+    return PriorityEnumFromJSONTyped(json, false);
+}
+
+export function PriorityEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): PriorityEnum {
+    return json as PriorityEnum;
+}
+
+export function PriorityEnumToJSON(value?: PriorityEnum | null): any {
+    return value as any;
+}
+
+export function PriorityEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): PriorityEnum {
+    return value as PriorityEnum;
+}
+