@makeplane/plane-node-sdk 0.1.0

package/dist/models/CycleIssue.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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.
+ */
+/**
+ * Serializer for cycle-issue relationships with sub-issue counting.
+ *
+ * Manages the association between cycles and work items, including
+ * hierarchical issue tracking for nested work item structures.
+ * @export
+ * @interface CycleIssue
+ */
+export interface CycleIssue {
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    readonly id?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CycleIssue
+     */
+    readonly subIssuesCount?: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof CycleIssue
+     */
+    readonly createdAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CycleIssue
+     */
+    readonly updatedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof CycleIssue
+     */
+    deletedAt: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    createdBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    updatedBy?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    readonly project?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    readonly workspace?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    issue: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CycleIssue
+     */
+    readonly cycle?: string;
+}
+/**
+ * Check if a given object implements the CycleIssue interface.
+ */
+export declare function instanceOfCycleIssue(value: object): value is CycleIssue;
+export declare function CycleIssueFromJSON(json: any): CycleIssue;
+export declare function CycleIssueFromJSONTyped(json: any, ignoreDiscriminator: boolean): CycleIssue;
+export declare function CycleIssueToJSON(json: any): CycleIssue;
+export declare function CycleIssueToJSONTyped(value?: Omit<CycleIssue, 'id' | 'sub_issues_count' | 'created_at' | 'updated_at' | 'project' | 'workspace' | 'cycle'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CycleIssue.js

@@ -0,0 +1,65 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCycleIssue = instanceOfCycleIssue;
+exports.CycleIssueFromJSON = CycleIssueFromJSON;
+exports.CycleIssueFromJSONTyped = CycleIssueFromJSONTyped;
+exports.CycleIssueToJSON = CycleIssueToJSON;
+exports.CycleIssueToJSONTyped = CycleIssueToJSONTyped;
+/**
+ * Check if a given object implements the CycleIssue interface.
+ */
+function instanceOfCycleIssue(value) {
+    if (!('deletedAt' in value) || value['deletedAt'] === undefined)
+        return false;
+    if (!('issue' in value) || value['issue'] === undefined)
+        return false;
+    return true;
+}
+function CycleIssueFromJSON(json) {
+    return CycleIssueFromJSONTyped(json, false);
+}
+function CycleIssueFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'subIssuesCount': json['sub_issues_count'] == null ? undefined : json['sub_issues_count'],
+        '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 ? null : new Date(json['deleted_at'])),
+        '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'],
+        'cycle': json['cycle'] == null ? undefined : json['cycle'],
+    };
+}
+function CycleIssueToJSON(json) {
+    return CycleIssueToJSONTyped(json, false);
+}
+function CycleIssueToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': (value['deletedAt'] == null ? null : value['deletedAt'].toISOString()),
+        'created_by': value['createdBy'],
+        'updated_by': value['updatedBy'],
+        'issue': value['issue'],
+    };
+}

package/dist/models/CycleIssueRequestRequest.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+/**
+ * Serializer for bulk work item assignment to cycles.
+ *
+ * Validates work item ID lists for batch operations including
+ * cycle assignment and sprint planning workflows.
+ * @export
+ * @interface CycleIssueRequestRequest
+ */
+export interface CycleIssueRequestRequest {
+    /**
+     * List of issue IDs to add to the cycle
+     * @type {Array<string>}
+     * @memberof CycleIssueRequestRequest
+     */
+    issues: Array<string>;
+}
+/**
+ * Check if a given object implements the CycleIssueRequestRequest interface.
+ */
+export declare function instanceOfCycleIssueRequestRequest(value: object): value is CycleIssueRequestRequest;
+export declare function CycleIssueRequestRequestFromJSON(json: any): CycleIssueRequestRequest;
+export declare function CycleIssueRequestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CycleIssueRequestRequest;
+export declare function CycleIssueRequestRequestToJSON(json: any): CycleIssueRequestRequest;
+export declare function CycleIssueRequestRequestToJSONTyped(value?: CycleIssueRequestRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CycleIssueRequestRequest.js

@@ -0,0 +1,50 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCycleIssueRequestRequest = instanceOfCycleIssueRequestRequest;
+exports.CycleIssueRequestRequestFromJSON = CycleIssueRequestRequestFromJSON;
+exports.CycleIssueRequestRequestFromJSONTyped = CycleIssueRequestRequestFromJSONTyped;
+exports.CycleIssueRequestRequestToJSON = CycleIssueRequestRequestToJSON;
+exports.CycleIssueRequestRequestToJSONTyped = CycleIssueRequestRequestToJSONTyped;
+/**
+ * Check if a given object implements the CycleIssueRequestRequest interface.
+ */
+function instanceOfCycleIssueRequestRequest(value) {
+    if (!('issues' in value) || value['issues'] === undefined)
+        return false;
+    return true;
+}
+function CycleIssueRequestRequestFromJSON(json) {
+    return CycleIssueRequestRequestFromJSONTyped(json, false);
+}
+function CycleIssueRequestRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'issues': json['issues'],
+    };
+}
+function CycleIssueRequestRequestToJSON(json) {
+    return CycleIssueRequestRequestToJSONTyped(json, false);
+}
+function CycleIssueRequestRequestToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'issues': value['issues'],
+    };
+}

