@makeplane/plane-node-sdk 0.1.3 → 0.1.5

package/src/models/IssuePropertyValueAPIDetail.ts

@@ -0,0 +1,76 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for aggregated issue property values response.
+ * This serializer handles the response format from the query_annotator method
+ * which returns property_id and values (ArrayAgg of property values).
+ * @export
+ * @interface IssuePropertyValueAPIDetail
+ */
+export interface IssuePropertyValueAPIDetail {
+    /**
+     * The ID of the issue property
+     * @type {string}
+     * @memberof IssuePropertyValueAPIDetail
+     */
+    propertyId: string;
+    /**
+     * List of aggregated property values for the given property
+     * @type {Array<string>}
+     * @memberof IssuePropertyValueAPIDetail
+     */
+    values: Array<string>;
+}
+
+/**
+ * Check if a given object implements the IssuePropertyValueAPIDetail interface.
+ */
+export function instanceOfIssuePropertyValueAPIDetail(value: object): value is IssuePropertyValueAPIDetail {
+    if (!('propertyId' in value) || value['propertyId'] === undefined) return false;
+    if (!('values' in value) || value['values'] === undefined) return false;
+    return true;
+}
+
+export function IssuePropertyValueAPIDetailFromJSON(json: any): IssuePropertyValueAPIDetail {
+    return IssuePropertyValueAPIDetailFromJSONTyped(json, false);
+}
+
+export function IssuePropertyValueAPIDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssuePropertyValueAPIDetail {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'propertyId': json['property_id'],
+        'values': json['values'],
+    };
+}
+
+export function IssuePropertyValueAPIDetailToJSON(json: any): IssuePropertyValueAPIDetail {
+    return IssuePropertyValueAPIDetailToJSONTyped(json, false);
+}
+
+export function IssuePropertyValueAPIDetailToJSONTyped(value?: IssuePropertyValueAPIDetail | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'property_id': value['propertyId'],
+        'values': value['values'],
+    };
+}
+

package/src/models/IssuePropertyValueAPIRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueRelation.ts

@@ -0,0 +1,150 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for issue relationships showing related issue details.
+ * 
+ * Provides comprehensive information about related issues including
+ * project context, sequence ID, and relationship type.
+ * @export
+ * @interface IssueRelation
+ */
+export interface IssueRelation {
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly projectId?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof IssueRelation
+     */
+    readonly sequenceId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly relationType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly typeId?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IssueRelation
+     */
+    readonly isEpic?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly stateId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly priority?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly createdBy?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueRelation
+     */
+    readonly createdAt?: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof IssueRelation
+     */
+    readonly updatedAt?: Date;
+    /**
+     * 
+     * @type {string}
+     * @memberof IssueRelation
+     */
+    readonly updatedBy?: string | null;
+}
+
+/**
+ * Check if a given object implements the IssueRelation interface.
+ */
+export function instanceOfIssueRelation(value: object): value is IssueRelation {
+    return true;
+}
+
+export function IssueRelationFromJSON(json: any): IssueRelation {
+    return IssueRelationFromJSONTyped(json, false);
+}
+
+export function IssueRelationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRelation {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'projectId': json['project_id'] == null ? undefined : json['project_id'],
+        'sequenceId': json['sequence_id'] == null ? undefined : json['sequence_id'],
+        'relationType': json['relation_type'] == null ? undefined : json['relation_type'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'typeId': json['type_id'] == null ? undefined : json['type_id'],
+        'isEpic': json['is_epic'] == null ? undefined : json['is_epic'],
+        'stateId': json['state_id'] == null ? undefined : json['state_id'],
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'createdBy': json['created_by'] == null ? undefined : json['created_by'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
+        'updatedBy': json['updated_by'] == null ? undefined : json['updated_by'],
+    };
+}
+
+export function IssueRelationToJSON(json: any): IssueRelation {
+    return IssueRelationToJSONTyped(json, false);
+}
+
+export function IssueRelationToJSONTyped(value?: Omit<IssueRelation, 'id'|'project_id'|'sequence_id'|'relation_type'|'name'|'type_id'|'is_epic'|'state_id'|'priority'|'created_by'|'created_at'|'updated_at'|'updated_by'> | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+    };
+}
+

package/src/models/IssueRelationCreateRelationTypeEnum.ts

