/** * 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 { CustomFieldDefinitionJsonBean, CustomFieldOption, FieldDeprecated, PageBeanField } from '../models'; export interface CreateCustomFieldRequest { CustomFieldDefinitionJsonBean: CustomFieldDefinitionJsonBean; } export interface GetCustomFieldOptionRequest { id: string; } export interface GetFieldsPaginatedRequest { startAt?: number; maxResults?: number; isCustom?: boolean; expand?: string; } /** * no description */ export declare class IssueFieldsApi extends runtime.BaseAPI { /** * Creates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create custom field */ createCustomFieldRaw(requestParameters: CreateCustomFieldRequest): Promise>; /** * Creates a custom field. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create custom field */ createCustomField(requestParameters: CreateCustomFieldRequest): Promise; /** * Returns a custom field option. For example, an option in a cascading select list. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get custom field option */ getCustomFieldOptionRaw(requestParameters: GetCustomFieldOptionRequest): Promise>; /** * Returns a custom field option. For example, an option in a cascading select list. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get custom field option */ getCustomFieldOption(requestParameters: GetCustomFieldOptionRequest): Promise; /** * Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue navigator are always returned. * Fields that cannot be placed on an issue screen are always returned. * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.) This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get fields */ getFieldsRaw(): Promise>>; /** * Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue navigator are always returned. * Fields that cannot be placed on an issue screen are always returned. * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.) This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get fields */ getFields(): Promise>; /** * Returns a [paginated](#pagination) list of fields for Classic Jira projects. Only custom fields can be queried, `isCustom` must be set to `true`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get fields paginated */ getFieldsPaginatedRaw(requestParameters: GetFieldsPaginatedRequest): Promise>; /** * Returns a [paginated](#pagination) list of fields for Classic Jira projects. Only custom fields can be queried, `isCustom` must be set to `true`. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get fields paginated */ getFieldsPaginated(requestParameters: GetFieldsPaginatedRequest): Promise; }