/** * 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 { DefaultShareScope, SharePermission, SharePermissionInputBean } from '../models'; export interface AddSharePermissionRequest { id: number; SharePermissionInputBean: SharePermissionInputBean; } export interface DeleteSharePermissionRequest { id: number; permissionId: number; } export interface GetSharePermissionRequest { id: number; permissionId: number; } export interface GetSharePermissionsRequest { id: number; } export interface SetDefaultShareScopeRequest { DefaultShareScope: DefaultShareScope; } /** * no description */ export declare class FilterSharingApi extends runtime.BaseAPI { /** * Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter. Be aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put). **[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter. * Add share permission */ addSharePermissionRaw(requestParameters: AddSharePermissionRequest): Promise>>; /** * Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter. Be aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put). **[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter. * Add share permission */ addSharePermission(requestParameters: AddSharePermissionRequest): Promise>; /** * Deletes a share permission from a filter. **[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter. * Delete share permission */ deleteSharePermissionRaw(requestParameters: DeleteSharePermissionRequest): Promise>; /** * Deletes a share permission from a filter. **[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter. * Delete share permission */ deleteSharePermission(requestParameters: DeleteSharePermissionRequest): Promise; /** * Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. * Get default share scope */ getDefaultShareScopeRaw(): Promise>; /** * Returns the default sharing settings for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. * Get default share scope */ getDefaultShareScope(): Promise; /** * Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None, however, a share permission is 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 share permission */ getSharePermissionRaw(requestParameters: GetSharePermissionRequest): Promise>; /** * Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None, however, a share permission is 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 share permission */ getSharePermission(requestParameters: GetSharePermissionRequest): Promise; /** * Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None, however, share permissions 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 share permissions */ getSharePermissionsRaw(requestParameters: GetSharePermissionsRequest): Promise>>; /** * Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None, however, share permissions 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 share permissions */ getSharePermissions(requestParameters: GetSharePermissionsRequest): Promise>; /** * Sets the default sharing for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. * Set default share scope */ setDefaultShareScopeRaw(requestParameters: SetDefaultShareScopeRequest): Promise>; /** * Sets the default sharing for new filters and dashboards for a user. **[Permissions](#permissions) required:** Permission to access Jira. * Set default share scope */ setDefaultShareScope(requestParameters: SetDefaultShareScopeRequest): Promise; }