@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/platform/services/JqlService.js

@@ -22,638 +22,641 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql
  */
 class JqlService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * 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.
-     *
-     * To filter visible field details by project or collapse non-unique fields by
-     * field type then [Get field reference data
-     * (POST)](#api-rest-api-3-jql-autocompletedata-post) can be used.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "jqlReservedWords": [
-     *     "empty",
-     *     "and",
-     *     "or",
-     *     "in",
-     *     "distinct"
-     *   ],
-     *   "visibleFieldNames": [
-     *     {
-     *       "displayName": "summary",
-     *       "operators": [
-     *         "~",
-     *         "!~",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "orderable": "true",
-     *       "searchable": "true",
-     *       "types": [
-     *         "java.lang.String"
-     *       ],
-     *       "value": "summary"
-     *     },
-     *     {
-     *       "auto": "true",
-     *       "cfid": "cf[10880]",
-     *       "displayName": "Sprint - cf[10880]",
-     *       "operators": [
-     *         "=",
-     *         "!=",
-     *         "in",
-     *         "not in",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "orderable": "true",
-     *       "searchable": "true",
-     *       "types": [
-     *         "com.atlassian.greenhopper.service.sprint.Sprint"
-     *       ],
-     *       "value": "Sprint"
-     *     }
-     *   ],
-     *   "visibleFunctionNames": [
-     *     {
-     *       "displayName": "standardIssueTypes()",
-     *       "isList": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.issuetype.IssueType"
-     *       ],
-     *       "value": "standardIssueTypes()"
-     *     },
-     *     {
-     *       "displayName": "issuesWithText()",
-     *       "supportsListAndSingleValueOperators": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.issuetype.IssueType"
-     *       ],
-     *       "value": "issuesWithText()"
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/api/3/jql/autocompletedata
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-get
-     */
-    getAutoComplete() {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/autocompletedata",
-            method: "GET",
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getAutoComplete.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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 filter the custom fields returned by project. Invalid
-     * project IDs in `projectIds` are ignored. System fields are always returned.
-     *
-     * It can also return the collapsed field for custom fields. Collapsed fields
-     * enable searches to be performed across all fields with the same name and of the
-     * same field type. For example, the collapsed field `Component -
-     * Component[Dropdown]` enables dropdown fields `Component - cf[10061]` and
-     * `Component - cf[10062]` to be searched simultaneously.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "jqlReservedWords": [
-     *     "empty",
-     *     "and",
-     *     "or",
-     *     "in",
-     *     "distinct"
-     *   ],
-     *   "visibleFieldNames": [
-     *     {
-     *       "displayName": "summary",
-     *       "operators": [
-     *         "~",
-     *         "!~",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "orderable": "true",
-     *       "searchable": "true",
-     *       "types": [
-     *         "java.lang.String"
-     *       ],
-     *       "value": "summary"
-     *     },
-     *     {
-     *       "auto": "true",
-     *       "cfid": "cf[10061]",
-     *       "displayName": "Component - cf[10061]",
-     *       "operators": [
-     *         "=",
-     *         "!=",
-     *         "in",
-     *         "not in",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "orderable": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.customfields.option.Option"
-     *       ],
-     *       "value": "cf[10061]"
-     *     },
-     *     {
-     *       "auto": "true",
-     *       "cfid": "cf[10062]",
-     *       "displayName": "Component - cf[10062]",
-     *       "operators": [
-     *         "=",
-     *         "!=",
-     *         "in",
-     *         "not in",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "orderable": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.customfields.option.Option"
-     *       ],
-     *       "value": "cf[10062]"
-     *     },
-     *     {
-     *       "auto": "true",
-     *       "displayName": "Component - Component[Dropdown]",
-     *       "operators": [
-     *         "=",
-     *         "!=",
-     *         "in",
-     *         "not in",
-     *         "is",
-     *         "is not"
-     *       ],
-     *       "searchable": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.customfields.option.Option"
-     *       ],
-     *       "value": "\"Component[Dropdown]\""
-     *     }
-     *   ],
-     *   "visibleFunctionNames": [
-     *     {
-     *       "displayName": "standardIssueTypes()",
-     *       "isList": "true",
-     *       "types": [
-     *         "com.atlassian.jira.issue.issuetype.IssueType"
-     *       ],
-     *       "value": "standardIssueTypes()"
-     *     }
-     *   ]
-     * }
-     * @path {POST} /rest/api/3/jql/autocompletedata
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-post
-     */
-    getAutoCompletePost({ searchAutoCompleteFilter, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/autocompletedata",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: searchAutoCompleteFilter,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getAutoCompletePost.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "results": [
-     *     {
-     *       "displayName": "<b>Ac</b>tiveObjects (AO)",
-     *       "value": "ActiveObjects"
-     *     },
-     *     {
-     *       "displayName": "Atlassian Connect (<b>AC</b>)",
-     *       "value": "Atlassian Connect"
-     *     },
-     *     {
-     *       "displayName": "Atlassian Connect in Jira (<b>AC</b>JIRA)",
-     *       "value": "Atlassian Connect in Jira"
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/api/3/jql/autocompletedata/suggestions
-     * @scopes-current read:jira-work
-     * @scopes-beta read:issue-details:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-suggestions-get
-     */
-    getFieldAutoCompleteForQueryString({ fieldName, fieldValue, predicateName, predicateValue, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/autocompletedata/suggestions",
-            method: "GET",
-            query: {
-                fieldName,
-                fieldValue,
-                predicateName,
-                predicateValue,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getFieldAutoCompleteForQueryString.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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.
-     *
-     * @returns Returned if the request is successful. Note that the JQL queries are returned
-     * in the same order that they were passed.
-     *
-     * example: {
-     *   "queriesWithUnknownUsers": [
-     *     {
-     *       "convertedQuery": "assignee = unknown",
-     *       "originalQuery": "assignee = mia"
-     *     }
-     *   ],
-     *   "queryStrings": [
-     *     "issuetype = Bug AND assignee in (abcde-12345) AND reporter in
-     * (abc551-c4e99) order by lastViewed DESC"
-     *   ]
-     * }
-     * @path {POST} /rest/api/3/jql/pdcleaner
-     * @scopes-current read:jira-user
-     * @scopes-beta read:user:jira, read:jql:jira, validate:jql:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-pdcleaner-post
-     */
-    migrateQueries({ jqlPersonalDataMigrationRequest, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/pdcleaner",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: jqlPersonalDataMigrationRequest,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.migrateQueries.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Parses and validates JQL queries.
-     *
-     * Validation is performed in context of the current user.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "queries": [
-     *     {
-     *       "query": "summary ~ test AND (labels in (urgent, blocker) OR
-     * lastCommentedBy = currentUser()) AND status CHANGED AFTER -5d ORDER BY updated
-     * DESC",
-     *       "structure": {
-     *         "orderBy": {
-     *           "fields": [
-     *             {
-     *               "direction": "desc",
-     *               "field": {
-     *                 "encodedName": "updated",
-     *                 "name": "updated"
-     *               }
-     *             }
-     *           ]
-     *         },
-     *         "where": {
-     *           "clauses": [
-     *             {
-     *               "field": {
-     *                 "encodedName": "summary",
-     *                 "name": "summary"
-     *               },
-     *               "operand": {
-     *                 "encodedValue": "test",
-     *                 "value": "test"
-     *               },
-     *               "operator": "~"
-     *             },
-     *             {
-     *               "clauses": [
-     *                 {
-     *                   "field": {
-     *                     "encodedName": "labels",
-     *                     "name": "labels"
-     *                   },
-     *                   "operand": {
-     *                     "encodedOperand": "urgent, blocker)",
-     *                     "values": [
-     *                       {
-     *                         "encodedValue": "urgent",
-     *                         "value": "urgent"
-     *                       },
-     *                       {
-     *                         "encodedValue": "blocker",
-     *                         "value": "blocker"
-     *                       }
-     *                     ]
-     *                   },
-     *                   "operator": "in"
-     *                 },
-     *                 {
-     *                   "field": {
-     *                     "encodedName": "lastCommentedBy",
-     *                     "name": "lastCommentedBy",
-     *                     "property": [
-     *                       {
-     *                         "entity": "issue",
-     *                         "key": "propertyKey",
-     *                         "path": "path.in.property",
-     *                         "type": "user"
-     *                       }
-     *                     ]
-     *                   },
-     *                   "operand": {
-     *                     "arguments": [],
-     *                     "encodedOperand": "currentUser()",
-     *                     "function": "currentUser"
-     *                   },
-     *                   "operator": "="
-     *                 }
-     *               ],
-     *               "operator": "or"
-     *             },
-     *             {
-     *               "field": {
-     *                 "encodedName": "status",
-     *                 "name": "status"
-     *               },
-     *               "operator": "changed",
-     *               "predicates": [
-     *                 {
-     *                   "operand": {
-     *                     "arguments": [
-     *                       "-1M"
-     *                     ],
-     *                     "encodedOperand": "startOfMonth(-1M)",
-     *                     "function": "startOfMonth"
-     *                   },
-     *                   "operator": "after"
-     *                 }
-     *               ]
-     *             }
-     *           ],
-     *           "operator": "and"
-     *         }
-     *       }
-     *     },
-     *     {
-     *       "query": "issue.property[\"spaces here\"].value in (\"Service requests\",
-     * Incidents)",
-     *       "structure": {
-     *         "where": {
-     *           "field": {
-     *             "encodedName": "issue.property[\"spaces here\"].value",
-     *             "name": "issue.property[spaces here].value",
-     *             "property": [
-     *               {
-     *                 "entity": "issue",
-     *                 "key": "spaces here",
-     *                 "path": "value"
-     *               }
-     *             ]
-     *           },
-     *           "operand": {
-     *             "encodedOperand": "(\"Service requests\", Incidents)",
-     *             "values": [
-     *               {
-     *                 "encodedValue": "\"Service requests\"",
-     *                 "value": "Service requests"
-     *               },
-     *               {
-     *                 "encodedValue": "Incidents",
-     *                 "value": "Incidents"
-     *               }
-     *             ]
-     *           },
-     *           "operator": "in"
-     *         }
-     *       }
-     *     },
-     *     {
-     *       "errors": [
-     *         "Error in the JQL Query: Expecting operator but got 'query'. The valid
-     * operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS'
-     * and 'IS NOT'. (line 1, character 9)"
-     *       ],
-     *       "query": "invalid query"
-     *     },
-     *     {
-     *       "errors": [
-     *         "The operator '=' is not supported by the 'summary' field."
-     *       ],
-     *       "query": "summary = test"
-     *     },
-     *     {
-     *       "errors": [
-     *         "Operator 'in' does not support the non-list value '\"test\"' for field
-     * 'summary'."
-     *       ],
-     *       "query": "summary in test"
-     *     },
-     *     {
-     *       "errors": [
-     *         "The value 'INVALID' does not exist for the field 'project'."
-     *       ],
-     *       "query": "project = INVALID"
-     *     },
-     *     {
-     *       "errors": [
-     *         "Field 'universe' does not exist or you do not have permission to view
-     * it."
-     *       ],
-     *       "query": "universe = 42"
-     *     }
-     *   ]
-     * }
-     * @path {POST} /rest/api/3/jql/parse
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira, validate:jql:jira, read:jql:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-parse-post
-     */
-    parseJqlQueries({ validation, jqlQueriesToParse, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/parse",
-            method: "POST",
-            query: {
-                validation,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: jqlQueriesToParse,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.parseJqlQueries.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Sanitizes one or more JQL queries by converting readable details into IDs where
-     * a user doesn't have permission to view the entity.
-     *
-     * For example, if the query contains the clause *project = 'Secret project'*, and
-     * a user does not have browse permission for the project "Secret project", the
-     * sanitized query replaces the clause with *project = 12345"* (where 12345 is the
-     * ID of the project). If a user has the required permission, the clause is not
-     * sanitized. If the account ID is null, sanitizing is performed for an anonymous
-     * user.
-     *
-     * Note that sanitization doesn't make the queries GDPR-compliant, because it
-     * doesn't remove user identifiers (username or user key). If you need to make
-     * queries GDPR-compliant, use [Convert user identifiers to account IDs in JQL
-     * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-rest-api-3-jql-sanitize-post).
-     *
-     * Before sanitization each JQL query is parsed. The queries are returned in the
-     * same order that they were passed.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "queries": [
-     *     {
-     *       "initialQuery": "project = 'Sample project'",
-     *       "sanitizedQuery": "project = 12345"
-     *     },
-     *     {
-     *       "initialQuery": "project = 'Sample project'",
-     *       "sanitizedQuery": "project = 'Sample project'",
-     *       "accountId": "5b10ac8d82e05b22cc7d4ef5"
-     *     },
-     *     {
-     *       "initialQuery": "project = 'Sample project'",
-     *       "sanitizedQuery": "project = 12345",
-     *       "accountId": "cda2aa1395ac195d951b3387"
-     *     },
-     *     {
-     *       "initialQuery": "non-parsable query",
-     *       "errors": {
-     *         "errorMessages": [
-     *           "Error in the JQL Query: Expecting operator but got 'query'. The
-     * valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN',
-     * 'IS' and 'IS NOT'. (line 1, character 9)"
-     *         ],
-     *         "errors": {}
-     *       },
-     *       "accountId": "5b10ac8d82e05b22cc7d4ef5"
-     *     }
-     *   ]
-     * }
-     * @path {POST} /rest/api/3/jql/sanitize
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:jql:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-sanitize-post
-     */
-    sanitiseJqlQueries({ jqlQueriesToSanitize, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/jql/sanitize",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: jqlQueriesToSanitize,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.sanitiseJqlQueries.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * 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.
+         *
+         * To filter visible field details by project or collapse non-unique fields by
+         * field type then [Get field reference data
+         * (POST)](#api-rest-api-3-jql-autocompletedata-post) can be used.
+         *
+         * This operation can be accessed anonymously.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "jqlReservedWords": [
+         *     "empty",
+         *     "and",
+         *     "or",
+         *     "in",
+         *     "distinct"
+         *   ],
+         *   "visibleFieldNames": [
+         *     {
+         *       "displayName": "summary",
+         *       "operators": [
+         *         "~",
+         *         "!~",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "orderable": "true",
+         *       "searchable": "true",
+         *       "types": [
+         *         "java.lang.String"
+         *       ],
+         *       "value": "summary"
+         *     },
+         *     {
+         *       "auto": "true",
+         *       "cfid": "cf[10880]",
+         *       "displayName": "Sprint - cf[10880]",
+         *       "operators": [
+         *         "=",
+         *         "!=",
+         *         "in",
+         *         "not in",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "orderable": "true",
+         *       "searchable": "true",
+         *       "types": [
+         *         "com.atlassian.greenhopper.service.sprint.Sprint"
+         *       ],
+         *       "value": "Sprint"
+         *     }
+         *   ],
+         *   "visibleFunctionNames": [
+         *     {
+         *       "displayName": "standardIssueTypes()",
+         *       "isList": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.issuetype.IssueType"
+         *       ],
+         *       "value": "standardIssueTypes()"
+         *     },
+         *     {
+         *       "displayName": "issuesWithText()",
+         *       "supportsListAndSingleValueOperators": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.issuetype.IssueType"
+         *       ],
+         *       "value": "issuesWithText()"
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/api/3/jql/autocompletedata
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-get
+         */
+        this.getAutoComplete = () => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/autocompletedata",
+                method: "GET",
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getAutoComplete.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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 filter the custom fields returned by project. Invalid
+         * project IDs in `projectIds` are ignored. System fields are always returned.
+         *
+         * It can also return the collapsed field for custom fields. Collapsed fields
+         * enable searches to be performed across all fields with the same name and of the
+         * same field type. For example, the collapsed field `Component -
+         * Component[Dropdown]` enables dropdown fields `Component - cf[10061]` and
+         * `Component - cf[10062]` to be searched simultaneously.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "jqlReservedWords": [
+         *     "empty",
+         *     "and",
+         *     "or",
+         *     "in",
+         *     "distinct"
+         *   ],
+         *   "visibleFieldNames": [
+         *     {
+         *       "displayName": "summary",
+         *       "operators": [
+         *         "~",
+         *         "!~",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "orderable": "true",
+         *       "searchable": "true",
+         *       "types": [
+         *         "java.lang.String"
+         *       ],
+         *       "value": "summary"
+         *     },
+         *     {
+         *       "auto": "true",
+         *       "cfid": "cf[10061]",
+         *       "displayName": "Component - cf[10061]",
+         *       "operators": [
+         *         "=",
+         *         "!=",
+         *         "in",
+         *         "not in",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "orderable": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.customfields.option.Option"
+         *       ],
+         *       "value": "cf[10061]"
+         *     },
+         *     {
+         *       "auto": "true",
+         *       "cfid": "cf[10062]",
+         *       "displayName": "Component - cf[10062]",
+         *       "operators": [
+         *         "=",
+         *         "!=",
+         *         "in",
+         *         "not in",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "orderable": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.customfields.option.Option"
+         *       ],
+         *       "value": "cf[10062]"
+         *     },
+         *     {
+         *       "auto": "true",
+         *       "displayName": "Component - Component[Dropdown]",
+         *       "operators": [
+         *         "=",
+         *         "!=",
+         *         "in",
+         *         "not in",
+         *         "is",
+         *         "is not"
+         *       ],
+         *       "searchable": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.customfields.option.Option"
+         *       ],
+         *       "value": "\"Component[Dropdown]\""
+         *     }
+         *   ],
+         *   "visibleFunctionNames": [
+         *     {
+         *       "displayName": "standardIssueTypes()",
+         *       "isList": "true",
+         *       "types": [
+         *         "com.atlassian.jira.issue.issuetype.IssueType"
+         *       ],
+         *       "value": "standardIssueTypes()"
+         *     }
+         *   ]
+         * }
+         * @path {POST} /rest/api/3/jql/autocompletedata
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-post
+         */
+        this.getAutoCompletePost = ({ searchAutoCompleteFilter, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/autocompletedata",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: searchAutoCompleteFilter,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getAutoCompletePost.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "results": [
+         *     {
+         *       "displayName": "<b>Ac</b>tiveObjects (AO)",
+         *       "value": "ActiveObjects"
+         *     },
+         *     {
+         *       "displayName": "Atlassian Connect (<b>AC</b>)",
+         *       "value": "Atlassian Connect"
+         *     },
+         *     {
+         *       "displayName": "Atlassian Connect in Jira (<b>AC</b>JIRA)",
+         *       "value": "Atlassian Connect in Jira"
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/api/3/jql/autocompletedata/suggestions
+         * @scopes-current read:jira-work
+         * @scopes-beta read:issue-details:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-autocompletedata-suggestions-get
+         */
+        this.getFieldAutoCompleteForQueryString = ({ fieldName, fieldValue, predicateName, predicateValue, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/autocompletedata/suggestions",
+                method: "GET",
+                query: {
+                    fieldName,
+                    fieldValue,
+                    predicateName,
+                    predicateValue,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.getFieldAutoCompleteForQueryString.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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.
+         *
+         * @returns Returned if the request is successful. Note that the JQL queries are returned
+         * in the same order that they were passed.
+         *
+         * example: {
+         *   "queriesWithUnknownUsers": [
+         *     {
+         *       "convertedQuery": "assignee = unknown",
+         *       "originalQuery": "assignee = mia"
+         *     }
+         *   ],
+         *   "queryStrings": [
+         *     "issuetype = Bug AND assignee in (abcde-12345) AND reporter in
+         * (abc551-c4e99) order by lastViewed DESC"
+         *   ]
+         * }
+         * @path {POST} /rest/api/3/jql/pdcleaner
+         * @scopes-current read:jira-user
+         * @scopes-beta read:user:jira, read:jql:jira, validate:jql:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-pdcleaner-post
+         */
+        this.migrateQueries = ({ jqlPersonalDataMigrationRequest, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/pdcleaner",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: jqlPersonalDataMigrationRequest,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.migrateQueries.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Parses and validates JQL queries.
+         *
+         * Validation is performed in context of the current user.
+         *
+         * This operation can be accessed anonymously.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "queries": [
+         *     {
+         *       "query": "summary ~ test AND (labels in (urgent, blocker) OR
+         * lastCommentedBy = currentUser()) AND status CHANGED AFTER -5d ORDER BY updated
+         * DESC",
+         *       "structure": {
+         *         "orderBy": {
+         *           "fields": [
+         *             {
+         *               "direction": "desc",
+         *               "field": {
+         *                 "encodedName": "updated",
+         *                 "name": "updated"
+         *               }
+         *             }
+         *           ]
+         *         },
+         *         "where": {
+         *           "clauses": [
+         *             {
+         *               "field": {
+         *                 "encodedName": "summary",
+         *                 "name": "summary"
+         *               },
+         *               "operand": {
+         *                 "encodedValue": "test",
+         *                 "value": "test"
+         *               },
+         *               "operator": "~"
+         *             },
+         *             {
+         *               "clauses": [
+         *                 {
+         *                   "field": {
+         *                     "encodedName": "labels",
+         *                     "name": "labels"
+         *                   },
+         *                   "operand": {
+         *                     "encodedOperand": "urgent, blocker)",
+         *                     "values": [
+         *                       {
+         *                         "encodedValue": "urgent",
+         *                         "value": "urgent"
+         *                       },
+         *                       {
+         *                         "encodedValue": "blocker",
+         *                         "value": "blocker"
+         *                       }
+         *                     ]
+         *                   },
+         *                   "operator": "in"
+         *                 },
+         *                 {
+         *                   "field": {
+         *                     "encodedName": "lastCommentedBy",
+         *                     "name": "lastCommentedBy",
+         *                     "property": [
+         *                       {
+         *                         "entity": "issue",
+         *                         "key": "propertyKey",
+         *                         "path": "path.in.property",
+         *                         "type": "user"
+         *                       }
+         *                     ]
+         *                   },
+         *                   "operand": {
+         *                     "arguments": [],
+         *                     "encodedOperand": "currentUser()",
+         *                     "function": "currentUser"
+         *                   },
+         *                   "operator": "="
+         *                 }
+         *               ],
+         *               "operator": "or"
+         *             },
+         *             {
+         *               "field": {
+         *                 "encodedName": "status",
+         *                 "name": "status"
+         *               },
+         *               "operator": "changed",
+         *               "predicates": [
+         *                 {
+         *                   "operand": {
+         *                     "arguments": [
+         *                       "-1M"
+         *                     ],
+         *                     "encodedOperand": "startOfMonth(-1M)",
+         *                     "function": "startOfMonth"
+         *                   },
+         *                   "operator": "after"
+         *                 }
+         *               ]
+         *             }
+         *           ],
+         *           "operator": "and"
+         *         }
+         *       }
+         *     },
+         *     {
+         *       "query": "issue.property[\"spaces here\"].value in (\"Service requests\",
+         * Incidents)",
+         *       "structure": {
+         *         "where": {
+         *           "field": {
+         *             "encodedName": "issue.property[\"spaces here\"].value",
+         *             "name": "issue.property[spaces here].value",
+         *             "property": [
+         *               {
+         *                 "entity": "issue",
+         *                 "key": "spaces here",
+         *                 "path": "value"
+         *               }
+         *             ]
+         *           },
+         *           "operand": {
+         *             "encodedOperand": "(\"Service requests\", Incidents)",
+         *             "values": [
+         *               {
+         *                 "encodedValue": "\"Service requests\"",
+         *                 "value": "Service requests"
+         *               },
+         *               {
+         *                 "encodedValue": "Incidents",
+         *                 "value": "Incidents"
+         *               }
+         *             ]
+         *           },
+         *           "operator": "in"
+         *         }
+         *       }
+         *     },
+         *     {
+         *       "errors": [
+         *         "Error in the JQL Query: Expecting operator but got 'query'. The valid
+         * operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS'
+         * and 'IS NOT'. (line 1, character 9)"
+         *       ],
+         *       "query": "invalid query"
+         *     },
+         *     {
+         *       "errors": [
+         *         "The operator '=' is not supported by the 'summary' field."
+         *       ],
+         *       "query": "summary = test"
+         *     },
+         *     {
+         *       "errors": [
+         *         "Operator 'in' does not support the non-list value '\"test\"' for field
+         * 'summary'."
+         *       ],
+         *       "query": "summary in test"
+         *     },
+         *     {
+         *       "errors": [
+         *         "The value 'INVALID' does not exist for the field 'project'."
+         *       ],
+         *       "query": "project = INVALID"
+         *     },
+         *     {
+         *       "errors": [
+         *         "Field 'universe' does not exist or you do not have permission to view
+         * it."
+         *       ],
+         *       "query": "universe = 42"
+         *     }
+         *   ]
+         * }
+         * @path {POST} /rest/api/3/jql/parse
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira, validate:jql:jira, read:jql:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-parse-post
+         */
+        this.parseJqlQueries = ({ validation, jqlQueriesToParse, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/parse",
+                method: "POST",
+                query: {
+                    validation,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: jqlQueriesToParse,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.parseJqlQueries.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Sanitizes one or more JQL queries by converting readable details into IDs where
+         * a user doesn't have permission to view the entity.
+         *
+         * For example, if the query contains the clause *project = 'Secret project'*, and
+         * a user does not have browse permission for the project "Secret project", the
+         * sanitized query replaces the clause with *project = 12345"* (where 12345 is the
+         * ID of the project). If a user has the required permission, the clause is not
+         * sanitized. If the account ID is null, sanitizing is performed for an anonymous
+         * user.
+         *
+         * Note that sanitization doesn't make the queries GDPR-compliant, because it
+         * doesn't remove user identifiers (username or user key). If you need to make
+         * queries GDPR-compliant, use [Convert user identifiers to account IDs in JQL
+         * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-rest-api-3-jql-sanitize-post).
+         *
+         * Before sanitization each JQL query is parsed. The queries are returned in the
+         * same order that they were passed.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "queries": [
+         *     {
+         *       "initialQuery": "project = 'Sample project'",
+         *       "sanitizedQuery": "project = 12345"
+         *     },
+         *     {
+         *       "initialQuery": "project = 'Sample project'",
+         *       "sanitizedQuery": "project = 'Sample project'",
+         *       "accountId": "5b10ac8d82e05b22cc7d4ef5"
+         *     },
+         *     {
+         *       "initialQuery": "project = 'Sample project'",
+         *       "sanitizedQuery": "project = 12345",
+         *       "accountId": "cda2aa1395ac195d951b3387"
+         *     },
+         *     {
+         *       "initialQuery": "non-parsable query",
+         *       "errors": {
+         *         "errorMessages": [
+         *           "Error in the JQL Query: Expecting operator but got 'query'. The
+         * valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN',
+         * 'IS' and 'IS NOT'. (line 1, character 9)"
+         *         ],
+         *         "errors": {}
+         *       },
+         *       "accountId": "5b10ac8d82e05b22cc7d4ef5"
+         *     }
+         *   ]
+         * }
+         * @path {POST} /rest/api/3/jql/sanitize
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:jql:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql#api-rest-api-3-jql-sanitize-post
+         */
+        this.sanitiseJqlQueries = ({ jqlQueriesToSanitize, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/jql/sanitize",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: jqlQueriesToSanitize,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("JqlService.sanitiseJqlQueries.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("JqlService.getAutoComplete.response", zod_1.z