/** * 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 { IssueFieldOption, PageBeanIssueFieldOption } from '../models'; export interface CreateIssueFieldOptionRequest { fieldKey: string; request_body: { [key: string]: object; }; } export interface DeleteIssueFieldOptionRequest { fieldKey: string; optionId: number; } export interface GetAllIssueFieldOptionsRequest { fieldKey: string; startAt?: number; maxResults?: number; } export interface GetIssueFieldOptionRequest { fieldKey: string; optionId: number; } export interface GetSelectableIssueFieldOptionsRequest { fieldKey: string; startAt?: number; maxResults?: number; projectId?: number; } export interface GetVisibleIssueFieldOptionsRequest { fieldKey: string; startAt?: number; maxResults?: number; projectId?: number; } export interface ReplaceIssueFieldOptionRequest { fieldKey: string; optionId: number; replaceWith?: number; jql?: string; } export interface UpdateIssueFieldOptionRequest { fieldKey: string; optionId: number; IssueFieldOption: IssueFieldOption; } /** * no description */ export declare class IssueFieldOptionsApi extends runtime.BaseAPI { /** * Creates an option for a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Create issue field option */ createIssueFieldOptionRaw(requestParameters: CreateIssueFieldOptionRequest): Promise>; /** * Creates an option for a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Create issue field option */ createIssueFieldOption(requestParameters: CreateIssueFieldOptionRequest): Promise; /** * Deletes an option from a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Delete issue field option */ deleteIssueFieldOptionRaw(requestParameters: DeleteIssueFieldOptionRequest): Promise>; /** * Deletes an option from a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Delete issue field option */ deleteIssueFieldOption(requestParameters: DeleteIssueFieldOptionRequest): Promise; /** * Returns all options defined for a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that allows a user to select n value from a list of options. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Get all issue field options */ getAllIssueFieldOptionsRaw(requestParameters: GetAllIssueFieldOptionsRequest): Promise>; /** * Returns all options defined for a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that allows a user to select n value from a list of options. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Get all issue field options */ getAllIssueFieldOptions(requestParameters: GetAllIssueFieldOptionsRequest): Promise; /** * Returns an option from a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Get issue field option */ getIssueFieldOptionRaw(requestParameters: GetIssueFieldOptionRequest): Promise>; /** * Returns an option from a select list issue field. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Get issue field option */ getIssueFieldOption(requestParameters: GetIssueFieldOptionRequest): Promise; /** * Returns options defined for a select list issue field that can be viewed and selected by the user. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** Permission to access Jira. * Get selectable issue field options */ getSelectableIssueFieldOptionsRaw(requestParameters: GetSelectableIssueFieldOptionsRequest): Promise>; /** * Returns options defined for a select list issue field that can be viewed and selected by the user. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** Permission to access Jira. * Get selectable issue field options */ getSelectableIssueFieldOptions(requestParameters: GetSelectableIssueFieldOptionsRequest): Promise; /** * Returns options defined for a select list issue field that can be viewed by the user. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** Permission to access Jira. * Get visible issue field options */ getVisibleIssueFieldOptionsRaw(requestParameters: GetVisibleIssueFieldOptionsRequest): Promise>; /** * Returns options defined for a select list issue field that can be viewed by the user. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** Permission to access Jira. * Get visible issue field options */ getVisibleIssueFieldOptions(requestParameters: GetVisibleIssueFieldOptionsRequest): Promise; /** * Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an [asynchronous operation](#async). The response object contains a link to the long-running task. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Replace issue field option */ replaceIssueFieldOptionRaw(requestParameters: ReplaceIssueFieldOptionRequest): Promise>; /** * Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an [asynchronous operation](#async). The response object contains a link to the long-running task. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Replace issue field option */ replaceIssueFieldOption(requestParameters: ReplaceIssueFieldOptionRequest): Promise; /** * Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Update issue field option */ updateIssueFieldOptionRaw(requestParameters: UpdateIssueFieldOptionRequest): Promise>; /** * Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical. Note that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field. * Update issue field option */ updateIssueFieldOption(requestParameters: UpdateIssueFieldOptionRequest): Promise; }