/** * Jira Software Cloud API * Jira Software Cloud REST API documentation * * The version of the OpenAPI document: 1001.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { BodiesPartiallyUpdateEpic, BodiesRankEpics, MoveIssuesToBacklog } from '../models'; export interface GetEpicRequest { epicIdOrKey: string; } export interface GetIssuesForEpic1Request { epicIdOrKey: string; startAt?: number; maxResults?: number; jql?: string; validateQuery?: boolean; fields?: Array; expand?: string; } export interface GetIssuesWithoutEpic1Request { startAt?: number; maxResults?: number; jql?: string; validateQuery?: boolean; fields?: Array; expand?: string; } export interface MoveIssuesToEpicRequest { epicIdOrKey: string; MoveIssuesToBacklog: MoveIssuesToBacklog; } export interface PartiallyUpdateEpicRequest { epicIdOrKey: string; BodiesPartiallyUpdateEpic: BodiesPartiallyUpdateEpic; } export interface RankEpicsRequest { epicIdOrKey: string; BodiesRankEpics: BodiesRankEpics; } export interface RemoveIssuesFromEpicRequest { MoveIssuesToBacklog: MoveIssuesToBacklog; } /** * no description */ export declare class EpicApi extends runtime.BaseAPI { /** * Returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. **Note:** This operation does not work for epics in next-gen projects. * Get epic */ getEpicRaw(requestParameters: GetEpicRequest): Promise>; /** * Returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. **Note:** This operation does not work for epics in next-gen projects. * Get epic */ getEpic(requestParameters: GetEpicRequest): Promise; /** * Returns all issues that belong to the epic, for the given epic ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent). * Get issues for epic */ getIssuesForEpic1Raw(requestParameters: GetIssuesForEpic1Request): Promise>; /** * Returns all issues that belong to the epic, for the given epic ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent). * Get issues for epic */ getIssuesForEpic1(requestParameters: GetIssuesForEpic1Request): Promise; /** * Returns all issues that do not belong to any epic. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that don\'t belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent is empty` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent). * Get issues without epic */ getIssuesWithoutEpic1Raw(requestParameters: GetIssuesWithoutEpic1Request): Promise>; /** * Returns all issues that do not belong to any epic. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that don\'t belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent is empty` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent). * Get issues without epic */ getIssuesWithoutEpic1(requestParameters: GetIssuesWithoutEpic1Request): Promise; /** * Moves issues to an epic, for a given epic id. Issues can be only in a single epic at the same time. That means that already assigned issues to an epic, will not be assigned to the previous epic anymore. The user needs to have the edit issue permission for all issue they want to move and to the epic. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. * Move issues to epic */ moveIssuesToEpicRaw(requestParameters: MoveIssuesToEpicRequest): Promise>; /** * Moves issues to an epic, for a given epic id. Issues can be only in a single epic at the same time. That means that already assigned issues to an epic, will not be assigned to the previous epic anymore. The user needs to have the edit issue permission for all issue they want to move and to the epic. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. * Move issues to epic */ moveIssuesToEpic(requestParameters: MoveIssuesToEpicRequest): Promise; /** * Performs a partial update of the epic. A partial update means that fields not present in the request JSON will not be updated. Valid values for color are `color_1` to `color_9`. **Note:** This operation does not work for epics in next-gen projects. * Partially update epic */ partiallyUpdateEpicRaw(requestParameters: PartiallyUpdateEpicRequest): Promise>; /** * Performs a partial update of the epic. A partial update means that fields not present in the request JSON will not be updated. Valid values for color are `color_1` to `color_9`. **Note:** This operation does not work for epics in next-gen projects. * Partially update epic */ partiallyUpdateEpic(requestParameters: PartiallyUpdateEpicRequest): Promise; /** * Moves (ranks) an epic before or after a given epic. If rankCustomFieldId is not defined, the default rank field will be used. **Note:** This operation does not work for epics in next-gen projects. * Rank epics */ rankEpicsRaw(requestParameters: RankEpicsRequest): Promise>; /** * Moves (ranks) an epic before or after a given epic. If rankCustomFieldId is not defined, the default rank field will be used. **Note:** This operation does not work for epics in next-gen projects. * Rank epics */ rankEpics(requestParameters: RankEpicsRequest): Promise; /** * Removes issues from epics. The user needs to have the edit issue permission for all issue they want to remove from epics. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. * Remove issues from epic */ removeIssuesFromEpicRaw(requestParameters: RemoveIssuesFromEpicRequest): Promise>; /** * Removes issues from epics. The user needs to have the edit issue permission for all issue they want to remove from epics. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. * Remove issues from epic */ removeIssuesFromEpic(requestParameters: RemoveIssuesFromEpicRequest): Promise; }