@makeplane/plane-node-sdk 0.1.0

package/src/models/CycleLite.ts

@@ -0,0 +1,246 @@
+/* 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';
+
+/**
+ * Lightweight cycle serializer for minimal data transfer.
+ * 
+ * Provides essential cycle information without computed metrics,
+ * optimized for list views and reference lookups.
+ * @export
+ * @interface CycleLite
+ */
+export interface CycleLite {
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    deletedAt?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    description?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    endDate?: Date | null;
+    /**
+     * 
+     * @type {any}
+     * @memberof CycleLite
+     */
+    viewProps?: any | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CycleLite
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {any}
+     * @memberof CycleLite
+     */
+    progressSnapshot?: any | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CycleLite
+     */
+    archivedAt?: Date | null;
+    /**
+     * 
+     * @type {any}
+     * @memberof CycleLite
+     */
+    logoProps?: any | null;
+    /**
+     * 
+     * @type {TimezoneEnum}
+     * @memberof CycleLite
+     */
+    timezone?: TimezoneEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CycleLite
+     */
+    version?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    project: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    workspace: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CycleLite
+     */
+    ownedBy: string;
+}
+
+
+
+/**
+ * Check if a given object implements the CycleLite interface.
+ */
+export function instanceOfCycleLite(value: object): value is CycleLite {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('project' in value) || value['project'] === undefined) return false;
+    if (!('workspace' in value) || value['workspace'] === undefined) return false;
+    if (!('ownedBy' in value) || value['ownedBy'] === undefined) return false;
+    return true;
+}
+
+export function CycleLiteFromJSON(json: any): CycleLite {
+    return CycleLiteFromJSONTyped(json, false);
+}
+
+export function CycleLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): CycleLite {
+    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'],
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'endDate': json['end_date'] == null ? undefined : (new Date(json['end_date'])),
+        'viewProps': json['view_props'] == null ? undefined : json['view_props'],
+        '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'],
+        'progressSnapshot': json['progress_snapshot'] == null ? undefined : json['progress_snapshot'],
+        'archivedAt': json['archived_at'] == null ? undefined : (new Date(json['archived_at'])),
+        'logoProps': json['logo_props'] == null ? undefined : json['logo_props'],
+        'timezone': json['timezone'] == null ? undefined : TimezoneEnumFromJSON(json['timezone']),
+        'version': json['version'] == null ? undefined : json['version'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+        'project': json['project'],
+        'workspace': json['workspace'],
+        'ownedBy': json['owned_by'],
+    };
+}
+
+export function CycleLiteToJSON(json: any): CycleLite {
+    return CycleLiteToJSONTyped(json, false);
+}
+
+export function CycleLiteToJSONTyped(value?: Omit<CycleLite, 'id'|'created_at'|'updated_at'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'deleted_at': value['deletedAt'] == null ? undefined : ((value['deletedAt'] as any).toISOString()),
+        'name': value['name'],
+        'description': value['description'],
+        'start_date': value['startDate'] == null ? undefined : ((value['startDate'] as any).toISOString()),
+        'end_date': value['endDate'] == null ? undefined : ((value['endDate'] as any).toISOString()),
+        'view_props': value['viewProps'],
+        'sort_order': value['sortOrder'],
+        'external_source': value['externalSource'],
+        'external_id': value['externalId'],
+        'progress_snapshot': value['progressSnapshot'],
+        'archived_at': value['archivedAt'] == null ? undefined : ((value['archivedAt'] as any).toISOString()),
+        'logo_props': value['logoProps'],
+        'timezone': TimezoneEnumToJSON(value['timezone']),
+        'version': value['version'],
+        'created_by': value['createdBy'],
+        'updated_by': value['updatedBy'],
+        'project': value['project'],
+        'workspace': value['workspace'],
+        'owned_by': value['ownedBy'],
+    };
+}
+