@@ -0,0 +1,65 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * * `blocking` - Blocking
+ * * `blocked_by` - Blocked By
+ * * `duplicate` - Duplicate
+ * * `relates_to` - Relates To
+ * * `start_before` - Start Before
+ * * `start_after` - Start After
+ * * `finish_before` - Finish Before
+ * * `finish_after` - Finish After
+ * @export
+ */
+export const IssueRelationCreateRelationTypeEnum = {
+    Blocking: 'blocking',
+    BlockedBy: 'blocked_by',
+    Duplicate: 'duplicate',
+    RelatesTo: 'relates_to',
+    StartBefore: 'start_before',
+    StartAfter: 'start_after',
+    FinishBefore: 'finish_before',
+    FinishAfter: 'finish_after'
+} as const;
+export type IssueRelationCreateRelationTypeEnum = typeof IssueRelationCreateRelationTypeEnum[keyof typeof IssueRelationCreateRelationTypeEnum];
+
+
+export function instanceOfIssueRelationCreateRelationTypeEnum(value: any): boolean {
+    for (const key in IssueRelationCreateRelationTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(IssueRelationCreateRelationTypeEnum, key)) {
+            if (IssueRelationCreateRelationTypeEnum[key as keyof typeof IssueRelationCreateRelationTypeEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function IssueRelationCreateRelationTypeEnumFromJSON(json: any): IssueRelationCreateRelationTypeEnum {
+    return IssueRelationCreateRelationTypeEnumFromJSONTyped(json, false);
+}
+
+export function IssueRelationCreateRelationTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRelationCreateRelationTypeEnum {
+    return json as IssueRelationCreateRelationTypeEnum;
+}
+
+export function IssueRelationCreateRelationTypeEnumToJSON(value?: IssueRelationCreateRelationTypeEnum | null): any {
+    return value as any;
+}
+
+export function IssueRelationCreateRelationTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): IssueRelationCreateRelationTypeEnum {
+    return value as IssueRelationCreateRelationTypeEnum;
+}
+

package/src/models/IssueRelationCreateRequest.ts

@@ -0,0 +1,96 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { IssueRelationCreateRelationTypeEnum } from './IssueRelationCreateRelationTypeEnum';
+import {
+    IssueRelationCreateRelationTypeEnumFromJSON,
+    IssueRelationCreateRelationTypeEnumFromJSONTyped,
+    IssueRelationCreateRelationTypeEnumToJSON,
+    IssueRelationCreateRelationTypeEnumToJSONTyped,
+} from './IssueRelationCreateRelationTypeEnum';
+
+/**
+ * Serializer for creating issue relations.
+ * 
+ * Creates issue relations with the specified relation type and issues.
+ * Validates relation types and ensures proper issue ID format.
+ * @export
+ * @interface IssueRelationCreateRequest
+ */
+export interface IssueRelationCreateRequest {
+    /**
+     * Type of relationship between work items
+     * 
+     * * `blocking` - Blocking
+     * * `blocked_by` - Blocked By
+     * * `duplicate` - Duplicate
+     * * `relates_to` - Relates To
+     * * `start_before` - Start Before
+     * * `start_after` - Start After
+     * * `finish_before` - Finish Before
+     * * `finish_after` - Finish After
+     * @type {IssueRelationCreateRelationTypeEnum}
+     * @memberof IssueRelationCreateRequest
+     */
+    relationType: IssueRelationCreateRelationTypeEnum;
+    /**
+     * Array of work item IDs to create relations with
+     * @type {Array<string>}
+     * @memberof IssueRelationCreateRequest
+     */
+    issues: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the IssueRelationCreateRequest interface.
+ */
+export function instanceOfIssueRelationCreateRequest(value: object): value is IssueRelationCreateRequest {
+    if (!('relationType' in value) || value['relationType'] === undefined) return false;
+    if (!('issues' in value) || value['issues'] === undefined) return false;
+    return true;
+}
+
+export function IssueRelationCreateRequestFromJSON(json: any): IssueRelationCreateRequest {
+    return IssueRelationCreateRequestFromJSONTyped(json, false);
+}
+
+export function IssueRelationCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRelationCreateRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relationType': IssueRelationCreateRelationTypeEnumFromJSON(json['relation_type']),
+        'issues': json['issues'],
+    };
+}
+
+export function IssueRelationCreateRequestToJSON(json: any): IssueRelationCreateRequest {
+    return IssueRelationCreateRequestToJSONTyped(json, false);
+}
+
+export function IssueRelationCreateRequestToJSONTyped(value?: IssueRelationCreateRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'relation_type': IssueRelationCreateRelationTypeEnumToJSON(value['relationType']),
+        'issues': value['issues'],
+    };
+}
+

package/src/models/IssueRelationRemoveRequest.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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for removing issue relations.
+ * 
+ * Removes existing relationships between work items by specifying
+ * the related issue ID.
+ * @export
+ * @interface IssueRelationRemoveRequest
+ */
+export interface IssueRelationRemoveRequest {
+    /**
+     * ID of the related work item to remove relation with
+     * @type {string}
+     * @memberof IssueRelationRemoveRequest
+     */
+    relatedIssue: string;
+}
+
+/**
+ * Check if a given object implements the IssueRelationRemoveRequest interface.
+ */
+export function instanceOfIssueRelationRemoveRequest(value: object): value is IssueRelationRemoveRequest {
+    if (!('relatedIssue' in value) || value['relatedIssue'] === undefined) return false;
+    return true;
+}
+
+export function IssueRelationRemoveRequestFromJSON(json: any): IssueRelationRemoveRequest {
+    return IssueRelationRemoveRequestFromJSONTyped(json, false);
+}
+
+export function IssueRelationRemoveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRelationRemoveRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relatedIssue': json['related_issue'],
+    };
+}
+
+export function IssueRelationRemoveRequestToJSON(json: any): IssueRelationRemoveRequest {
+    return IssueRelationRemoveRequestToJSONTyped(json, false);
+}
+
+export function IssueRelationRemoveRequestToJSONTyped(value?: IssueRelationRemoveRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'related_issue': value['relatedIssue'],
+    };
+}
+

