@makeplane/plane-node-sdk 0.1.0

package/src/models/TransferCycleIssueRequestRequest.ts

@@ -0,0 +1,68 @@
+/* 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 transferring work items between cycles.
+ * 
+ * Handles work item migration between cycles including validation
+ * and relationship updates for sprint reallocation workflows.
+ * @export
+ * @interface TransferCycleIssueRequestRequest
+ */
+export interface TransferCycleIssueRequestRequest {
+    /**
+     * ID of the target cycle to transfer issues to
+     * @type {string}
+     * @memberof TransferCycleIssueRequestRequest
+     */
+    newCycleId: string;
+}
+
+/**
+ * Check if a given object implements the TransferCycleIssueRequestRequest interface.
+ */
+export function instanceOfTransferCycleIssueRequestRequest(value: object): value is TransferCycleIssueRequestRequest {
+    if (!('newCycleId' in value) || value['newCycleId'] === undefined) return false;
+    return true;
+}
+
+export function TransferCycleIssueRequestRequestFromJSON(json: any): TransferCycleIssueRequestRequest {
+    return TransferCycleIssueRequestRequestFromJSONTyped(json, false);
+}
+
+export function TransferCycleIssueRequestRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferCycleIssueRequestRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'newCycleId': json['new_cycle_id'],
+    };
+}
+
+export function TransferCycleIssueRequestRequestToJSON(json: any): TransferCycleIssueRequestRequest {
+    return TransferCycleIssueRequestRequestToJSONTyped(json, false);
+}
+
+export function TransferCycleIssueRequestRequestToJSONTyped(value?: TransferCycleIssueRequestRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'new_cycle_id': value['newCycleId'],
+    };
+}
+

package/src/models/TransferCycleWorkItems200Response.ts

@@ -0,0 +1,64 @@
+/* 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 TransferCycleWorkItems200Response
+ */
+export interface TransferCycleWorkItems200Response {
+    /**
+     * Success message
+     * @type {string}
+     * @memberof TransferCycleWorkItems200Response
+     */
+    message?: string;
+}
+
+/**
+ * Check if a given object implements the TransferCycleWorkItems200Response interface.
+ */
+export function instanceOfTransferCycleWorkItems200Response(value: object): value is TransferCycleWorkItems200Response {
+    return true;
+}
+
+export function TransferCycleWorkItems200ResponseFromJSON(json: any): TransferCycleWorkItems200Response {
+    return TransferCycleWorkItems200ResponseFromJSONTyped(json, false);
+}
+
+export function TransferCycleWorkItems200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferCycleWorkItems200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+
+export function TransferCycleWorkItems200ResponseToJSON(json: any): TransferCycleWorkItems200Response {
+    return TransferCycleWorkItems200ResponseToJSONTyped(json, false);
+}
+
+export function TransferCycleWorkItems200ResponseToJSONTyped(value?: TransferCycleWorkItems200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+    };
+}
+

package/src/models/TransferCycleWorkItems400Response.ts

@@ -0,0 +1,64 @@
+/* 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 TransferCycleWorkItems400Response
+ */
+export interface TransferCycleWorkItems400Response {
+    /**
+     * Error message
+     * @type {string}
+     * @memberof TransferCycleWorkItems400Response
+     */
+    error?: string;
+}
+
+/**
+ * Check if a given object implements the TransferCycleWorkItems400Response interface.
+ */
+export function instanceOfTransferCycleWorkItems400Response(value: object): value is TransferCycleWorkItems400Response {
+    return true;
+}
+
+export function TransferCycleWorkItems400ResponseFromJSON(json: any): TransferCycleWorkItems400Response {
+    return TransferCycleWorkItems400ResponseFromJSONTyped(json, false);
+}
+
+export function TransferCycleWorkItems400ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransferCycleWorkItems400Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function TransferCycleWorkItems400ResponseToJSON(json: any): TransferCycleWorkItems400Response {
+    return TransferCycleWorkItems400ResponseToJSONTyped(json, false);
+}
+
+export function TransferCycleWorkItems400ResponseToJSONTyped(value?: TransferCycleWorkItems400Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'error': value['error'],
+    };
+}
+