package/dist/models/CycleLite.d.ts

@@ -0,0 +1,161 @@
+/**
+ * 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 type { TimezoneEnum } 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 declare function instanceOfCycleLite(value: object): value is CycleLite;
+export declare function CycleLiteFromJSON(json: any): CycleLite;
+export declare function CycleLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): CycleLite;
+export declare function CycleLiteToJSON(json: any): CycleLite;
+export declare function CycleLiteToJSONTyped(value?: Omit<CycleLite, 'id' | 'created_at' | 'updated_at'> | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CycleLite.js

@@ -0,0 +1,96 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCycleLite = instanceOfCycleLite;
+exports.CycleLiteFromJSON = CycleLiteFromJSON;
+exports.CycleLiteFromJSONTyped = CycleLiteFromJSONTyped;
+exports.CycleLiteToJSON = CycleLiteToJSON;
+exports.CycleLiteToJSONTyped = CycleLiteToJSONTyped;
+var TimezoneEnum_1 = require("./TimezoneEnum");
+/**
+ * Check if a given object implements the CycleLite interface.
+ */
+function instanceOfCycleLite(value) {
+    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;
+}
+function CycleLiteFromJSON(json) {
+    return CycleLiteFromJSONTyped(json, false);
+}
+function CycleLiteFromJSONTyped(json, ignoreDiscriminator) {
+    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 : (0, TimezoneEnum_1.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'],
+    };
+}
+function CycleLiteToJSON(json) {
+    return CycleLiteToJSONTyped(json, false);
+}
+function CycleLiteToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted_at': value['deletedAt'] == null ? undefined : (value['deletedAt'].toISOString()),
+        'name': value['name'],
+        'description': value['description'],
+        'start_date': value['startDate'] == null ? undefined : (value['startDate'].toISOString()),
+        'end_date': value['endDate'] == null ? undefined : (value['endDate'].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'].toISOString()),
+        'logo_props': value['logoProps'],
+        'timezone': (0, TimezoneEnum_1.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/dist/models/EntityTypeEnum.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 declare const EntityTypeEnum: {
+    readonly UserAvatar: "USER_AVATAR";
+    readonly UserCover: "USER_COVER";
+};
+export type EntityTypeEnum = typeof EntityTypeEnum[keyof typeof EntityTypeEnum];
+export declare function instanceOfEntityTypeEnum(value: any): boolean;
+export declare function EntityTypeEnumFromJSON(json: any): EntityTypeEnum;
+export declare function EntityTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityTypeEnum;
+export declare function EntityTypeEnumToJSON(value?: EntityTypeEnum | null): any;
+export declare function EntityTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): EntityTypeEnum;

package/dist/models/EntityTypeEnum.js

@@ -0,0 +1,51 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityTypeEnum = void 0;
+exports.instanceOfEntityTypeEnum = instanceOfEntityTypeEnum;
+exports.EntityTypeEnumFromJSON = EntityTypeEnumFromJSON;
+exports.EntityTypeEnumFromJSONTyped = EntityTypeEnumFromJSONTyped;
+exports.EntityTypeEnumToJSON = EntityTypeEnumToJSON;
+exports.EntityTypeEnumToJSONTyped = EntityTypeEnumToJSONTyped;
+/**
+ * * `USER_AVATAR` - User Avatar
+ * * `USER_COVER` - User Cover
+ * @export
+ */
+exports.EntityTypeEnum = {
+    UserAvatar: 'USER_AVATAR',
+    UserCover: 'USER_COVER'
+};
+function instanceOfEntityTypeEnum(value) {
+    for (var key in exports.EntityTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(exports.EntityTypeEnum, key)) {
+            if (exports.EntityTypeEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function EntityTypeEnumFromJSON(json) {
+    return EntityTypeEnumFromJSONTyped(json, false);
+}
+function EntityTypeEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function EntityTypeEnumToJSON(value) {
+    return value;
+}
+function EntityTypeEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/GenericAssetUploadRequest.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfGenericAssetUploadRequest(value: object): value is GenericAssetUploadRequest;
+export declare function GenericAssetUploadRequestFromJSON(json: any): GenericAssetUploadRequest;
+export declare function GenericAssetUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GenericAssetUploadRequest;
+export declare function GenericAssetUploadRequestToJSON(json: any): GenericAssetUploadRequest;
+export declare function GenericAssetUploadRequestToJSONTyped(value?: GenericAssetUploadRequest | null, ignoreDiscriminator?: boolean): any;