@makeplane/plane-node-sdk 0.1.0

package/src/models/PropertyTypeEnum.ts

@@ -0,0 +1,67 @@
+/* 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.
+ */
+
+
+/**
+ * * `TEXT` - Text
+ * * `DATETIME` - Datetime
+ * * `DECIMAL` - Decimal
+ * * `BOOLEAN` - Boolean
+ * * `OPTION` - Option
+ * * `RELATION` - Relation
+ * * `URL` - URL
+ * * `EMAIL` - Email
+ * * `FILE` - File
+ * @export
+ */
+export const PropertyTypeEnum = {
+    Text: 'TEXT',
+    Datetime: 'DATETIME',
+    Decimal: 'DECIMAL',
+    Boolean: 'BOOLEAN',
+    Option: 'OPTION',
+    Relation: 'RELATION',
+    Url: 'URL',
+    Email: 'EMAIL',
+    File: 'FILE'
+} as const;
+export type PropertyTypeEnum = typeof PropertyTypeEnum[keyof typeof PropertyTypeEnum];
+
+
+export function instanceOfPropertyTypeEnum(value: any): boolean {
+    for (const key in PropertyTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(PropertyTypeEnum, key)) {
+            if (PropertyTypeEnum[key as keyof typeof PropertyTypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PropertyTypeEnumFromJSON(json: any): PropertyTypeEnum {
+    return PropertyTypeEnumFromJSONTyped(json, false);
+}
+
+export function PropertyTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): PropertyTypeEnum {
+    return json as PropertyTypeEnum;
+}
+
+export function PropertyTypeEnumToJSON(value?: PropertyTypeEnum | null): any {
+    return value as any;
+}
+
+export function PropertyTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): PropertyTypeEnum {
+    return value as PropertyTypeEnum;
+}
+

package/src/models/RelationTypeEnum.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.
+ */
+
+
+/**
+ * * `ISSUE` - Issue
+ * * `USER` - User
+ * @export
+ */
+export const RelationTypeEnum = {
+    Issue: 'ISSUE',
+    User: 'USER'
+} as const;
+export type RelationTypeEnum = typeof RelationTypeEnum[keyof typeof RelationTypeEnum];
+
+
+export function instanceOfRelationTypeEnum(value: any): boolean {
+    for (const key in RelationTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(RelationTypeEnum, key)) {
+            if (RelationTypeEnum[key as keyof typeof RelationTypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function RelationTypeEnumFromJSON(json: any): RelationTypeEnum {
+    return RelationTypeEnumFromJSONTyped(json, false);
+}
+
+export function RelationTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): RelationTypeEnum {
+    return json as RelationTypeEnum;
+}
+
+export function RelationTypeEnumToJSON(value?: RelationTypeEnum | null): any {
+    return value as any;
+}
+
+export function RelationTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): RelationTypeEnum {
+    return value as RelationTypeEnum;
+}
+

package/src/models/RetrieveWorkItemAttachment400Response.ts

@@ -0,0 +1,72 @@
+/* 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 RetrieveWorkItemAttachment400Response
+ */
+export interface RetrieveWorkItemAttachment400Response {
+    /**
+     * Error message
+     * @type {string}
+     * @memberof RetrieveWorkItemAttachment400Response
+     */
+    error?: string;
+    /**
+     * Request status
+     * @type {boolean}
+     * @memberof RetrieveWorkItemAttachment400Response
+     */
+    status?: boolean;
+}
+
+/**
+ * Check if a given object implements the RetrieveWorkItemAttachment400Response interface.
+ */
+export function instanceOfRetrieveWorkItemAttachment400Response(value: object): value is RetrieveWorkItemAttachment400Response {
+    return true;
+}
+
+export function RetrieveWorkItemAttachment400ResponseFromJSON(json: any): RetrieveWorkItemAttachment400Response {
+    return RetrieveWorkItemAttachment400ResponseFromJSONTyped(json, false);
+}
+
+export function RetrieveWorkItemAttachment400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetrieveWorkItemAttachment400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'] == null ? undefined : json['error'],
+        'status': json['status'] == null ? undefined : json['status'],
+    };
+}
+
+export function RetrieveWorkItemAttachment400ResponseToJSON(json: any): RetrieveWorkItemAttachment400Response {
+    return RetrieveWorkItemAttachment400ResponseToJSONTyped(json, false);
+}
+
+export function RetrieveWorkItemAttachment400ResponseToJSONTyped(value?: RetrieveWorkItemAttachment400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+        'status': value['status'],
+    };
+}
+

package/src/models/State.ts

@@ -0,0 +1,206 @@
+/* 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 State
+ */
+export interface State {
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof State
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof State
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof State
+     */
+    readonly deletedAt?: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    color: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly slug?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof State
+     */
+    sequence?: number;
+    /**
+     * 
+     * @type {GroupEnum}
+     * @memberof State
+     */
+    group?: GroupEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof State
+     */
+    isTriage?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof State
+     */
+    _default?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    externalId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly updatedBy?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly project?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof State
+     */
+    readonly workspace?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the State interface.
+ */
+export function instanceOfState(value: object): value is State {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('color' in value) || value['color'] === undefined) return false;
+    return true;
+}
+
+export function StateFromJSON(json: any): State {
+    return StateFromJSONTyped(json, false);
+}
+
+export function StateFromJSONTyped(json: any, ignoreDiscriminator: boolean): State {
+    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'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        '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'],
+        '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'],
+    };
+}
+
+export function StateToJSON(json: any): State {
+    return StateToJSONTyped(json, false);
+}
+
+export function StateToJSONTyped(value?: Omit<State, 'id'|'created_at'|'updated_at'|'deleted_at'|'slug'|'created_by'|'updated_by'|'project'|'workspace'> | 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/StateLite.ts

@@ -0,0 +1,97 @@
+/* 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';
+
+/**
+ * Lightweight state serializer for minimal data transfer.
+ * 
+ * Provides essential state information including visual properties
+ * and grouping data optimized for UI display and filtering.
+ * @export
+ * @interface StateLite
+ */
+export interface StateLite {
+    /**
+     * 
+     * @type {string}
+     * @memberof StateLite
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateLite
+     */
+    readonly name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateLite
+     */
+    readonly color?: string;
+    /**
+     * 
+     * @type {GroupEnum}
+     * @memberof StateLite
+     */
+    readonly group?: GroupEnum;
+}
+
+
+
+/**
+ * Check if a given object implements the StateLite interface.
+ */
+export function instanceOfStateLite(value: object): value is StateLite {
+    return true;
+}
+
+export function StateLiteFromJSON(json: any): StateLite {
+    return StateLiteFromJSONTyped(json, false);
+}
+
+export function StateLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): StateLite {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'color': json['color'] == null ? undefined : json['color'],
+        'group': json['group'] == null ? undefined : GroupEnumFromJSON(json['group']),
+    };
+}
+
+export function StateLiteToJSON(json: any): StateLite {
+    return StateLiteToJSONTyped(json, false);
+}
+
+export function StateLiteToJSONTyped(value?: Omit<StateLite, 'id'|'name'|'color'|'group'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/StateRequest.ts

@@ -0,0 +1,143 @@
+/* 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 StateRequest
+ */
+export interface StateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof StateRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateRequest
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateRequest
+     */
+    color: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StateRequest
+     */
+    sequence?: number;
+    /**
+     * 
+     * @type {GroupEnum}
+     * @memberof StateRequest
+     */
+    group?: GroupEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StateRequest
+     */
+    isTriage?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof StateRequest
+     */
+    _default?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateRequest
+     */
+    externalSource?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof StateRequest
+     */
+    externalId?: string | null;
+}
+
+
+
+/**
+ * Check if a given object implements the StateRequest interface.
+ */
+export function instanceOfStateRequest(value: object): value is StateRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('color' in value) || value['color'] === undefined) return false;
+    return true;
+}
+
+export function StateRequestFromJSON(json: any): StateRequest {
+    return StateRequestFromJSONTyped(json, false);
+}
+
+export function StateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'color': 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 StateRequestToJSON(json: any): StateRequest {
+    return StateRequestToJSONTyped(json, false);
+}
+
+export function StateRequestToJSONTyped(value?: StateRequest | 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'],
+    };
+}
+