package/src/models/EntityTypeEnum.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.1
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * * `USER_AVATAR` - User Avatar
+ * * `USER_COVER` - User Cover
+ * @export
+ */
+export const EntityTypeEnum = {
+    UserAvatar: 'USER_AVATAR',
+    UserCover: 'USER_COVER'
+} as const;
+export type EntityTypeEnum = typeof EntityTypeEnum[keyof typeof EntityTypeEnum];
+
+
+export function instanceOfEntityTypeEnum(value: any): boolean {
+    for (const key in EntityTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(EntityTypeEnum, key)) {
+            if (EntityTypeEnum[key as keyof typeof EntityTypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function EntityTypeEnumFromJSON(json: any): EntityTypeEnum {
+    return EntityTypeEnumFromJSONTyped(json, false);
+}
+
+export function EntityTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityTypeEnum {
+    return json as EntityTypeEnum;
+}
+
+export function EntityTypeEnumToJSON(value?: EntityTypeEnum | null): any {
+    return value as any;
+}
+
+export function EntityTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): EntityTypeEnum {
+    return value as EntityTypeEnum;
+}
+

package/src/models/GenericAssetUploadRequest.ts

@@ -0,0 +1,110 @@
+/* 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 generic asset upload requests with project association.
+ * 
+ * Validates metadata for generating presigned URLs for workspace assets including
+ * project association, external system tracking, and file validation for
+ * document management and content storage workflows.
+ * @export
+ * @interface GenericAssetUploadRequest
+ */
+export interface GenericAssetUploadRequest {
+    /**
+     * Original filename of the asset
+     * @type {string}
+     * @memberof GenericAssetUploadRequest
+     */
+    name: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof GenericAssetUploadRequest
+     */
+    type?: string;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof GenericAssetUploadRequest
+     */
+    size: number;
+    /**
+     * UUID of the project to associate with the asset
+     * @type {string}
+     * @memberof GenericAssetUploadRequest
+     */
+    projectId?: string;
+    /**
+     * External identifier for the asset (for integration tracking)
+     * @type {string}
+     * @memberof GenericAssetUploadRequest
+     */
+    externalId?: string;
+    /**
+     * External source system (for integration tracking)
+     * @type {string}
+     * @memberof GenericAssetUploadRequest
+     */
+    externalSource?: string;
+}
+
+/**
+ * Check if a given object implements the GenericAssetUploadRequest interface.
+ */
+export function instanceOfGenericAssetUploadRequest(value: object): value is GenericAssetUploadRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('size' in value) || value['size'] === undefined) return false;
+    return true;
+}
+
+export function GenericAssetUploadRequestFromJSON(json: any): GenericAssetUploadRequest {
+    return GenericAssetUploadRequestFromJSONTyped(json, false);
+}
+
+export function GenericAssetUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenericAssetUploadRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'size': json['size'],
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'externalId': json['external_id'] == null ? undefined : json['external_id'],
+        'externalSource': json['external_source'] == null ? undefined : json['external_source'],
+    };
+}
+
+export function GenericAssetUploadRequestToJSON(json: any): GenericAssetUploadRequest {
+    return GenericAssetUploadRequestToJSONTyped(json, false);
+}
+
+export function GenericAssetUploadRequestToJSONTyped(value?: GenericAssetUploadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'type': value['type'],
+        'size': value['size'],
+        'project_id': value['projectId'],
+        'external_id': value['externalId'],
+        'external_source': value['externalSource'],
+    };
+}
+

package/src/models/GetWorkspaceMembers200ResponseInner.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 GetWorkspaceMembers200ResponseInner
+ */
+export interface GetWorkspaceMembers200ResponseInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly firstName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly lastName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly email?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly avatar?: string;
+    /**
+     * Avatar URL
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly avatarUrl?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    readonly displayName?: string;
+    /**
+     * Member role in the workspace
+     * @type {number}
+     * @memberof GetWorkspaceMembers200ResponseInner
+     */
+    role?: number;
+}
+
+/**
+ * Check if a given object implements the GetWorkspaceMembers200ResponseInner interface.
+ */
+export function instanceOfGetWorkspaceMembers200ResponseInner(value: object): value is GetWorkspaceMembers200ResponseInner {
+    return true;
+}
+
+export function GetWorkspaceMembers200ResponseInnerFromJSON(json: any): GetWorkspaceMembers200ResponseInner {
+    return GetWorkspaceMembers200ResponseInnerFromJSONTyped(json, false);
+}
+
+export function GetWorkspaceMembers200ResponseInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetWorkspaceMembers200ResponseInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'firstName': json['first_name'] == null ? undefined : json['first_name'],
+        'lastName': json['last_name'] == null ? undefined : json['last_name'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'avatar': json['avatar'] == null ? undefined : json['avatar'],
+        'avatarUrl': json['avatar_url'] == null ? undefined : json['avatar_url'],
+        'displayName': json['display_name'] == null ? undefined : json['display_name'],
+        'role': json['role'] == null ? undefined : json['role'],
+    };
+}
+
+export function GetWorkspaceMembers200ResponseInnerToJSON(json: any): GetWorkspaceMembers200ResponseInner {
+    return GetWorkspaceMembers200ResponseInnerToJSONTyped(json, false);
+}
+
+export function GetWorkspaceMembers200ResponseInnerToJSONTyped(value?: Omit<GetWorkspaceMembers200ResponseInner, 'id'|'first_name'|'last_name'|'email'|'avatar'|'avatar_url'|'display_name'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'role': value['role'],
+    };
+}
+

package/src/models/GroupEnum.ts

@@ -0,0 +1,61 @@
+/* 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.
+ */
+
+
+/**
+ * * `backlog` - Backlog
+ * * `unstarted` - Unstarted
+ * * `started` - Started
+ * * `completed` - Completed
+ * * `cancelled` - Cancelled
+ * * `triage` - Triage
+ * @export
+ */
+export const GroupEnum = {
+    Backlog: 'backlog',
+    Unstarted: 'unstarted',
+    Started: 'started',
+    Completed: 'completed',
+    Cancelled: 'cancelled',
+    Triage: 'triage'
+} as const;
+export type GroupEnum = typeof GroupEnum[keyof typeof GroupEnum];
+
+
+export function instanceOfGroupEnum(value: any): boolean {
+    for (const key in GroupEnum) {
+        if (Object.prototype.hasOwnProperty.call(GroupEnum, key)) {
+            if (GroupEnum[key as keyof typeof GroupEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function GroupEnumFromJSON(json: any): GroupEnum {
+    return GroupEnumFromJSONTyped(json, false);
+}
+
+export function GroupEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupEnum {
+    return json as GroupEnum;
+}
+
+export function GroupEnumToJSON(value?: GroupEnum | null): any {
+    return value as any;
+}
+
+export function GroupEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): GroupEnum {
+    return value as GroupEnum;
+}
+