/**
 * 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 { FoundUsers, PageBeanUser, PageBeanUserKey, User } from '../models';
export interface FindAssignableUsersRequest {
    query?: string;
    sessionId?: string;
    username?: string;
    accountId?: string;
    project?: string;
    issueKey?: string;
    startAt?: number;
    maxResults?: number;
    actionDescriptorId?: number;
}
export interface FindBulkAssignableUsersRequest {
    projectKeys: string;
    query?: string;
    username?: string;
    accountId?: string;
    startAt?: number;
    maxResults?: number;
}
export interface FindUserKeysByQueryRequest {
    query: string;
    startAt?: number;
    maxResults?: number;
}
export interface FindUsersRequest {
    query?: string;
    username?: string;
    accountId?: string;
    startAt?: number;
    maxResults?: number;
    property?: string;
}
export interface FindUsersByQueryRequest {
    query: string;
    startAt?: number;
    maxResults?: number;
}
export interface FindUsersForPickerRequest {
    query: string;
    maxResults?: number;
    showAvatar?: boolean;
    exclude?: Array<string>;
    excludeAccountIds?: Array<string>;
    avatarSize?: string;
    excludeConnectUsers?: boolean;
}
export interface FindUsersWithAllPermissionsRequest {
    permissions: string;
    query?: string;
    username?: string;
    accountId?: string;
    issueKey?: string;
    projectKey?: string;
    startAt?: number;
    maxResults?: number;
}
export interface FindUsersWithBrowsePermissionRequest {
    query?: string;
    username?: string;
    accountId?: string;
    issueKey?: string;
    projectKey?: string;
    startAt?: number;
    maxResults?: number;
}
/**
 * no description
 */