package/src/models/IssueRelationResponse.ts

@@ -0,0 +1,130 @@
+/* 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.2
+ * Contact: support@plane.so
+ *
+ * NOTE: This class is auto generated.
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Serializer for issue relations response showing grouped relation types.
+ * 
+ * Returns issue IDs organized by relation type for efficient client-side processing.
+ * @export
+ * @interface IssueRelationResponse
+ */
+export interface IssueRelationResponse {
+    /**
+     * List of issue IDs that are blocking this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    blocking: Array<string>;
+    /**
+     * List of issue IDs that this issue is blocked by
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    blockedBy: Array<string>;
+    /**
+     * List of issue IDs that are duplicates of this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    duplicate: Array<string>;
+    /**
+     * List of issue IDs that relate to this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    relatesTo: Array<string>;
+    /**
+     * List of issue IDs that start after this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    startAfter: Array<string>;
+    /**
+     * List of issue IDs that start before this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    startBefore: Array<string>;
+    /**
+     * List of issue IDs that finish after this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    finishAfter: Array<string>;
+    /**
+     * List of issue IDs that finish before this issue
+     * @type {Array<string>}
+     * @memberof IssueRelationResponse
+     */
+    finishBefore: Array<string>;
+}
+
+/**
+ * Check if a given object implements the IssueRelationResponse interface.
+ */
+export function instanceOfIssueRelationResponse(value: object): value is IssueRelationResponse {
+    if (!('blocking' in value) || value['blocking'] === undefined) return false;
+    if (!('blockedBy' in value) || value['blockedBy'] === undefined) return false;
+    if (!('duplicate' in value) || value['duplicate'] === undefined) return false;
+    if (!('relatesTo' in value) || value['relatesTo'] === undefined) return false;
+    if (!('startAfter' in value) || value['startAfter'] === undefined) return false;
+    if (!('startBefore' in value) || value['startBefore'] === undefined) return false;
+    if (!('finishAfter' in value) || value['finishAfter'] === undefined) return false;
+    if (!('finishBefore' in value) || value['finishBefore'] === undefined) return false;
+    return true;
+}
+
+export function IssueRelationResponseFromJSON(json: any): IssueRelationResponse {
+    return IssueRelationResponseFromJSONTyped(json, false);
+}
+
+export function IssueRelationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IssueRelationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'blocking': json['blocking'],
+        'blockedBy': json['blocked_by'],
+        'duplicate': json['duplicate'],
+        'relatesTo': json['relates_to'],
+        'startAfter': json['start_after'],
+        'startBefore': json['start_before'],
+        'finishAfter': json['finish_after'],
+        'finishBefore': json['finish_before'],
+    };
+}
+
+export function IssueRelationResponseToJSON(json: any): IssueRelationResponse {
+    return IssueRelationResponseToJSONTyped(json, false);
+}
+
+export function IssueRelationResponseToJSONTyped(value?: IssueRelationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'blocking': value['blocking'],
+        'blocked_by': value['blockedBy'],
+        'duplicate': value['duplicate'],
+        'relates_to': value['relatesTo'],
+        'start_after': value['startAfter'],
+        'start_before': value['startBefore'],
+        'finish_after': value['finishAfter'],
+        'finish_before': value['finishBefore'],
+    };
+}
+

package/src/models/IssueRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueSearch.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.
@@ -21,16 +21,15 @@ import {
 } from './IssueSearchItem';
 
 /**
- * Serializer for work item search result data formatting.
+ * Search results for work items.
  * 
- * Provides standardized search result structure including work item identifiers,
- * project context, and workspace information for search API responses.
+ * Provides list of issues with their identifiers, names, and project context.
  * @export
  * @interface IssueSearch
  */
 export interface IssueSearch {
     /**
-     * Array of search result issues
+     * 
      * @type {Array<IssueSearchItem>}
      * @memberof IssueSearch
      */

package/src/models/IssueSearchItem.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueTypeAPI.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueTypeAPIRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueWorkLogAPI.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.

package/src/models/IssueWorkLogAPIRequest.ts

@@ -4,7 +4,7 @@
  * 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
+ * The version of the API Spec: 0.0.2
  * Contact: support@plane.so
  *
  * NOTE: This class is auto generated.