/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * 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 { IssueMatches, IssuePickerSuggestions, IssuesAndJQLQueries, SearchRequestBean, SearchResults } from '../models'; export interface GetIssuePickerResourceRequest { query?: string; currentJQL?: string; currentIssueKey?: string; currentProjectId?: string; showSubTasks?: boolean; showSubTaskParent?: boolean; } export interface MatchIssuesRequest { IssuesAndJQLQueries: IssuesAndJQLQueries; } export interface SearchForIssuesUsingJqlRequest { jql?: string; startAt?: number; maxResults?: number; validateQuery?: SearchForIssuesUsingJqlValidateQueryEnum; fields?: Array; expand?: string; properties?: Array; fieldsByKeys?: boolean; } export interface SearchForIssuesUsingJql1Request { SearchRequestBean: SearchRequestBean; } /** * no description */ export declare class IssueSearchApi extends runtime.BaseAPI { /** * Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string. This operation returns two lists: * `History Search` which includes issues from the user\'s history of created, edited, or viewed issues that contain the string in the `query` parameter. * `Current Search` which includes issues that match the JQL expression in `currentJQL` and contain the string in the `query` parameter. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get issue picker suggestions */ getIssuePickerResourceRaw(requestParameters: GetIssuePickerResourceRequest): Promise>; /** * Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string. This operation returns two lists: * `History Search` which includes issues from the user\'s history of created, edited, or viewed issues that contain the string in the `query` parameter. * `Current Search` which includes issues that match the JQL expression in `currentJQL` and contain the string in the `query` parameter. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get issue picker suggestions */ getIssuePickerResource(requestParameters: GetIssuePickerResourceRequest): Promise; /** * Checks whether one or more issues would be returned by one or more JQL queries. **[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Check issues against JQL */ matchIssuesRaw(requestParameters: MatchIssuesRequest): Promise>; /** * Checks whether one or more issues would be returned by one or more JQL queries. **[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Check issues against JQL */ matchIssues(requestParameters: MatchIssuesRequest): Promise; /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). If the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-3-search-post) version of this resource. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Search for issues using JQL (GET) */ searchForIssuesUsingJqlRaw(requestParameters: SearchForIssuesUsingJqlRequest): Promise>; /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). If the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-3-search-post) version of this resource. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Search for issues using JQL (GET) */ searchForIssuesUsingJql(requestParameters: SearchForIssuesUsingJqlRequest): Promise; /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). There is a [GET](#api-rest-api-3-search-get) version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Search for issues using JQL (POST) */ searchForIssuesUsingJql1Raw(requestParameters: SearchForIssuesUsingJql1Request): Promise>; /** * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ). There is a [GET](#api-rest-api-3-search-get) version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issues are included in the response where the user has: * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue. * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue. * Search for issues using JQL (POST) */ searchForIssuesUsingJql1(requestParameters: SearchForIssuesUsingJql1Request): Promise; } /** * @export * @enum {string} */ export declare enum SearchForIssuesUsingJqlValidateQueryEnum { Strict = "strict", Warn = "warn", None = "none", True = "true", False = "false" }