/**
 * 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 { ColumnItem, Filter, PageBeanFoundFilter } from '../models';
export interface CreateFilterRequest {
    Filter: Filter;
    expand?: string;
}
export interface DeleteFavouriteForFilterRequest {
    id: number;
    expand?: string;
}
export interface DeleteFilterRequest {
    id: number;
}
export interface GetColumnsRequest {
    id: number;
}
export interface GetFavouriteFiltersRequest {
    expand?: string;
}
export interface GetFilterRequest {
    id: number;
    expand?: string;
}
export interface GetFiltersRequest {
    expand?: string;
}
export interface GetFiltersPaginatedRequest {
    filterName?: string;
    accountId?: string;
    owner?: string;
    groupname?: string;
    projectId?: number;
    orderBy?: string;
    startAt?: number;
    maxResults?: number;
    expand?: string;
}
export interface GetMyFiltersRequest {
    expand?: string;
    includeFavourites?: boolean;
}
export interface ResetColumnsRequest {
    id: number;
}
export interface SetColumnsRequest {
    id: number;
}
export interface SetFavouriteForFilterRequest {
    id: number;
    expand?: string;
}
export interface UpdateFilterRequest {
    id: number;
    Filter: Filter;
    expand?: string;
}
/**
 * no description
 */
export declare class FiltersApi extends runtime.BaseAPI {
    /**
     * Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Create filter
     */
    createFilterRaw(requestParameters: CreateFilterRequest): Promise<runtime.ApiResponse<Filter>>;
    /**
     * Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Create filter
     */
    createFilter(requestParameters: CreateFilterRequest): Promise<Filter>;
    /**
     * Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user\'s favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Remove filter as favorite
     */
    deleteFavouriteForFilterRaw(requestParameters: DeleteFavouriteForFilterRequest): Promise<runtime.ApiResponse<Filter>>;
    /**
     * Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user\'s favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.  **[Permissions](#permissions) required:** Permission to access Jira.
     * Remove filter as favorite
     */
    deleteFavouriteForFilter(requestParameters: DeleteFavouriteForFilterRequest): Promise<Filter>;
    /**
     * Delete a filter.  **[Permissions](#permissions) required:** Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * Delete filter
     */
    deleteFilterRaw(requestParameters: DeleteFilterRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete a filter.  **[Permissions](#permissions) required:** Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
     * Delete filter
     */
    deleteFilter(requestParameters: DeleteFilterRequest): Promise<void>;
    /**
     * Returns the columns configured for a filter. The column configuration is used when the filter\'s results are viewed in *List View* with the *Columns* set to *Filter*.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, column details are only returned for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Get columns
     */
    getColumnsRaw(requestParameters: GetColumnsRequest): Promise<runtime.ApiResponse<Array<ColumnItem>>>;
    /**
     * Returns the columns configured for a filter. The column configuration is used when the filter\'s results are viewed in *List View* with the *Columns* set to *Filter*.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, column details are only returned for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Get columns
     */
    getColumns(requestParameters: GetColumnsRequest): Promise<Array<ColumnItem>>;
    /**
     * Returns the visible favorite filters of the user.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
     * Get favorite filters
     */
    getFavouriteFiltersRaw(requestParameters: GetFavouriteFiltersRequest): Promise<runtime.ApiResponse<Array<Filter>>>;
    /**
     * Returns the visible favorite filters of the user.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
     * Get favorite filters
     */
    getFavouriteFilters(requestParameters: GetFavouriteFiltersRequest): Promise<Array<Filter>>;
    /**
     * Returns a filter.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, the filter is only returned where it is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.
     * Get filter
     */
    getFilterRaw(requestParameters: GetFilterRequest): Promise<runtime.ApiResponse<Filter>>;
    /**
     * Returns a filter.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, the filter is only returned where it is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.
     * Get filter
     */
    getFilter(requestParameters: GetFilterRequest): Promise<Filter>;
    /**
     * Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-3-filter-search-get) that supports search and pagination.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, only the following filters are returned:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Get filters
     */
    getFiltersRaw(requestParameters: GetFiltersRequest): Promise<runtime.ApiResponse<Array<Filter>>>;
    /**
     * Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-3-filter-search-get) that supports search and pagination.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, only the following filters are returned:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Get filters
     */
    getFilters(requestParameters: GetFiltersRequest): Promise<Array<Filter>>;
    /**
     * Searches for filters. This operation is similar to [Get filters](#api-rest-api-3-filter-get) except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, only the following filters that match the query parameters are returned:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Search for filters
     */
    getFiltersPaginatedRaw(requestParameters: GetFiltersPaginatedRequest): Promise<runtime.ApiResponse<PageBeanFoundFilter>>;
    /**
     * Searches for filters. This operation is similar to [Get filters](#api-rest-api-3-filter-get) except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:** None, however, only the following filters that match the query parameters are returned:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Search for filters
     */
    getFiltersPaginated(requestParameters: GetFiltersPaginatedRequest): Promise<PageBeanFoundFilter>;
    /**
     * Returns the filters owned by the user. If `includeFavourites` is `true`, the user\'s visible favorite filters are also returned.  **[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
     * Get my filters
     */
    getMyFiltersRaw(requestParameters: GetMyFiltersRequest): Promise<runtime.ApiResponse<Array<Filter>>>;
    /**
     * Returns the filters owned by the user. If `includeFavourites` is `true`, the user\'s visible favorite filters are also returned.  **[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:   *  owned by the user.  *  shared with a group that the user is a member of.  *  shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  shared with a public project.  *  shared with the public.  For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
     * Get my filters
     */
    getMyFilters(requestParameters: GetMyFiltersRequest): Promise<Array<Filter>>;
    /**
     * Reset the user\'s column configuration for the filter to the default.  **[Permissions](#permissions) required:** Permission to access Jira, however, columns are only reset for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Reset columns
     */
    resetColumnsRaw(requestParameters: ResetColumnsRequest): Promise<runtime.ApiResponse<void>>;
    /**
     * Reset the user\'s column configuration for the filter to the default.  **[Permissions](#permissions) required:** Permission to access Jira, however, columns are only reset for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Reset columns
     */
    resetColumns(requestParameters: ResetColumnsRequest): Promise<void>;
    /**
     * Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.  The parameters for this resource are expressed as HTML form data. For example, in curl:  `curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`  **[Permissions](#permissions) required:** Permission to access Jira, however, columns are only set for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Set columns
     */
    setColumnsRaw(requestParameters: SetColumnsRequest): Promise<runtime.ApiResponse<object>>;
    /**
     * Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.  The parameters for this resource are expressed as HTML form data. For example, in curl:  `curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`  **[Permissions](#permissions) required:** Permission to access Jira, however, columns are only set for:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Set columns
     */
    setColumns(requestParameters: SetColumnsRequest): Promise<object>;
    /**
     * Add a filter as a favorite for the user.  **[Permissions](#permissions) required:** Permission to access Jira, however, the user can only favorite:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Add filter as favorite
     */
    setFavouriteForFilterRaw(requestParameters: SetFavouriteForFilterRequest): Promise<runtime.ApiResponse<Filter>>;
    /**
     * Add a filter as a favorite for the user.  **[Permissions](#permissions) required:** Permission to access Jira, however, the user can only favorite:   *  filters owned by the user.  *  filters shared with a group that the user is a member of.  *  filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.  *  filters shared with a public project.  *  filters shared with the public.
     * Add filter as favorite
     */
    setFavouriteForFilter(requestParameters: SetFavouriteForFilterRequest): Promise<Filter>;
    /**
     * Updates a filter. Use this operation to update a filter\'s name, description, JQL, or sharing.  **[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter.
     * Update filter
     */
    updateFilterRaw(requestParameters: UpdateFilterRequest): Promise<runtime.ApiResponse<Filter>>;
    /**
     * Updates a filter. Use this operation to update a filter\'s name, description, JQL, or sharing.  **[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter.
     * Update filter
     */
    updateFilter(requestParameters: UpdateFilterRequest): Promise<Filter>;
}