package/src/models/TypeEnum.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.
+ */
+
+
+/**
+ * * `image/jpeg` - JPEG
+ * * `image/png` - PNG
+ * * `image/webp` - WebP
+ * * `image/jpg` - JPG
+ * * `image/gif` - GIF
+ * @export
+ */
+export const TypeEnum = {
+    ImageJpeg: 'image/jpeg',
+    ImagePng: 'image/png',
+    ImageWebp: 'image/webp',
+    ImageJpg: 'image/jpg',
+    ImageGif: 'image/gif'
+} as const;
+export type TypeEnum = typeof TypeEnum[keyof typeof TypeEnum];
+
+
+export function instanceOfTypeEnum(value: any): boolean {
+    for (const key in TypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(TypeEnum, key)) {
+            if (TypeEnum[key as keyof typeof TypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function TypeEnumFromJSON(json: any): TypeEnum {
+    return TypeEnumFromJSONTyped(json, false);
+}
+
+export function TypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): TypeEnum {
+    return json as TypeEnum;
+}
+
+export function TypeEnumToJSON(value?: TypeEnum | null): any {
+    return value as any;
+}
+
+export function TypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): TypeEnum {
+    return value as TypeEnum;
+}
+

package/src/models/UserAssetUploadRequest.ts

@@ -0,0 +1,121 @@
+/* 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 { TypeEnum } from './TypeEnum';
+import {
+    TypeEnumFromJSON,
+    TypeEnumFromJSONTyped,
+    TypeEnumToJSON,
+    TypeEnumToJSONTyped,
+} from './TypeEnum';
+import type { EntityTypeEnum } from './EntityTypeEnum';
+import {
+    EntityTypeEnumFromJSON,
+    EntityTypeEnumFromJSONTyped,
+    EntityTypeEnumToJSON,
+    EntityTypeEnumToJSONTyped,
+} from './EntityTypeEnum';
+
+/**
+ * Serializer for user asset upload requests.
+ * 
+ * This serializer validates the metadata required to generate a presigned URL
+ * for uploading user profile assets (avatar or cover image) directly to S3 storage.
+ * Supports JPEG, PNG, WebP, JPG, and GIF image formats with size validation.
+ * @export
+ * @interface UserAssetUploadRequest
+ */
+export interface UserAssetUploadRequest {
+    /**
+     * Original filename of the asset
+     * @type {string}
+     * @memberof UserAssetUploadRequest
+     */
+    name: string;
+    /**
+     * MIME type of the file
+     * 
+     * * `image/jpeg` - JPEG
+     * * `image/png` - PNG
+     * * `image/webp` - WebP
+     * * `image/jpg` - JPG
+     * * `image/gif` - GIF
+     * @type {TypeEnum}
+     * @memberof UserAssetUploadRequest
+     */
+    type?: TypeEnum;
+    /**
+     * File size in bytes
+     * @type {number}
+     * @memberof UserAssetUploadRequest
+     */
+    size: number;
+    /**
+     * Type of user asset
+     * 
+     * * `USER_AVATAR` - User Avatar
+     * * `USER_COVER` - User Cover
+     * @type {EntityTypeEnum}
+     * @memberof UserAssetUploadRequest
+     */
+    entityType: EntityTypeEnum;
+}
+
+
+
+/**
+ * Check if a given object implements the UserAssetUploadRequest interface.
+ */
+export function instanceOfUserAssetUploadRequest(value: object): value is UserAssetUploadRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('size' in value) || value['size'] === undefined) return false;
+    if (!('entityType' in value) || value['entityType'] === undefined) return false;
+    return true;
+}
+
+export function UserAssetUploadRequestFromJSON(json: any): UserAssetUploadRequest {
+    return UserAssetUploadRequestFromJSONTyped(json, false);
+}
+
+export function UserAssetUploadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserAssetUploadRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'type': json['type'] == null ? undefined : TypeEnumFromJSON(json['type']),
+        'size': json['size'],
+        'entityType': EntityTypeEnumFromJSON(json['entity_type']),
+    };
+}
+
+export function UserAssetUploadRequestToJSON(json: any): UserAssetUploadRequest {
+    return UserAssetUploadRequestToJSONTyped(json, false);
+}
+
+export function UserAssetUploadRequestToJSONTyped(value?: UserAssetUploadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'type': TypeEnumToJSON(value['type']),
+        'size': value['size'],
+        'entity_type': EntityTypeEnumToJSON(value['entityType']),
+    };
+}
+

package/src/models/UserLite.ts

