/** * 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 { AutoCompleteSuggestions, ConvertedJQLQueries, JQLPersonalDataMigrationRequest, JQLReferenceData, JqlQueriesToParse, ParsedJqlQueries } from '../models'; export interface GetFieldAutoCompleteForQueryStringRequest { fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; } export interface MigrateQueriesRequest { JQLPersonalDataMigrationRequest: JQLPersonalDataMigrationRequest; } export interface ParseJqlQueriesRequest { JqlQueriesToParse: JqlQueriesToParse; } /** * no description */ export declare class JQLApi extends runtime.BaseAPI { /** * Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get field reference data */ getAutoCompleteRaw(): Promise>; /** * Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get field reference data */ getAutoComplete(): Promise; /** * Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: * `fieldName` to get a list of all values for the field. * `fieldName` and `fieldValue` to get a list of values containing the text in `fieldValue`. * `fieldName` and `predicateName` to get a list of all predicate values for the field. * `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get field auto complete suggestions */ getFieldAutoCompleteForQueryStringRaw(requestParameters: GetFieldAutoCompleteForQueryStringRequest): Promise>; /** * Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: * `fieldName` to get a list of all values for the field. * `fieldName` and `fieldValue` to get a list of values containing the text in `fieldValue`. * `fieldName` and `predicateName` to get a list of all predicate values for the field. * `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get field auto complete suggestions */ getFieldAutoCompleteForQueryString(requestParameters: GetFieldAutoCompleteForQueryStringRequest): Promise; /** * Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/). **[Permissions](#permissions) required:** Permission to access Jira. * Convert user identifiers to account IDs in JQL queries */ migrateQueriesRaw(requestParameters: MigrateQueriesRequest): Promise>; /** * Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/). **[Permissions](#permissions) required:** Permission to access Jira. * Convert user identifiers to account IDs in JQL queries */ migrateQueries(requestParameters: MigrateQueriesRequest): Promise; /** * Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Parse JQL query */ parseJqlQueriesRaw(requestParameters: ParseJqlQueriesRequest): Promise>; /** * Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Parse JQL query */ parseJqlQueries(requestParameters: ParseJqlQueriesRequest): Promise; }