/** * 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 { FilterSubscriptionsList, SharePermission, User, UserList } from './'; /** * Details about a filter. * @export * @interface Filter */ export interface Filter { /** * A description of the filter. * @type {string} * @memberof Filter */ description?: string; /** * The name of the filter. Must be unique. * @type {string} * @memberof Filter */ name: string; /** * The groups and projects that the filter is shared with. * @type {Array} * @memberof Filter */ sharePermissions?: Array; /** * The count of how many users have selected this filter as a favorite, including the filter owner. * @type {number} * @memberof Filter */ readonly favouritedCount?: number; /** * The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. * @type {string} * @memberof Filter */ jql?: string; /** * The unique identifier for the filter. * @type {string} * @memberof Filter */ readonly id?: string; /** * The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings. * @type {User} * @memberof Filter */ readonly owner?: User; /** * A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter\'s JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*. * @type {string} * @memberof Filter */ readonly searchUrl?: string; /** * A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*. * @type {string} * @memberof Filter */ readonly viewUrl?: string; /** * Indicates whether the filter is selected as a favorite. * @type {boolean} * @memberof Filter */ favourite?: boolean; /** * A paginated list of the users that are subscribed to the filter. * @type {FilterSubscriptionsList} * @memberof Filter */ readonly subscriptions?: FilterSubscriptionsList; /** * A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with. * @type {UserList} * @memberof Filter */ readonly sharedUsers?: UserList; /** * The URL of the filter. * @type {string} * @memberof Filter */ readonly self?: string; } export declare function FilterFromJSON(json: any): Filter; export declare function FilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): Filter; export declare function FilterToJSON(value?: Filter): any;