/** * 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 { AddFieldBean, MoveFieldBean, PageBeanScreen, ScreenableField, ScreenableTab } from '../models'; export interface AddFieldToDefaultScreenRequest { fieldId: string; } export interface AddScreenTabRequest { screenId: number; ScreenableTab: ScreenableTab; } export interface AddScreenTabFieldRequest { screenId: number; tabId: number; AddFieldBean: AddFieldBean; } export interface DeleteScreenTabRequest { screenId: number; tabId: number; } export interface GetAllScreenTabFieldsRequest { screenId: number; tabId: number; projectKey?: string; } export interface GetAllScreenTabsRequest { screenId: number; projectKey?: string; } export interface GetAllScreensRequest { startAt?: number; maxResults?: number; } export interface GetAvailableScreenFieldsRequest { screenId: number; } export interface MoveScreenTabRequest { screenId: number; tabId: number; pos: number; } export interface MoveScreenTabFieldRequest { screenId: number; tabId: number; id: string; MoveFieldBean: MoveFieldBean; } export interface RemoveScreenTabFieldRequest { screenId: number; tabId: number; id: string; } export interface RenameScreenTabRequest { screenId: number; tabId: number; ScreenableTab: ScreenableTab; } /** * no description */ export declare class ScreensApi extends runtime.BaseAPI { /** * Adds a field to the default tab of the default screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Add field to default screen */ addFieldToDefaultScreenRaw(requestParameters: AddFieldToDefaultScreenRequest): Promise>; /** * Adds a field to the default tab of the default screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Add field to default screen */ addFieldToDefaultScreen(requestParameters: AddFieldToDefaultScreenRequest): Promise; /** * Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create screen tab */ addScreenTabRaw(requestParameters: AddScreenTabRequest): Promise>; /** * Creates a tab for a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create screen tab */ addScreenTab(requestParameters: AddScreenTabRequest): Promise; /** * Adds a field to a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Add screen tab field */ addScreenTabFieldRaw(requestParameters: AddScreenTabFieldRequest): Promise>; /** * Adds a field to a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Add screen tab field */ addScreenTabField(requestParameters: AddScreenTabFieldRequest): Promise; /** * Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete screen tab */ deleteScreenTabRaw(requestParameters: DeleteScreenTabRequest): Promise>; /** * Deletes a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete screen tab */ deleteScreenTab(requestParameters: DeleteScreenTabRequest): Promise; /** * Returns all fields for a screen tab. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. * Get all screen tab fields */ getAllScreenTabFieldsRaw(requestParameters: GetAllScreenTabFieldsRequest): Promise>>; /** * Returns all fields for a screen tab. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. * Get all screen tab fields */ getAllScreenTabFields(requestParameters: GetAllScreenTabFieldsRequest): Promise>; /** * Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. * Get all screen tabs */ getAllScreenTabsRaw(requestParameters: GetAllScreenTabsRequest): Promise>>; /** * Returns the list of tabs for a screen. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme. * Get all screen tabs */ getAllScreenTabs(requestParameters: GetAllScreenTabsRequest): Promise>; /** * Returns all screens. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get all screens */ getAllScreensRaw(requestParameters: GetAllScreensRequest): Promise>; /** * Returns all screens. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get all screens */ getAllScreens(requestParameters: GetAllScreensRequest): Promise; /** * Returns the fields that can be added to a tab on a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get available screen fields */ getAvailableScreenFieldsRaw(requestParameters: GetAvailableScreenFieldsRequest): Promise>>; /** * Returns the fields that can be added to a tab on a screen. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get available screen fields */ getAvailableScreenFields(requestParameters: GetAvailableScreenFieldsRequest): Promise>; /** * Moves a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Move screen tab */ moveScreenTabRaw(requestParameters: MoveScreenTabRequest): Promise>; /** * Moves a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Move screen tab */ moveScreenTab(requestParameters: MoveScreenTabRequest): Promise; /** * Moves a screen tab field. If `after` and `position` are provided in the request, `position` is ignored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Move screen tab field */ moveScreenTabFieldRaw(requestParameters: MoveScreenTabFieldRequest): Promise>; /** * Moves a screen tab field. If `after` and `position` are provided in the request, `position` is ignored. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Move screen tab field */ moveScreenTabField(requestParameters: MoveScreenTabFieldRequest): Promise; /** * Removes a field from a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Remove screen tab field */ removeScreenTabFieldRaw(requestParameters: RemoveScreenTabFieldRequest): Promise>; /** * Removes a field from a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Remove screen tab field */ removeScreenTabField(requestParameters: RemoveScreenTabFieldRequest): Promise; /** * Updates the name of a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update screen tab */ renameScreenTabRaw(requestParameters: RenameScreenTabRequest): Promise>; /** * Updates the name of a screen tab. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update screen tab */ renameScreenTab(requestParameters: RenameScreenTabRequest): Promise; }