export declare class UserSearchApi extends runtime.BaseAPI {
    /**
     * Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:   *  a new issue, by providing the `projectKeyOrId`.  *  an updated issue, by providing the `issueKey`.  *  to an issue during a transition (workflow action), by providing the `issueKey` and the transition id in `actionDescriptorId`. You can obtain the IDs of an issue\'s valid transitions using the `transitions` option in the `expand` parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).  In all these cases, you can pass an accountId to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Find users assignable to issues
     */
    findAssignableUsersRaw(requestParameters: FindAssignableUsersRequest): Promise<runtime.ApiResponse<Array<User>>>;
    /**
     * Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:   *  a new issue, by providing the `projectKeyOrId`.  *  an updated issue, by providing the `issueKey`.  *  to an issue during a transition (workflow action), by providing the `issueKey` and the transition id in `actionDescriptorId`. You can obtain the IDs of an issue\'s valid transitions using the `transitions` option in the `expand` parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).  In all these cases, you can pass an accountId to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Find users assignable to issues
     */
    findAssignableUsers(requestParameters: FindAssignableUsersRequest): Promise<Array<User>>;
    /**
     * Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None.
     * Find users assignable to projects
     */
    findBulkAssignableUsersRaw(requestParameters: FindBulkAssignableUsersRequest): Promise<runtime.ApiResponse<Array<User>>>;
    /**
     * Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None.
     * Find users assignable to projects
     */
    findBulkAssignableUsers(requestParameters: FindBulkAssignableUsersRequest): Promise<Array<User>>;
    /**
     * Finds users with a structured query and returns a list of user keys.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).  The query statements are:   *  `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.  *  `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.  *  `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.  *  `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.  *  `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.  *  `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.  *  `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.  *  `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.  The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:  `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`
     * Find user keys by query
     */
    findUserKeysByQueryRaw(requestParameters: FindUserKeysByQueryRequest): Promise<runtime.ApiResponse<PageBeanUserKey>>;
    /**
     * Finds users with a structured query and returns a list of user keys.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).  The query statements are:   *  `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.  *  `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.  *  `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.  *  `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.  *  `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.  *  `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.  *  `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.  *  `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.  The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:  `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`
     * Find user keys by query
     */
    findUserKeysByQuery(requestParameters: FindUserKeysByQueryRequest): Promise<PageBeanUserKey>;
    /**
     * Returns a list of users that match the provided search string and property.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.  **Note:** This API is designed to return a small number of users with a flexible search query. As such, the sum of `startAt` and `maxResults` must be less than 1000. If the sum is greater, only results up to the 1000th result will be returned. If you wish to get a larger number of users, please use the get-all-users API (`/rest/api/3/users/search`) instead.
     * Find users
     */
    findUsersRaw(requestParameters: FindUsersRequest): Promise<runtime.ApiResponse<Array<User>>>;
    /**
     * Returns a list of users that match the provided search string and property.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.  **Note:** This API is designed to return a small number of users with a flexible search query. As such, the sum of `startAt` and `maxResults` must be less than 1000. If the sum is greater, only results up to the 1000th result will be returned. If you wish to get a larger number of users, please use the get-all-users API (`/rest/api/3/users/search`) instead.
     * Find users
     */
    findUsers(requestParameters: FindUsersRequest): Promise<Array<User>>;
    /**
     * Finds users with a structured query and returns user details.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).  The query statements are:   *  `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.  *  `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.  *  `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.  *  `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.  *  `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.  *  `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.  *  `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.  *  `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.  The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:  `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`
     * Find users by query
     */
    findUsersByQueryRaw(requestParameters: FindUsersByQueryRequest): Promise<runtime.ApiResponse<PageBeanUser>>;
    /**
     * Finds users with a structured query and returns user details.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).  The query statements are:   *  `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.  *  `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.  *  `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.  *  `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.  *  `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.  *  `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.  *  `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.  *  `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.  The list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:  `is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`
     * Find users by query
     */
    findUsersByQuery(requestParameters: FindUsersByQueryRequest): Promise<PageBeanUser>;
    /**
     * Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.
     * Find users for picker
     */
    findUsersForPickerRaw(requestParameters: FindUsersForPickerRequest): Promise<runtime.ApiResponse<FoundUsers>>;
    /**
     * Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.
     * Find users for picker
     */
    findUsersForPicker(requestParameters: FindUsersForPickerRequest): Promise<FoundUsers>;
    /**
     * Returns a list of users who fulfill these criteria:   *  their user attributes match a search string.  *  they have a set of permissions for a project or issue.  If no search string is provided, a list of all users with the permissions is returned.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:**   *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project.  *  *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project.
     * Find users with permissions
     */
    findUsersWithAllPermissionsRaw(requestParameters: FindUsersWithAllPermissionsRequest): Promise<runtime.ApiResponse<Array<User>>>;
    /**
     * Returns a list of users who fulfill these criteria:   *  their user attributes match a search string.  *  they have a set of permissions for a project or issue.  If no search string is provided, a list of all users with the permissions is returned.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:**   *  *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project.  *  *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project.
     * Find users with permissions
     */
    findUsersWithAllPermissions(requestParameters: FindUsersWithAllPermissionsRequest): Promise<Array<User>>;
    /**
     * Returns a list of users who fulfill these criteria:   *  their user attributes match a search string.  *  they have permission to browse issues.  Use this resource to find users who can browse:   *  an issue, by providing the `issueKey`.  *  any issue in a project, by providing the `projectKey`.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results.
     * Find users with browse permission
     */
    findUsersWithBrowsePermissionRaw(requestParameters: FindUsersWithBrowsePermissionRequest): Promise<runtime.ApiResponse<Array<User>>>;
    /**
     * Returns a list of users who fulfill these criteria:   *  their user attributes match a search string.  *  they have permission to browse issues.  Use this resource to find users who can browse:   *  an issue, by providing the `issueKey`.  *  any issue in a project, by providing the `projectKey`.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results.
     * Find users with browse permission
     */
    findUsersWithBrowsePermission(requestParameters: FindUsersWithBrowsePermissionRequest): Promise<Array<User>>;
}