@@ -0,0 +1,108 @@
+/* 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';
+/**
+ * Lightweight user serializer for minimal data transfer.
+ * 
+ * Provides essential user information including names, avatar, and contact details
+ * optimized for member lists, assignee displays, and user references.
+ * @export
+ * @interface UserLite
+ */
+export interface UserLite {
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly firstName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly lastName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly email?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly avatar?: string;
+    /**
+     * Avatar URL
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly avatarUrl?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UserLite
+     */
+    readonly displayName?: string;
+}
+
+/**
+ * Check if a given object implements the UserLite interface.
+ */
+export function instanceOfUserLite(value: object): value is UserLite {
+    return true;
+}
+
+export function UserLiteFromJSON(json: any): UserLite {
+    return UserLiteFromJSONTyped(json, false);
+}
+
+export function UserLiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserLite {
+    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'],
+    };
+}
+
+export function UserLiteToJSON(json: any): UserLite {
+    return UserLiteToJSONTyped(json, false);
+}
+
+export function UserLiteToJSONTyped(value?: Omit<UserLite, 'id'|'first_name'|'last_name'|'email'|'avatar'|'avatar_url'|'display_name'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/index.ts

@@ -0,0 +1,95 @@
+/* tslint:disable */
+ 
+export * from './AccessEnum';
+export * from './Cycle';
+export * from './CycleCreateRequest';
+export * from './CycleIssue';
+export * from './CycleIssueRequestRequest';
+export * from './CycleLite';
+export * from './EntityTypeEnum';
+export * from './GenericAssetUploadRequest';
+export * from './GetWorkspaceMembers200ResponseInner';
+export * from './GroupEnum';
+export * from './IntakeIssue';
+export * from './IntakeIssueCreateRequest';
+export * from './IntakeWorkItemStatusEnum';
+export * from './Issue';
+export * from './IssueActivity';
+export * from './IssueAttachment';
+export * from './IssueAttachmentUploadRequest';
+export * from './IssueComment';
+export * from './IssueCommentCreateRequest';
+export * from './IssueExpand';
+export * from './IssueForIntakeRequest';
+export * from './IssueLink';
+export * from './IssueLinkCreateRequest';
+export * from './IssuePropertyAPI';
+export * from './IssuePropertyAPIRequest';
+export * from './IssuePropertyOptionAPI';
+export * from './IssuePropertyOptionAPIRequest';
+export * from './IssuePropertyValueAPI';
+export * from './IssuePropertyValueAPIRequest';
+export * from './IssueRequest';
+export * from './IssueSearch';
+export * from './IssueTypeAPI';
+export * from './IssueTypeAPIRequest';
+export * from './IssueWorkLogAPI';
+export * from './IssueWorkLogAPIRequest';
+export * from './Label';
+export * from './LabelCreateUpdateRequest';
+export * from './LabelLite';
+export * from './Module';
+export * from './ModuleCreateRequest';
+export * from './ModuleIssue';
+export * from './ModuleIssueRequestRequest';
+export * from './ModuleLite';
+export * from './ModuleStatusEnum';
+export * from './NetworkEnum';
+export * from './PaginatedArchivedCycleResponse';
+export * from './PaginatedArchivedModuleResponse';
+export * from './PaginatedCycleIssueResponse';
+export * from './PaginatedCycleResponse';
+export * from './PaginatedIntakeIssueResponse';
+export * from './PaginatedIssueActivityDetailResponse';
+export * from './PaginatedIssueActivityResponse';
+export * from './PaginatedIssueCommentResponse';
+export * from './PaginatedIssueLinkDetailResponse';
+export * from './PaginatedIssueLinkResponse';
+export * from './PaginatedLabelResponse';
+export * from './PaginatedModuleIssueResponse';
+export * from './PaginatedModuleResponse';
+export * from './PaginatedProjectResponse';
+export * from './PaginatedStateResponse';
+export * from './PaginatedWorkItemResponse';
+export * from './PatchedAssetUpdateRequest';
+export * from './PatchedCycleUpdateRequest';
+export * from './PatchedGenericAssetUpdateRequest';
+export * from './PatchedIntakeIssueUpdateRequest';
+export * from './PatchedIssueCommentCreateRequest';
+export * from './PatchedIssueLinkUpdateRequest';
+export * from './PatchedIssuePropertyAPIRequest';
+export * from './PatchedIssuePropertyOptionAPIRequest';
+export * from './PatchedIssueRequest';
+export * from './PatchedIssueTypeAPIRequest';
+export * from './PatchedIssueWorkLogAPIRequest';
+export * from './PatchedLabelCreateUpdateRequest';
+export * from './PatchedModuleUpdateRequest';
+export * from './PatchedProjectUpdateRequest';
+export * from './PatchedStateRequest';
+export * from './PriorityEnum';
+export * from './Project';
+export * from './ProjectCreateRequest';
+export * from './ProjectWorklogSummary';
+export * from './PropertyTypeEnum';
+export * from './RelationTypeEnum';
+export * from './RetrieveWorkItemAttachment400Response';
+export * from './State';
+export * from './StateLite';
+export * from './StateRequest';
+export * from './TimezoneEnum';
+export * from './TransferCycleIssueRequestRequest';
+export * from './TransferCycleWorkItems200Response';
+export * from './TransferCycleWorkItems400Response';
+export * from './TypeEnum';
+export * from './UserAssetUploadRequest';
+export * from './UserLite';