///
import { Issue } from "./types/issue";
import { IssueHelper } from "./helper/issue";
import { ManagedIssue } from "./common";
import { Dashboard } from "./types/dashboard";
import { Application } from "./types/application";
import { User } from "./types/user";
import { Instance } from "./types/instance";
import { Project } from "./types/project";
import { Filter } from "./types/filter";
import { Group } from "./types/group";
import { GroupAndUserPicker } from "./types/groupAndUserPicker";
import { Jql } from "./types/jql";
import { Label } from "./types/label";
import { Permission } from "./types/permission";
import { Myself } from "./types/myself";
import { Workflow } from "./types/workflow";
import { Screen } from "./types/screen";
import { Avatar } from "./types/avatar";
import { BuildersGroup } from "./common";
import { AssistedErrorStrategyFunction, AssistedErrorStrategyOption, ErrorStrategyHandlers } from "./handled-api/common";
interface ConnectionOptions extends AssistedErrorStrategyOption {
}
export declare namespace JiraCloudConnection {
function connect(connection: string, options?: ConnectionOptions): JiraCloudInstance;
}
export declare class JiraCloudInstance {
Builders: BuildersGroup;
protected issueHelper: IssueHelper;
All: AllGroup;
private connection;
Issue: IssueGroup;
Dashboard: DashboardGroup;
Application: ApplicationGroup;
User: UserGroup;
Instance: InstanceGroup;
Project: ProjectGroup;
Filter: FilterGroup;
Group: GroupGroup;
GroupAndUserPicker: GroupAndUserPickerGroup;
Jql: JqlGroup;
Label: LabelGroup;
Permission: PermissionGroup;
Myself: MyselfGroup;
Workflow: WorkflowGroup;
Screen: ScreenGroup;
Avatar: AvatarGroup;
constructor(connection: string, options?: ConnectionOptions);
/**
* Performs fetch call using managed connection.
*/
fetch(url: string, options?: RequestInit): Promise>;
/**
* Set global error strategy.
*/
setGlobalErrorStrategy(errorStrategy?: ErrorStrategyHandlers | AssistedErrorStrategyFunction | null): void;
}
declare class BaseGroup {
protected connection: string;
protected options: ConnectionOptions;
constructor(connection: string, options: ConnectionOptions);
protected getBuildOptions(options: any): any;
}
declare class IssueGroup extends BaseGroup {
private issueHelper;
Type: IssueTypeGroup;
Field: IssueFieldGroup;
Worklog: IssueWorklogGroup;
Attachment: IssueAttachmentGroup;
Comment: IssueCommentGroup;
Metadata: IssueMetadataGroup;
Property: IssuePropertyGroup;
Link: IssueLinkGroup;
Transition: IssueTransitionGroup;
Vote: IssueVoteGroup;
Watcher: IssueWatcherGroup;
Search: IssueSearchGroup;
Priority: IssuePriorityGroup;
Resolution: IssueResolutionGroup;
Security: IssueSecurityGroup;
Notification: IssueNotificationGroup;
Navigator: IssueNavigatorGroup;
constructor(connection: string, options: ConnectionOptions, issueHelper: IssueHelper);
/**
* Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.
The content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issue's create screen. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
* `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* `parent` must contain the ID or key of the parent issue.
In a next-gen project any issue may be made a child providing that the parent and child are members of the same project. In a classic project the parent field is only valid for subtasks.
**[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-post
* @param options Request options.
*/
createIssue(options: Issue.CreateIssue.Options): Promise;
/**
* Creates issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.
The content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issues' create screens. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
* `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
* `parent` the must contain the ID or key of the parent issue.
**[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which each issue or subtask is created.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-bulk-post
* @param options Request options.
*/
createIssues(options: Issue.CreateIssues.Options): Promise;
/**
* Returns the details for an issue.
The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-get
* @param options Request options.
*/
getIssue(options: Issue.GetIssue.Options): Promise;
/**
* Edits an issue. A transition may be applied and issue properties updated as part of the edit.
The edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting `update.parent.set.none` to *true*. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.
Connect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-put
* @param options Request options.
*/
editIssue(options: Issue.EditIssue.Options): Promise;
/**
* Deletes an issue.
An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be deleted with the issue.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-delete
* @param options Request options.
*/
deleteIssue(options: Issue.DeleteIssue.Options): Promise;
/**
* Assigns an issue to a user. Use this operation when the calling user does not have the *Edit Issues* permission but has the *Assign issue* permission for the project that the issue is in.
If `name` or `accountId` is set to:
* `"-1"`, the issue is assigned to the default assignee for the project.
* `null`, the issue is set to unassigned.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-assignee-put
* @param options Request options.
*/
assignIssue(options: Issue.AssignIssue.Options): Promise;
/**
* Returns a [paginated](#pagination) list of all changelogs for an issue sorted by date, starting from the oldest.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-changelog-get
* @param options Request options.
*/
getChangeLogs(options: Issue.GetChangeLogs.Options): Promise;
/**
* Returns changelogs for an issue specified by a list of changelog IDs.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-changelog-list-post
* @param options Request options.
*/
getChangeLogsById(options: Issue.GetChangeLogsById.Options): Promise;
/**
* Creates an email notification for an issue and adds it to the mail queue.
**[Permissions](#permissions) required:**
* *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-notify-post
* @param options Request options.
*/
sendNotification(options: Issue.SendNotification.Options): Promise;
}
declare class IssueTypeGroup extends BaseGroup {
Screen: IssueTypeScreenGroup;
Property: IssueTypePropertyGroup;
Scheme: IssueTypeSchemeGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Returns all issue types.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Issue types are only returned as follows:
* if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned.
* if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-get
* @param options Request options.
*/
getTypesForUser(options?: Issue.Type.GetTypesForUser.Options): Promise;
/**
* Creates an issue type and adds it to the default issue type scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-post
* @param options Request options.
*/
createType(options: Issue.Type.CreateType.Options): Promise;
/**
* Returns issue types for a project.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types/#api-rest-api-3-issuetype-project-get
* @param options Request options.
*/
getTypesForProject(options: Issue.Type.GetTypesForProject.Options): Promise;
/**
* Returns an issue type.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-id-get
* @param options Request options.
*/
getType(options: Issue.Type.GetType.Options): Promise;
/**
* Updates the issue type.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-id-put
* @param options Request options.
*/
updateType(options: Issue.Type.UpdateType.Options): Promise;
/**
* Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-id-delete
* @param options Request options.
*/
deleteType(options: Issue.Type.DeleteType.Options): Promise;
/**
* Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** None.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-id-alternatives-get
* @param options Request options.
*/
getAlternativeTypes(options: Issue.Type.GetAlternativeTypes.Options): Promise;
/**
* Loads an avatar for the issue type.
Specify the avatar's local file location in the body of the request. Also, include the following headers:
* `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).
* `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.
For example:
`curl --request POST \ --user email@example.com: \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This`
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.
The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-id-avatar2-post
* @param options Request options.
*/
loadTypeAvatar(options: Issue.Type.LoadTypeAvatar.Options): Promise;
}
declare class IssueTypeScreenGroup extends BaseGroup {
Scheme: IssueTypeScreenSchemeGroup;
constructor(connection: string, options: ConnectionOptions);
}
declare class IssueTypeScreenSchemeGroup extends BaseGroup {
/**
* Returns a [paginated](#pagination) list of projects associated with an issue type screen scheme.
Only company-managed projects associated with an issue type screen scheme are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-project-get
* @param options Request options.
*/
getProjects(options: Issue.Type.Screen.Scheme.GetProjects.Options): Promise;
/**
* Returns a [paginated](#pagination) list of issue type screen schemes.
Only issue type screen schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescreenscheme-get
* @param options Request options.
*/
getSchemes(options?: Issue.Type.Screen.Scheme.GetSchemes.Options): Promise;
/**
* Creates an issue type screen scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-post
* @param options Request options.
*/
createScheme(options: Issue.Type.Screen.Scheme.CreateScheme.Options): Promise;
/**
* Returns a [paginated](#pagination) list of issue type screen scheme items.
Only issue type screen schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescreenscheme-mapping-get
* @param options Request options.
*/
getSchemeItems(options?: Issue.Type.Screen.Scheme.GetSchemeItems.Options): Promise;
/**
* Returns a [paginated](#pagination) list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.
Only issue type screen schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescreenscheme-project-get
* @param options Request options.
*/
getSchemesForProjects(options: Issue.Type.Screen.Scheme.GetSchemesForProjects.Options): Promise;
/**
* Assigns an issue type screen scheme to a project.
Issue type screen schemes can only be assigned to classic projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-project-put
* @param options Request options.
*/
assignSchemeToProject(options: Issue.Type.Screen.Scheme.AssignSchemeToProject.Options): Promise;
/**
* Updates an issue type screen scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-put
* @param options Request options.
*/
updateScheme(options: Issue.Type.Screen.Scheme.UpdateScheme.Options): Promise;
/**
* Deletes an issue type screen scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-delete
* @param options Request options.
*/
deleteScheme(options: Issue.Type.Screen.Scheme.DeleteScheme.Options): Promise;
/**
* Appends issue type to screen scheme mappings to an issue type screen scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-put
* @param options Request options.
*/
appendMappings(options: Issue.Type.Screen.Scheme.AppendMappings.Options): Promise;
/**
* Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-default-put
* @param options Request options.
*/
updateDefaultScheme(options: Issue.Type.Screen.Scheme.UpdateDefaultScheme.Options): Promise;
/**
* Removes issue type to screen scheme mappings from an issue type screen scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-issuetypescreenschemeid-mapping-remove-post
* @param options Request options.
*/
removeMappings(options: Issue.Type.Screen.Scheme.RemoveMappings.Options): Promise;
}
declare class IssueTypePropertyGroup extends BaseGroup {
/**
* Returns all the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys of the issue type.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the property keys of any issue type.
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the property keys of any issue types associated with the projects the user has permission to browse.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties/#api-rest-api-3-issuetype-issuetypeid-properties-get
* @param options Request options.
*/
getPropertyKeys(options: Issue.Type.Property.GetPropertyKeys.Options): Promise;
/**
* Returns the key and value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the details of any issue type.
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the details of any issue types associated with the projects the user has permission to browse.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties/#api-rest-api-3-issuetype-issuetypeid-properties-propertykey-get
* @param options Request options.
*/
getProperty(options: Issue.Type.Property.GetProperty.Options): Promise;
/**
* Creates or updates the value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). Use this resource to store and update data against an issue type.
The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties/#api-rest-api-3-issuetype-issuetypeid-properties-propertykey-put
* @param options Request options.
*/
setProperty(options: Issue.Type.Property.SetProperty.Options): Promise;
/**
* Deletes the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties/#api-rest-api-3-issuetype-issuetypeid-properties-propertykey-delete
* @param options Request options.
*/
deleteProperty(options: Issue.Type.Property.DeleteProperty.Options): Promise;
}
declare class IssueTypeSchemeGroup extends BaseGroup {
/**
* Returns a [paginated](#pagination) list of issue type schemes.
Only issue type schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescheme-get
* @param options Request options.
*/
getSchemes(options?: Issue.Type.Scheme.GetSchemes.Options): Promise;
/**
* Creates an issue type scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-post
* @param options Request options.
*/
createScheme(options: Issue.Type.Scheme.CreateScheme.Options): Promise;
/**
* Returns a [paginated](#pagination) list of issue type scheme items.
Only issue type scheme items used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescheme-mapping-get
* @param options Request options.
*/
getSchemeItems(options?: Issue.Type.Scheme.GetSchemeItems.Options): Promise;
/**
* Returns a [paginated](#pagination) list of issue type schemes and, for each issue type scheme, a list of the projects that use it.
Only issue type schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetypescheme-project-get
* @param options Request options.
*/
getSchemesForProjects(options: Issue.Type.Scheme.GetSchemesForProjects.Options): Promise;
/**
* Assigns an issue type scheme to a project.
If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.
Issue type schemes can only be assigned to classic projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-project-put
* @param options Request options.
*/
assignToProject(options: Issue.Type.Scheme.AssignToProject.Options): Promise;
/**
* Adds issue types to an issue type scheme.
The added issue types are appended to the issue types list.
If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-issuetypeschemeid-issuetype-put
* @param options Request options.
*/
addIssueTypesToScheme(options: Issue.Type.Scheme.AddIssueTypesToScheme.Options): Promise;
/**
* Updates an issue type scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-issuetypeschemeid-put
* @param options Request options.
*/
updateScheme(options: Issue.Type.Scheme.UpdateScheme.Options): Promise;
/**
* Deletes an issue type scheme.
Only issue type schemes used in classic projects can be deleted.
Any projects assigned to the scheme are reassigned to the default issue type scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-issuetypeschemeid-delete
* @param options Request options.
*/
deleteScheme(options: Issue.Type.Scheme.DeleteScheme.Options): Promise;
/**
* Changes the order of issue types in an issue type scheme.
The request body parameters must meet the following requirements:
* all of the issue types must belong to the issue type scheme.
* either `after` or `position` must be provided.
* the issue type in `after` must not be in the issue type list.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-issuetypeschemeid-issuetype-move-put
* @param options Request options.
*/
changeIssueTypesOrder(options: Issue.Type.Scheme.ChangeIssueTypesOrder.Options): Promise;
/**
* Removes an issue type from an issue type scheme.
This operation cannot remove:
* any issue type used by issues.
* any issue types from the default issue type scheme.
* the last standard issue type from an issue type scheme.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes/#api-rest-api-3-issuetypescheme-issuetypeschemeid-issuetype-issuetypeid-delete
* @param options Request options.
*/
removeIssueTypesFromScheme(options: Issue.Type.Scheme.RemoveIssueTypesFromScheme.Options): Promise;
}
declare class IssueFieldGroup extends BaseGroup {
Configuration: IssueFieldConfigurationGroup;
Custom: IssueFieldCustomGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* 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.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-get
* @param options Request options.
*/
getFields(options?: Issue.Field.GetFields.Options): Promise;
/**
* Returns a [paginated](#pagination) list of fields for Classic Jira projects. The list can include:
* all fields.
* specific fields, by defining `id`.
* fields that contain a string in the field name or description, by defining `query`.
* specific fields that contain a string in the field name or description, by defining `id` and `query`.
Only custom fields can be queried, `type` must be set to `custom`.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-search-get
* @param options Request options.
*/
getFieldsPaginated(options?: Issue.Field.GetFieldsPaginated.Options): Promise;
/**
* Returns a [paginated](#pagination) list of the contexts a field is used in. Deprecated, use [ Get custom field contexts](#api-rest-api-3-field-fieldId-context-get).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-fieldid-contexts-get
* @param options Request options.
* @deprecated
*/
getContexts(options: Issue.Field.GetContexts.Options): Promise;
/**
* Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-id-delete
* @param options Request options.
*/
deleteField(options: Issue.Field.DeleteField.Options): Promise;
/**
* Restores a custom field from trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-id-restore-post
* @param options Request options.
*/
restoreField(options: Issue.Field.RestoreField.Options): Promise;
/**
* Moves a custom field to trash. See [Edit or delete a custom field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-id-trash-post
* @param options Request options.
*/
moveToTrash(options: Issue.Field.MoveToTrash.Options): Promise;
}
declare class IssueFieldConfigurationGroup extends BaseGroup {
Scheme: IssueFieldConfigurationSchemeGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.
This operation can only create configurations for use in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfiguration-post
* @param options Request options.
*/
createConfiguration(options: Issue.Field.Configuration.CreateConfiguration.Options): Promise;
/**
* Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
* a list of field configuration item IDs.
* whether the field configuration is a default.
* whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-fieldconfiguration-get
* @param options Request options.
*/
getConfigurations(options?: Issue.Field.Configuration.GetConfigurations.Options): Promise;
/**
* Updates a field configuration. The name and the description provided in the request override the existing values.
This operation can only update configurations used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfiguration-id-put
* @param options Request options.
*/
updateConfiguration(options: Issue.Field.Configuration.UpdateConfiguration.Options): Promise;
/**
* Deletes a field configuration.
This operation can only delete configurations used in company-managed (classic) projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfiguration-id-delete
* @param options Request options.
*/
deleteConfiguration(options: Issue.Field.Configuration.DeleteConfiguration.Options): Promise;
/**
* Returns a [paginated](#pagination) list of all fields for a configuration.
Only the fields from configurations used in company-managed (classic) projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-fieldconfiguration-id-fields-get
* @param options Request options.
*/
getConfigurationItems(options: Issue.Field.Configuration.GetConfigurationItems.Options): Promise;
/**
* Returns a [paginated](#pagination) list of field configuration issue type items.
Only items used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-fieldconfigurationscheme-mapping-get
* @param options Request options.
*/
getConfigurationIssueTypeItems(options?: Issue.Field.Configuration.GetConfigurationIssueTypeItems.Options): Promise;
/**
* Returns a [paginated](#pagination) list of field configuration schemes.
Only field configuration schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfigurationscheme-get
* @param options Request options.
*/
getSchemes(options?: Issue.Field.Configuration.GetSchemes.Options): Promise;
}
declare class IssueFieldConfigurationSchemeGroup extends BaseGroup {
/**
* Returns a [paginated](#pagination) list of field configuration schemes and, for each scheme, a list of the projects that use it.
The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.
Only field configuration schemes used in classic projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-fieldconfigurationscheme-project-get
* @param options Request options.
*/
getSchemesForProjects(options: Issue.Field.Configuration.Scheme.GetSchemesForProjects.Options): Promise;
/**
* Assigns a field configuration scheme to a project. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme.
Field configuration schemes can only be assigned to classic projects.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfigurationscheme-project-put
* @param options Request options.
*/
assignSchemeToProject(options: Issue.Field.Configuration.Scheme.AssignSchemeToProject.Options): Promise;
}
declare class IssueFieldCustomGroup extends BaseGroup {
Option: IssueFieldCustomOptionGroup;
Context: IssueFieldCustomContextGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Creates a custom field.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-post
* @param options Request options.
*/
createField(options: Issue.Field.Custom.CreateField.Options): Promise;
/**
* Updates a custom field.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-fieldid-put
* @param options Request options.
*/
updateField(options: Issue.Field.Custom.UpdateField.Options): Promise;
}
declare class IssueFieldCustomOptionGroup extends BaseGroup {
/**
* Returns a custom field option. For example, an option in a select list.
Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** The custom field option is returned as follows:
* if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-customFieldOption-id-get
* @param options Request options.
* @deprecated
*/
getOption(options: Issue.Field.Custom.Option.GetOption.Options): Promise;
}
declare class IssueFieldCustomContextGroup extends BaseGroup {
Option: IssueFieldCustomContextOptionGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Returns a [paginated](#pagination) list of [ contexts](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html) for a custom field. Contexts can be returned as follows:
* With no other parameters set, all contexts.
* By defining `id` only, all contexts from the list of IDs.
* By defining `isAnyIssueType`, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)
* By defining `isGlobalContext`, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-get
* @param options Request options.
*/
getContexts(options: Issue.Field.Custom.Context.GetContexts.Options): Promise;
/**
* Creates a custom field context.
If `projectIds` is empty, a global context is created. A global context is one that applies to all project. If `issueTypeIds` is empty, the context applies to all issue types.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-post
* @param options Request options.
*/
createContext(options: Issue.Field.Custom.Context.CreateContext.Options): Promise;
/**
* Returns a [paginated](#pagination) list of defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
The returned object depends on type of the custom field:
* `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
* `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.
* `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons.
* `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes.
* `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists.
* `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users.
* `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists.
* `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group picker.
* `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group picker.
* `CustomFieldContextDefaultValueURL` (type `url`) for URL.
* `CustomFieldContextDefaultValueProject` (type `project`) for project picker.
* `CustomFieldContextDefaultValueFloat` (type `float`) for float (a floating-point number).
* `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
* `CustomFieldContextDefaultValueTextField` (type `textfield`) for text field.
* `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area field.
* `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) field.
* `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version picker.
* `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version picker.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-defaultvalue-get
* @param options Request options.
*/
getDefaultContexts(options: Issue.Field.Custom.Context.GetDefaultContexts.Options): Promise;
/**
* Sets default for contexts of a custom field. Default are defined using these objects:
* `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields.
* `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields.
* `CustomFieldContextDefaultValueSingleOption` (type `option.single`) for single choice select lists and radio buttons.
* `CustomFieldContextDefaultValueMultipleOption` (type `option.multiple`) for multiple choice select lists and checkboxes.
* `CustomFieldContextDefaultValueCascadingOption` (type `option.cascading`) for cascading select lists.
* `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users.
* `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists.
* `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group picker.
* `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group picker.
* `CustomFieldContextDefaultValueURL` (type `url`) for URL.
* `CustomFieldContextDefaultValueProject` (type `project`) for project picker.
* `CustomFieldContextDefaultValueFloat` (type `float`) for float (a floating-point number).
* `CustomFieldContextDefaultValueLabels` (type `labels`) for labels.
* `CustomFieldContextDefaultValueTextField` (type `textfield`) for text field.
* `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area field.
* `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) field.
* `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version picker.
* `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version picker.
Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to `null`.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-defaultvalue-put
* @param options Request options.
*/
setDefaultContexts(options: Issue.Field.Custom.Context.SetDefaultContexts.Options): Promise;
/**
* Returns a [paginated](#pagination) list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-issuetypemapping-get
* @param options Request options.
*/
getIssueTypes(options: Issue.Field.Custom.Context.GetIssueTypes.Options): Promise;
/**
* Returns a [paginated](#pagination) list of context to project mappings for a custom field. The result can be filtered by `contextId`. Otherwise, all mappings are returned. Invalid IDs are ignored.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-projectmapping-get
* @param options Request options.
*/
getProjectMappings(options: Issue.Field.Custom.Context.GetProjectMappings.Options): Promise;
/**
* Updates a [ custom field context](https://confluence.atlassian.com/adminjiracloud/what-are-custom-field-contexts-991923859.html).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-contextid-put
* @param options Request options.
*/
updateContext(options: Issue.Field.Custom.Context.UpdateContext.Options): Promise;
/**
* Adds issue types to a custom field context, appending the issue types to the issue types list.
A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.
If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-contextid-issuetype-put
* @param options Request options.
*/
addIssueTypes(options: Issue.Field.Custom.Context.AddIssueTypes.Options): Promise;
/**
* Removes issue types from a custom field context.
A custom field context without any issue types applies to all issue types.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-contextid-issuetype-remove-post
* @param options Request options.
*/
removeIssueTypes(options: Issue.Field.Custom.Context.RemoveIssueTypes.Options): Promise;
/**
* Assigns a custom field context to projects.
If any project in the request is assigned to any context of the custom field, the operation fails.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-contextid-project-put
* @param options Request options.
*/
assignToProjects(options: Issue.Field.Custom.Context.AssignToProjects.Options): Promise;
/**
* Removes a custom field context from projects.
A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects.
If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts/#api-rest-api-3-field-fieldid-context-contextid-project-remove-post
* @param options Request options.
*/
removeFromProjects(options: Issue.Field.Custom.Context.RemoveFromProjects.Options): Promise;
}
declare class IssueFieldCustomContextOptionGroup extends BaseGroup {
/**
* Returns a [paginated](#pagination) list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira.
This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get
* @param options Request options.
*/
getOptions(options: Issue.Field.Custom.Context.Option.GetOptions.Options): Promise;
/**
* Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field.
The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.
This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post
* @param options Request options.
*/
createOptions(options: Issue.Field.Custom.Context.Option.CreateOptions.Options): Promise;
/**
* Updates the options of a custom field.
If any of the options are not found, no options are updated. Options where the values in the request match the current values aren't updated and aren't reported in the response.
Note that this operation **only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list options created by Connect apps.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-put
* @param options Request options.
*/
updateOptions(options: Issue.Field.Custom.Context.Option.UpdateOptions.Options): Promise;
/**
* Changes the order of custom field options or cascading options in a context.
This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-move-put
* @param options Request options.
*/
reorderOptions(options: Issue.Field.Custom.Context.Option.ReorderOptions.Options): Promise;
/**
* Deletes a custom field option.
Options with cascading options cannot be deleted without deleting the cascading options first.
This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options--apps-) operations.**
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-optionid-delete
* @param options Request options.
*/
deleteOption(options: Issue.Field.Custom.Context.Option.DeleteOption.Options): Promise;
}
declare class IssueWorklogGroup extends BaseGroup {
Property: IssueWorklogPropertyGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Workloads are only returned where the user has:
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-worklog-get
* @param options Request options.
*/
getWorklogs(options: Issue.Worklog.GetWorklogs.Options): Promise;
/**
* Adds a worklog to an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-worklog-post
* @param options Request options.
*/
addWorklog(options: Issue.Worklog.AddWorklog.Options): Promise;
/**
* Returns a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-worklog-id-get
* @param options Request options.
*/
getWorklog(options: Issue.Worklog.GetWorklog.Options): Promise;
/**
* Updates a worklog.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or *Edit own worklogs* to update worklogs created by the user.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-worklog-id-put
* @param options Request options.
*/
updateWorklog(options: Issue.Worklog.UpdateWorklog.Options): Promise;
/**
* Deletes a worklog from an issue.
Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Delete all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any worklog or *Delete own worklogs* to delete worklogs created by the user,
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-worklog-id-delete
* @param options Request options.
*/
deleteWorklog(options: Issue.Worklog.DeleteWorklog.Options): Promise;
/**
* Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.
This resource does not return worklogs deleted during the minute preceding the request.
**[Permissions](#permissions) required:** Permission to access Jira.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-worklog-deleted-get
* @param options Request options.
*/
getDeletedIds(options?: Issue.Worklog.GetDeletedIds.Options): Promise;
/**
* Returns worklog details for a list of worklog IDs.
The returned list of worklogs is limited to 1000 items.
**[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:
* the worklog is set as *Viewable by All Users*.
* the user is a member of a project role or group with permission to view the worklog.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-worklog-list-post
* @param options Request options.
*/
getFromIds(options: Issue.Worklog.GetFromIds.Options): Promise;
/**
* Returns a list of IDs and update timestamps for worklogs updated after a date and time.
This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.
This resource does not return worklogs updated during the minute preceding the request.
**[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:
* the worklog is set as *Viewable by All Users*.
* the user is a member of a project role or group with permission to view the worklog.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-worklog-updated-get
* @param options Request options.
*/
getUpdatedIds(options?: Issue.Worklog.GetUpdatedIds.Options): Promise;
}
declare class IssueWorklogPropertyGroup extends BaseGroup {
/**
* Returns the keys of all properties for a worklog.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties/#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-get
* @param options Request options.
*/
getKeys(options: Issue.Worklog.Property.GetKeys.Options): Promise;
/**
* Returns the value of a worklog property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties/#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-get
* @param options Request options.
*/
getProperty(options: Issue.Worklog.Property.GetProperty.Options): Promise;
/**
* Sets the value of a worklog property. Use this operation to store custom data against the worklog.
The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or *Edit own worklogs* to update worklogs created by the user.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties/#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-put
* @param options Request options.
*/
setProperty(options: Issue.Worklog.Property.SetProperty.Options): Promise;
/**
* Deletes a worklog property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties/#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-delete
* @param options Request options.
*/
deleteProperty(options: Issue.Worklog.Property.DeleteProperty.Options): Promise;
}
declare class IssueAttachmentGroup extends BaseGroup {
Metadata: IssueAttachmentMetadataGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Deletes an attachment from an issue.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** For the project holding the issue containing the attachment:
* *Delete own attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by the calling user.
* *Delete all attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by any user.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-attachment-id-delete
* @param options Request options.
*/
deleteAttachment(options: Issue.Attachment.DeleteAttachment.Options): Promise;
/**
* Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)).
Note that:
* The request must have a `X-Atlassian-Token: no-check` header, if not it is blocked. See [Special headers](#special-request-headers) for more information.
* The name of the multipart/form-data parameter that contains the attachments must be `file`.
The following examples upload a file called *myfile.txt* to the issue *TEST-123*:
#### curl ####
curl --location --request POST 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments'
-u 'email@example.com:'
-H 'X-Atlassian-Token: no-check'
--form 'file=@"myfile.txt"'
#### Node.js ####
// This code sample uses the 'node-fetch' and 'form-data' libraries:
// https://www.npmjs.com/package/node-fetch
// https://www.npmjs.com/package/form-data
const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');
const filePath = 'myfile.txt';
const form = new FormData();
const stats = fs.statSync(filePath);
const fileSizeInBytes = stats.size;
const fileStream = fs.createReadStream(filePath);
form.append('file', fileStream, {knownLength: fileSizeInBytes});
fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments', {
method: 'POST',
body: form,
headers: {
'Authorization': `Basic ${Buffer.from(
'email@example.com:'
).toString('base64')}`,
'Accept': 'application/json',
'X-Atlassian-Token': 'no-check'
}
})
.then(response => {
console.log(
`Response: ${response.status} ${response.statusText}`
);
return response.text();
})
.then(text => console.log(text))
.catch(err => console.error(err));
#### Java ####
// This code sample uses the 'Unirest' library:
// http://unirest.io/java.html
HttpResponse response = Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments")
.basicAuth("email@example.com", "")
.header("Accept", "application/json")
.header("X-Atlassian-Token", "no-check")
.field("file", new File("myfile.txt"))
.asJson();
System.out.println(response.getBody());
#### Python ####
# This code sample uses the 'requests' library:
# http://docs.python-requests.org
import requests
from requests.auth import HTTPBasicAuth
import json
url = "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments"
auth = HTTPBasicAuth("email@example.com", "")
headers = {
"Accept": "application/json",
"X-Atlassian-Token": "no-check"
}
response = requests.request(
"POST",
url,
headers = headers,
auth = auth,
files = {
"file": ("myfile.txt", open("myfile.txt","rb"), "application-type")
}
)
print(json.dumps(json.loads(response.text), sort_keys=True, indent=4, separators=(",", ": ")))
#### PHP ####
// This code sample uses the 'Unirest' library:
// http://unirest.io/php.html
Unirest\Request::auth('email@example.com', '');
$headers = array(
'Accept' => 'application/json',
'X-Atlassian-Token' => 'no-check'
);
$parameters = array(
'file' => File::add('myfile.txt')
);
$response = Unirest\Request::post(
'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',
$headers,
$parameters
);
var_dump($response)
#### Forge ####
// This sample uses Atlassian Forge and the `form-data` library.
// https://developer.atlassian.com/platform/forge/
// https://www.npmjs.com/package/form-data
import api from "@forge/api";
import FormData from "form-data";
const form = new FormData();
form.append('file', fileStream, {knownLength: fileSizeInBytes});
const response = await api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {
method: 'POST',
body: form,
headers: {
'Accept': 'application/json',
'X-Atlassian-Token': 'no-check'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());
Tip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) class for multipart POST operations.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse Projects* and *Create attachments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-attachments-post
* @param options Request options.
*/
addAttachments(options: Issue.Attachment.AddAttachments.Options): Promise;
}
declare class IssueAttachmentMetadataGroup extends BaseGroup {
/**
* Returns the metadata for an attachment. Note that the attachment itself is not returned.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-attachment-id-get
* @param options Request options.
*/
getMetadata(options: Issue.Attachment.Metadata.GetMetadata.Options): Promise;
/**
* Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.
Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use [ Get contents metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-raw-get), which only returns the metadata for the attachment's contents.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** For the issue containing the attachment:
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-attachment-id-expand-human-get
* @param options Request options.
*/
getMetadataForExpandedAttachment(options: Issue.Attachment.Metadata.GetMetadataForExpandedAttachment.Options): Promise;
/**
* Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.
Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use [ Get all metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment's ID and name.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** For the issue containing the attachment:
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-attachment-id-expand-raw-get
* @param options Request options.
*/
getContentsMetadataForExpandedAttachment(options: Issue.Attachment.Metadata.GetContentsMetadataForExpandedAttachment.Options): Promise;
}
declare class IssueCommentGroup extends BaseGroup {
Property: IssueCommentPropertyGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Returns a [paginated](#pagination) list of comments specified by a list of comment IDs.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Comments are returned where the user:
* has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-comment-list-post
* @param options Request options.
*/
getCommentsByIds(options: Issue.Comment.GetCommentsByIds.Options): Promise;
/**
* Returns all comments for an issue.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Comments are included in the response where the user has:
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-comment-get
* @param options Request options.
*/
getComments(options: Issue.Comment.GetComments.Options): Promise;
/**
* Adds a comment to an issue.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-comment-post
* @param options Request options.
*/
addComment(options: Issue.Comment.AddComment.Options): Promise;
/**
* Returns a comment.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-comment-id-get
* @param options Request options.
*/
getComment(options: Issue.Comment.GetComment.Options): Promise;
/**
* Updates a comment.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Edit all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any comment or *Edit own comments* to update comment created by the user.
* If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-comment-id-put
* @param options Request options.
*/
updateComment(options: Issue.Comment.UpdateComment.Options): Promise;
/**
* Deletes a comment.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or *Delete own comments* to delete comment created by the user,
* If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-comment-id-delete
* @param options Request options.
*/
deleteComment(options: Issue.Comment.DeleteComment.Options): Promise;
}
declare class IssueCommentPropertyGroup extends BaseGroup {
/**
* Returns the keys of all the properties of a comment.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-comment-commentId-properties-get
* @param options Request options.
*/
getKeys(options: Issue.Comment.Property.GetKeys.Options): Promise;
/**
* Returns the value of a comment property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-comment-commentId-properties-propertyKey-get
* @param options Request options.
*/
getProperty(options: Issue.Comment.Property.GetProperty.Options): Promise;
/**
* Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.
The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
**[Permissions](#permissions) required:** either of:
* *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on any comment.
* *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-comment-commentId-properties-propertyKey-put
* @param options Request options.
*/
setProperty(options: Issue.Comment.Property.SetProperty.Options): Promise;
/**
* Deletes a comment property.
**[Permissions](#permissions) required:** either of:
* *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from any comment.
* *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-comment-commentId-properties-propertyKey-delete
* @param options Request options.
*/
deleteProperty(options: Issue.Comment.Property.DeleteProperty.Options): Promise;
}
declare class IssueMetadataGroup extends BaseGroup {
/**
* Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).
The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-createmeta-get
* @param options Request options.
*/
getCreateMetadata(options?: Issue.Metadata.GetCreateMetadata.Options): Promise;
/**
* Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put).
Connect app users with admin permission (from user permissions and app scopes) and Forge app users with the `manage:jira-configuration` scope can return additional details using:
* `overrideScreenSecurity` Returns hidden fields.
* `overrideEditableFlag` Returns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
Note: For any fields to be editable the user must have the *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-editmeta-get
* @param options Request options.
*/
getEditMetadata(options: Issue.Metadata.GetEditMetadata.Options): Promise;
}
declare class IssuePropertyGroup extends BaseGroup {
/**
* Returns the URLs and keys of an issue's properties.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** Property details are only returned where the user has:
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-properties-get
* @param options Request options.
*/
getKeys(options: Issue.Property.GetKeys.Options): Promise;
/**
* Returns the key and value of an issue's property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-properties-propertyKey-get
* @param options Request options.
*/
getProperty(options: Issue.Property.GetProperty.Options): Promise;
/**
* Sets the value of an issue's property. Use this resource to store custom data against an issue.
The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-properties-propertyKey-put
* @param options Request options.
*/
setProperty(options: Issue.Property.SetProperty.Options): Promise;
/**
* Deletes an issue's property.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-properties-propertyKey-delete
* @param options Request options.
*/
deleteProperty(options: Issue.Property.DeleteProperty.Options): Promise;
}
declare class IssueLinkGroup extends BaseGroup {
Remote: IssueLinkRemoteGroup;
Type: IssueLinkTypeGroup;
constructor(connection: string, options: ConnectionOptions);
/**
* Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have [Issue Linking](https://confluence.atlassian.com/x/yoXKM) enabled.
This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use `https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks`.
If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues to be linked,
* *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) on the project containing the from (outward) issue,
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLink-post
* @param options Request options.
*/
createLink(options: Issue.Link.CreateLink.Options): Promise;
/**
* Returns an issue link.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLink-linkId-get
* @param options Request options.
*/
getLink(options: Issue.Link.GetLink.Options): Promise;
/**
* Deletes an issue link.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* Browse project [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues in the link.
* *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the projects containing issues in the link.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLink-linkId-delete
* @param options Request options.
*/
deleteLink(options: Issue.Link.DeleteLink.Options): Promise;
}
declare class IssueLinkRemoteGroup extends BaseGroup {
/**
* Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-get
* @param options Request options.
*/
getLinks(options: Issue.Link.Remote.GetLinks.Options): Promise;
/**
* Creates or updates a remote issue link for an issue.
If a `globalId` is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-post
* @param options Request options.
*/
createOrUpdateLink(options: Issue.Link.Remote.CreateOrUpdateLink.Options): Promise;
/**
* Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is implemented, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-delete
* @param options Request options.
*/
deleteLinkByGlobalId(options: Issue.Link.Remote.DeleteLinkByGlobalId.Options): Promise;
/**
* Returns a remote issue link for an issue.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-linkId-get
* @param options Request options.
*/
getLink(options: Issue.Link.Remote.GetLink.Options): Promise;
/**
* Updates a remote issue link for an issue.
Note: Fields without values in the request are set to null.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-linkId-put
* @param options Request options.
*/
updateLink(options: Issue.Link.Remote.UpdateLink.Options): Promise;
/**
* Deletes a remote issue link from an issue.
This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects*, *Edit issues*, and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-remotelink-linkId-delete
* @param options Request options.
*/
deleteLink(options: Issue.Link.Remote.DeleteLink.Options): Promise;
}
declare class IssueLinkTypeGroup extends BaseGroup {
/**
* Returns a list of all issue link types.
To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLinkType-get
* @param options Request options.
*/
getTypes(options?: Issue.Link.Type.GetTypes.Options): Promise;
/**
* Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.
To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLinkType-post
* @param options Request options.
*/
createType(options: Issue.Link.Type.CreateType.Options): Promise;
/**
* Returns an issue link type.
To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLinkType-issueLinkTypeId-get
* @param options Request options.
*/
getType(options: Issue.Link.Type.GetType.Options): Promise;
/**
* Updates an issue link type.
To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLinkType-issueLinkTypeId-put
* @param options Request options.
*/
updateType(options: Issue.Link.Type.UpdateType.Options): Promise;
/**
* Deletes an issue link type.
To use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issueLinkType-issueLinkTypeId-delete
* @param options Request options.
*/
deleteType(options: Issue.Link.Type.DeleteType.Options): Promise;
}
declare class IssueTransitionGroup extends BaseGroup {
/**
* Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.
Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.
This operation can be accessed anonymously.
**[Permissions](#permissions) required: A list or transition is returned only when the user has:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
However, if the user does not have the *Transition issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-transitions-get
* @param options Request options.
*/
getTransitions(options: Issue.Transition.GetTransitions.Options): Promise;
/**
* Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.
sortByCategory To update the fields on the transition screen, specify the fields in the `fields` or `update` parameters in the request body. Get details about the fields using [ Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the `transitions.fields` expand.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-transitions-post
* @param options Request options.
*/
performTransition(options: Issue.Transition.PerformTransition.Options): Promise;
}
declare class IssueVoteGroup extends BaseGroup {
/**
* Returns details about the votes on an issue.
This operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
This operation can be accessed anonymously.
**[Permissions](#permissions) required:**
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini
* If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
Note that users with the necessary permissions for this operation but without the *View voters and watchers* project permissions are not returned details in the `voters` field.
* Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issue-issueIdOrKey-votes-get
* @param options Request options.
*/
getVotes