@ever-gauzy/plugin-integration-plane-api 0.1.0

package/dist/modules/issues/issues.service.d.ts

@@ -0,0 +1,327 @@
+import { ICommentFindInput, ICreateCommentInput, ICreatedIssueRelation, ICreateIssueLink, ICreateIssueRelationInput, ICreateReactionInput, ID, IDeleteRelationInput, IIssue, IIssueComment, IIssueCreateInput, IIssueFindInput, IIssueLink, IIssueUpdateInput, IOrganizationProject, IPagination, IReaction, IReactionData, IssueActivityTypeEnum, IssueOrderByField, ISubIssueResponse, ISubscriber, ITask, ITaskDateFilterInput, IEmployee } from '@ever-gauzy/plugin-integration-plane-models';
+import { ApiFetchService } from '../api-fetch/api-fetch.service';
+import { StatesService } from '../states/states.service';
+import { CommentsService } from '../comments/comments.service';
+import { ProjectService } from '../project/project.service';
+import { ReactionsService } from '../reactions/reactions.service';
+import { IssueRelationsService } from '../issue-relations/issue-relations.service';
+import { IssueLinksService } from '../issue-links/issue-links.service';
+import { ActivityService } from '../activity/activity.service';
+import { IssueLabelsService } from './issue-labels/issue-labels.service';
+import { SubscriptionService } from '../subscription/subscription.service';
+import { MentionService } from '../mention/mention.service';
+export declare class IssuesService extends ApiFetchService {
+    private readonly _projectService;
+    private readonly _stateSerive;
+    private readonly _issueLabelService;
+    private readonly _commentService;
+    private readonly _reactionService;
+    private readonly _issueLinkService;
+    private readonly _issueRelationService;
+    private readonly _activityService;
+    private readonly _subscriptionService;
+    private readonly _mentionService;
+    private readonly _serverFetchService;
+    constructor(_projectService: ProjectService, _stateSerive: StatesService, _issueLabelService: IssueLabelsService, _commentService: CommentsService, _reactionService: ReactionsService, _issueLinkService: IssueLinksService, _issueRelationService: IssueRelationsService, _activityService: ActivityService, _subscriptionService: SubscriptionService, _mentionService: MentionService, _serverFetchService: ApiFetchService);
+    private readonly path;
+    /**
+     * @description - Get remode API issue
+     * @param {ID} id - The issue ID
+     * @returns - A promise that resolved after getting issue
+     * @memberof IssuesService
+     */
+    getExternalIssue(id: ID, relations?: string[], isDraft?: boolean): Promise<ITask>;
+    /**
+     * Retrieves all tasks from an external source with optional filters.
+     *
+     * Sends a GET request to an external API to fetch tasks based on the provided options.
+     *
+     * @param {ITask} options - Optional task filters or configurations to customize the query.
+     * @returns {Promise<IPagination<ITask>>} A promise that resolves to an array of tasks.
+     * @throws {BadRequestException} If an error occurs during the fetch.
+     */
+    findAllExternal(options: IIssueFindInput, relations?: string[], orderByField?: IssueOrderByField, isDraft?: boolean): Promise<IPagination<ITask>>;
+    /**
+     * Retrieves tasks assigned to a specific employee from an external source.
+     *
+     * Sends a GET request to fetch tasks for the specified employee ID.
+     *
+     * @param {ID} employeeId - The ID of the employee for whom the tasks are being retrieved.
+     * @returns {Promise<ITask[]>} A promise that resolves to an array of tasks assigned to the specified employee.
+     * @throws {BadRequestException} If an error occurs during the fetch.
+     */
+    findExternalByEmployee(employeeId: ID, relations?: string[], orderByField?: IssueOrderByField): Promise<ITask[]>;
+    /**
+     * Retrieves tasks based on the provided start and due date filters.
+     *
+     * This method builds a query dynamically based on the provided `ITaskDateFilterInput` options.
+     * It sends a GET request to fetch tasks filtered by the specified
+     * start and due date ranges or other applicable criteria.
+     *
+     * @param {ITaskDateFilterInput} options - The filtering options including start date, due date, and other possible filters.
+     * @returns {Promise<ITask[]>} A promise that resolves with an array of tasks that match the filtering criteria.
+     * @throws {BadRequestException} Throws an error if the API request fails or if the options are invalid.
+     */
+    findByStartAndDueDate(options: ITaskDateFilterInput): Promise<ITask[]>;
+    /**
+     * @description - Find issue by Id
+     * @param {ID} id - The issue ID to search
+     * @returns - A promise that resolves after issue fetched
+     * @memberof IssuesService
+     */
+    findOne(id: ID, isDraft?: boolean): Promise<IIssue>;
+    /**
+     * @description - Create issue
+     * @param {IIssueCreateInput} input - data for creating new issue
+     * @returns - A promise that resolves after issue created
+     * @memberof IssuesService
+     */
+    create(input: IIssueCreateInput): Promise<IIssue>;
+    /**
+     * @description - Update issue
+     * @param {IIssueCreateInput} input - data for updating issue
+     * @param {ID} id - The issue ID to be updated
+     * @returns - A promise that resolves after issue updated
+     * @memberof IssuesService
+     */
+    update(id: ID, input: IIssueUpdateInput, isDraft: boolean): Promise<IIssue>;
+    /**
+     * Updates the parent-child relationship between a parent task and multiple sub-tasks.
+     *
+     * @param {ID} id - The ID of the parent task.
+     * @param {Pick<IIssueUpdateInput, 'sub_issue_ids'>} input - Object containing the IDs of the sub-tasks (`sub_issue_ids`).
+     * @returns {Promise<ITask[]>} - A promise that resolves to an array of updated tasks
+     * @throws {BadRequestException} - Throws an exception in case of an update error.
+     */
+    updateRelationnalIssueParent(id: ID, input: Pick<IIssueUpdateInput, 'sub_issue_ids'>): Promise<ISubIssueResponse>;
+    /**
+     * Retrieves all issues related to a specific project, with optional filters and grouping.
+     *
+     * This function fetches issues based on the project ID, using optional parameters such as
+     * filter options and the referer to detect if the request comes from a view page.
+     * Depending on the `group_by` option, the issues are grouped accordingly before being returned.
+     *
+     * @param {ID} projectId - The ID of the project for which to retrieve issues.
+     * @param {IIssueFindInput} [options] - Optional filters and grouping options for the query.
+     * @param {string} [referer] - The referer URL, used to extract the view ID if the request is from a view page.
+     * @returns {Promise<any>} A promise that resolves to the grouped or non-grouped issues.
+     * @throws {BadRequestException} If there is an error during the API fetch or data processing.
+     */
+    getAllIssuesByProject(projectId?: ID, options?: IIssueFindInput, referer?: string): Promise<any>;
+    /**
+     * @description Find issu children
+     * @param {ID} id - Issue ID to search
+     * @returns A promise that resolves after found issue children
+     * @memberof IssuesService
+     */
+    findIssueChildren(id: ID): Promise<ISubIssueResponse>;
+    /**
+     * Retrieves all tasks with optional filters and options.
+     *
+     * Sends a GET request to fetch tasks with the provided query options, and
+     * transforms each task into the issue format. Returns a list of transformed tasks.
+     *
+     * @param {ITask} [options] - Optional filters or configurations for fetching tasks.
+     * @returns {Promise<IIssue[]>} A promise that resolves to a list of transformed issues.
+     * @throws {BadRequestException} If an error occurs during the fetch.
+     */
+    findAll(options?: ITask, relations?: string[], isDraft?: boolean): Promise<IIssue[]>;
+    /**
+     * Retrieves tasks assigned to a specific employee.
+     *
+     * Sends a GET request to fetch tasks based on the provided employee ID,
+     * applies a transformation to each task, and returns the transformed list.
+     *
+     * @param {ID} employeeId - The ID of the employee whose tasks are to be fetched.
+     * @returns {Promise<ITask[]>} A promise that resolves to a list of transformed tasks.
+     * @throws {BadRequestException} If an error occurs during the fetch.
+     */
+    findByEmployee(employeeId: ID, relations?: string[]): Promise<IIssue[]>;
+    /**
+     * @description Create issue relations.
+     * @param {ID} taskToId Issue ID for whom to create main relations.
+     * @param {ICreateIssueRelationInput} input - Body request data for creating main and inversed relations.
+     * @returns A promise resolved to created and transformed main relations.
+     * @memberof IssuesService
+     */
+    createIssueRelations(taskToId: ID, input: ICreateIssueRelationInput): Promise<ICreatedIssueRelation[]>;
+    /**
+     * @description Delete main and inverse relations
+     * @param {ID} id - Main Issue ID for delete the main relation
+     * @param {IDeleteRelationInput} input - Body Request data for related issue and relation type
+     * @returns - Delete Result
+     * @memberof IssuesService
+     */
+    deleteIssueRelation(id: ID, input: IDeleteRelationInput): Promise<any>;
+    /**
+     * @description Find issue relation (Issues associates)
+     * @param {ID} id - Issue ID
+     * @returns A promise resolved to fetched issue relations
+     * @memberof IssuesService
+     */
+    findIssueRelations(id: ID): Promise<import("@ever-gauzy/plugin-integration-plane-models").IIssueRelationResponse>;
+    /**
+     * @description Delete issue
+     * @param {ID} id - The issue ID to be deleted
+     * @returns A promise resolved to delete result
+     * @memberof IssuesService
+     */
+    delete(id: ID): Promise<any>;
+    /**
+     * @description Create issue comment
+     * @param {ID} entityId - Issue ID for creating comment
+     * @param {ID} projectId - Project ID for returning project data
+     * @param {ICreateCommentInput} input - Body request
+     * @returns A promise resolved to comment created and returned related data
+     * @memberof IssuesService
+     */
+    createComment(entityId: ID, projectId: ID, input: ICreateCommentInput): Promise<IIssueComment>;
+    /**
+     * @description Update issue comment
+     * @param {ID} id - Comment ID to be updated
+     * @param {ID} projectId - Project ID for find details
+     * @param {ICreateCommentInput} input - Body Request data
+     * @param {ID} entityId
+     * @returns A promise resolved to updated comment and details
+     * @memberof IssuesService
+     */
+    updateComment(id: ID, projectId: ID, input: ICreateCommentInput, entityId: ID): Promise<IIssueComment>;
+    /**
+     * @description Delete issue comment
+     * @param {ID} id -The issue comment ID to be deleted
+     * @returns A promise resolved to delete result
+     * @memberof IssuesService
+     */
+    deleteComment(id: ID): Promise<any>;
+    /**
+     * @description Get issues comments
+     * @param {Partial<ICommentFindInput>} options Option filters
+     * @param {ID} projectId - Project ID
+     * @returns A promise resolved after fetch comments
+     * @memberof IssuesService
+     */
+    getIssueComments(options: Partial<ICommentFindInput>, projectId: ID): Promise<any>;
+    findIssueActivity(id: ID, projectId: ID): Promise<any>;
+    /**
+     * @description Create Reaction to issue
+     * @param {ID} entityId - Issue ID for whom create reaction
+     * @param {ID} projectId - The project ID for returning project data
+     * @param {ICreateReactionInput} input - Body request data
+     * @returns A promise resolved to created and transformed reaction
+     * @memberof IssuesService
+     */
+    createReaction(entityId: ID, projectId: ID, input: ICreateReactionInput): Promise<IReactionData>;
+    /**
+     * @description Find issue reactions with associated data
+     * @param {Partial<IReaction>} options Find options filter
+     * @param {ID} projectId - Project ID for returning data
+     * @returns A promise resolved to found and transformed reactions
+     * @memberof IssuesService
+     */
+    findIssueReactions(options: Partial<IReaction>, projectId: ID, isDraft?: boolean): Promise<any>;
+    /**
+     * @description Delete Issue Reaction By Emoji.
+     * @param {string} reaction - Emoji
+     * @param {ID} entityId - Issue ID from whom to delete reaction
+     * @returns A promise resolved to deleted result
+     * @memberof IssuesService
+     */
+    deleteIssueReactionByEmoji(reaction: string, entityId: ID): Promise<any>;
+    /**
+     * @description Get issue activity and comments
+     * @param {ID} id - Issue ID
+     * @param {ID} projectId - Project ID
+     * @param {IssueActivityTypeEnum} activity_type Activity type
+     * @returns A promise resolved after got comments or Activity Logs
+     * @memberof IssuesService
+     */
+    findActivity(id: ID, projectId: ID, activity_type: IssueActivityTypeEnum): Promise<any>;
+    /**
+     * @description Get Issue comment and reaction details
+     * @param {ID} id - Issue ID
+     * @param {ID} projectId - Project ID
+     * @param {ID} employeeId Creator ID for returning actor details
+     * @param {ITask} originalTask Optional task to avoid multiple API calls
+     * @param {IOrganizationProject} originalProject Optional project to avoid multiple API calls
+     * @returns - A promise resolced afet got details
+     * @memberof IssuesService
+     */
+    getIssueCommentDetails(id: ID, projectId: ID, employeeId: ID, originalTask?: ITask, originalProject?: IOrganizationProject): Promise<{
+        issue: IIssue;
+        project: IOrganizationProject | undefined;
+        workspace: {
+            name: string | undefined;
+            id: string | undefined;
+            slug: string | undefined;
+        };
+        actor: IEmployee | undefined;
+    }>;
+    /**
+     * @description Create Issue Link
+     * @param {ID} id - Issue ID for whom create link
+     * @param {ID} projectId - The project ID for returning project data
+     * @param {ICreateIssueLink} input - Body request data
+     * @returns A promise resolved to created and transformed link
+     * @memberof IssuesService
+     */
+    createLink(id: ID, projectId: ID, input: ICreateIssueLink): Promise<IIssueLink>;
+    /**
+     * @description Update Issue Link
+     * @param {ID} id - Link ID to update update
+     * @param {ID} issueId - Issue ID for whom update link
+     * @param {ID} projectId - The project ID for returning project data
+     * @param {ICreateIssueLink} input - Body request data
+     * @returns A promise resolved to created and transformed link
+     * @memberof IssuesService
+     */
+    updateLink(id: ID, issueId: ID, projectId: ID, input: ICreateIssueLink): Promise<IIssueLink>;
+    /**
+     * @description Find issue links with associated data
+     * @param {ID} id - Issue ID
+     * @param {ID} projectId - Project ID for returning data
+     * @returns A promise resolved to found and transformed links
+     * @memberof IssuesService
+     */
+    findIssueLinks(id: ID, projectId: ID, issue: ITask): Promise<any>;
+    /**
+     * @description Find issues by view with view filters
+     * @param {ID} viewId - The view ID for whom to search issues
+     * @param {*} query - View filters
+     * @returns A promise resolved to found and tranformed issues
+     * @memberof IssuesService
+     */
+    findViewIssues(viewId: ID, query: any): Promise<IIssue[]>;
+    /**
+     * @description Delete Issue Link.
+     * @param {ID} id - Issue Link ID to delete
+     * @returns A promise resolved to deleted result
+     * @memberof IssuesService
+     */
+    deleteLink(id: ID): Promise<any>;
+    /**
+     * Subscribes to a specific issue within a project and returns the subscription details.
+     *
+     * @param {ID} issueId - The ID of the issue to subscribe to.
+     * @param {ID} projectId - The ID of the project where the issue exists.
+     * @returns {Promise<ISubscriber | ISubscriber[]>} A promise that resolves to the transformed subscription data, either a single subscriber or a list of subscribers.
+     */
+    subscribe(issueId: ID, projectId: ID): Promise<ISubscriber | ISubscriber[]>;
+    /**
+     * Unsubscribes the default user from a task subscription based on the provided issue ID.
+     *
+     * @param {ID} issueId - The unique identifier of the issue/task to unsubscribe from.
+     * @returns {Promise<any>} A promise that resolves to the response of the unsubscribe operation.
+     * @throws {BadRequestException} If the unsubscription fails or encounters an error.
+     */
+    unsubscribe(issueId: ID): Promise<any>;
+    /**
+     * Get issue meta
+     * @param {ID} issueId - Issue ID
+     * @returns {Promise<{ sequence_id: number; project_identifier: string }>} A promise that resolves to the issue meta
+     * @throws {BadRequestException} If the issue is not found
+     */
+    getIssueMeta(issueId: ID): Promise<{
+        sequence_id: number;
+        project_identifier: string;
+    }>;
+}