/*! * Copyright Adaptavist 2022 (c) All rights reserved */ import { Headers, Response, BaseApiCore, ErrorStrategyOptionType, PlatformImplementation } from '@managed-api/commons-core'; import { AssignIssueRequest, AssignIssueResponseOK, CreateIssueRequest, CreateIssueResponseOK, DeleteIssueRequest, DeleteIssueResponseOK, EditIssueRequest, EditIssueResponseOK, GetIssueRequest, GetIssueResponseOK, SendNotificationForIssueRequest, SendNotificationForIssueResponseOK } from './types/issue'; import { AddIssueCommentRequest, AddIssueCommentResponseOK, DeleteIssueCommentRequest, DeleteIssueCommentResponseOK, GetIssueCommentRequest, GetIssueCommentResponseOK, GetIssueCommentsRequest, GetIssueCommentsResponseOK, UpdateIssueCommentRequest, UpdateIssueCommentResponseOK } from './types/issue/comment'; import { CustomError } from './common'; import { CommonError, ErrorStrategyHandlers, ErrorStrategyOption } from './errorStrategy'; import { ErrorStrategyBuilder } from './builders/errorStrategy'; import { GetApplicationRoleRequest, GetApplicationRoleResponseOK, GetApplicationRolesRequest, GetApplicationRolesResponseOK, UpdateApplicationRoleRequest, UpdateApplicationRoleResponseOK } from './types/application/role'; import { GetWorkflowsRequest, GetWorkflowsResponseOK } from './types/workflow'; import { GetWorkflowStatusCategoriesRequest, GetWorkflowStatusCategoriesResponseOK, GetWorkflowStatusCategoryRequest, GetWorkflowStatusCategoryResponseOK } from './types/workflow/status/category'; import { GetWorkflowStatusesRequest, GetWorkflowStatusesResponseOK, GetWorkflowStatusRequest, GetWorkflowStatusResponseOK } from './types/workflow/status'; import { CreateWorkflowSchemeRequest, CreateWorkflowSchemeResponseOK, DeleteWorkflowSchemeRequest, DeleteWorkflowSchemeResponseOK, GetWorkflowSchemeRequest, GetWorkflowSchemeResponseOK, UpdateWorkflowSchemeRequest, UpdateWorkflowSchemeResponseOK } from './types/workflow/scheme'; import { GetAllDashboardsRequest, GetAllDashboardsResponseOK, GetDashboardByIdRequest, GetDashboardByIdResponseOK } from './types/dashboard'; import { AddFilterSharePermissionRequest, AddFilterSharePermissionResponseOK, DeleteFilterSharePermissionRequest, DeleteFilterSharePermissionResponseOK, GetFilterSharePermissionRequest, GetFilterSharePermissionResponseOK, GetFilterSharePermissionsRequest, GetFilterSharePermissionsResponseOK } from './types/filter/share/permission'; import { GetFilterDefaultColumnsRequest, GetFilterDefaultColumnsResponseOK, ResetFilterColumnsRequest, ResetFilterColumnsResponseOK, SetFilterDefaultColumnsRequest, SetFilterDefaultColumnsResponseOK } from './types/filter/column'; import { GetDefaultShareScopeRequest, GetDefaultShareScopeResponseOK, SetDefaultShareScopeRequest, SetDefaultShareScopeResponseOK } from './types/filter/share'; import { CreateFilterRequest, CreateFilterResponseOK, DeleteFilterRequest, DeleteFilterResponseOK, EditFilterRequest, EditFilterResponseOK, GetFilterRequest, GetFilterResponseOK, GetMyFavouriteFiltersRequest, GetMyFavouriteFiltersResponseOK } from './types/filter'; import { AddUsersToGroupRequest, AddUsersToGroupResponseOK, GetUsersFromGroupRequest, GetUsersFromGroupResponseOK, RemoveUsersFromGroupRequest, RemoveUsersFromGroupResponseOK } from './types/group/user'; import { CreateGroupRequest, CreateGroupResponseOK, RemoveGroupRequest, RemoveGroupResponseOK } from './types/group'; import { GetAdvancedSettingsRequest, GetAdvancedSettingsResponseOK, GetApplicationPropertyRequest, GetApplicationPropertyResponseOK, GetInstanceConfigurationRequest, GetInstanceConfigurationResponseOK, GetInstanceInfoRequest, GetInstanceInfoResponseOK, SetApplicationPropertyRequest, SetApplicationPropertyResponseOK } from './types/instance'; import { DeleteIssueCommentPropertyRequest, DeleteIssueCommentPropertyResponseOK, GetIssueCommentPropertyKeysRequest, GetIssueCommentPropertyKeysResponseOK, GetIssueCommentPropertyRequest, GetIssueCommentPropertyResponseOK, SetIssueCommentPropertyRequest, SetIssueCommentPropertyResponseOK } from './types/issue/comment/property'; import { GetIssueAttachmentMetadataRequest, GetIssueAttachmentMetadataResponseOK } from './types/issue/attachment/metadata'; import { AddIssueAttachmentRequest, AddIssueAttachmentResponseOK, GetIssueAttachmentRequest, GetIssueAttachmentResponseOK, RemoveIssueAttachmentRequest, RemoveIssueAttachmentResponseOK } from './types/issue/attachment'; import { GetIssueCustomFieldOptionRequest, GetIssueCustomFieldOptionResponseOK } from './types/issue/field/custom/option'; import { GetIssueCustomFieldsRequest, GetIssueCustomFieldsResponseOK } from './types/issue/field/custom'; import { GetIssueFieldsRequest, GetIssueFieldsResponseOK } from './types/issue/field'; import { CreateIssueLinkTypeRequest, CreateIssueLinkTypeResponseOK, DeleteIssueLinkTypeRequest, DeleteIssueLinkTypeResponseOK, GetIssueLinkTypeRequest, GetIssueLinkTypeResponseOK, GetIssueLinkTypesRequest, GetIssueLinkTypesResponseOK, UpdateIssueLinkTypeRequest, UpdateIssueLinkTypeResponseOK } from './types/issue/link/type'; import { CreateOrUpdateRemoteIssueLinkRequest, CreateOrUpdateRemoteIssueLinkResponseOK, DeleteRemoteIssueLinkByGlobalIdRequest, DeleteRemoteIssueLinkByGlobalIdResponseOK, DeleteRemoteIssueLinkRequest, DeleteRemoteIssueLinkResponseOK, GetRemoteIssueLinkRequest, GetRemoteIssueLinkResponseOK, GetRemoteIssueLinksRequest, GetRemoteIssueLinksResponseOK, UpdateRemoteIssueLinkRequest, UpdateRemoteIssueLinkResponseOK } from './types/issue/link/remote'; import { CreateIssueLinkRequest, CreateIssueLinkResponseOK, DeleteIssueLinkRequest, DeleteIssueLinkResponseOK, GetIssueLinkRequest, GetIssueLinkResponseOK } from './types/issue/link'; import { GetCreateIssueMetadataRequest, GetCreateIssueMetadataResponseOK, GetEditIssueMetadataRequest, GetEditIssueMetadataResponseOK } from './types/issue/metadata'; import { CreateIssuePrioritySchemeRequest, CreateIssuePrioritySchemeResponseOK, DeleteIssuePrioritySchemeRequest, DeleteIssuePrioritySchemeResponseOK, GetIssuePrioritySchemeRequest, GetIssuePrioritySchemeResponseOK, GetIssuePrioritySchemesRequest, GetIssuePrioritySchemesResponseOK, UpdateIssuePrioritySchemeRequest, UpdateIssuePrioritySchemeResponseOK } from './types/issue/priority/scheme'; import { GetIssuePrioritiesRequest, GetIssuePrioritiesResponseOK, GetIssuePriorityRequest, GetIssuePriorityResponseOK } from './types/issue/priority'; import { DeleteIssuePropertyRequest, DeleteIssuePropertyResponseOK, GetIssuePropertyKeysRequest, GetIssuePropertyKeysResponseOK, GetIssuePropertyRequest, GetIssuePropertyResponseOK, SetIssuePropertyRequest, SetIssuePropertyResponseOK } from './types/issue/property'; import { GetIssueResolutionRequest, GetIssueResolutionResponseOK, GetIssueResolutionsRequest, GetIssueResolutionsResponseOK } from './types/issue/resolution'; import { SearchIssuesByJqlRequest, SearchIssuesByJqlResponseOK } from './types/issue/search'; import { CanMoveIssueSubTaskRequest, CanMoveIssueSubTaskResponseOK, GetIssueSubTasksRequest, GetIssueSubTasksResponseOK, MoveIssueSubTasksRequest, MoveIssueSubTasksResponseOK } from './types/issue/subtask'; import { GetIssueTransitionsRequest, GetIssueTransitionsResponseOK, PerformIssueTransitionRequest, PerformIssueTransitionResponseOK } from './types/issue/transition'; import { AddProjectAssociationsToIssueTypeSchemeRequest, AddProjectAssociationsToIssueTypeSchemeResponseOK, GetProjectAssociationsForIssueTypeSchemeRequest, GetProjectAssociationsForIssueTypeSchemeResponseOK, RemoveProjectAssociationForIssueTypeSchemeRequest, RemoveProjectAssociationForIssueTypeSchemeResponseOK, RemoveProjectAssociationsForIssueTypeSchemeRequest, RemoveProjectAssociationsForIssueTypeSchemeResponseOK, SetProjectAssociationsForIssueTypeSchemeRequest, SetProjectAssociationsForIssueTypeSchemeResponseOK } from './types/issue/type/scheme/project'; import { CreateIssueTypeSchemeRequest, CreateIssueTypeSchemeResponseOK, DeleteIssueTypeSchemeRequest, DeleteIssueTypeSchemeResponseOK, GetIssueTypeSchemeRequest, GetIssueTypeSchemeResponseOK, GetIssueTypeSchemesRequest, GetIssueTypeSchemesResponseOK, UpdateIssueTypeSchemeRequest, UpdateIssueTypeSchemeResponseOK } from './types/issue/type/scheme'; import { CreateIssueTypeRequest, CreateIssueTypeResponseOK, DeleteIssueTypeRequest, DeleteIssueTypeResponseOK, GetAlternativeIssueTypesRequest, GetAlternativeIssueTypesResponseOK, GetIssueTypeRequest, GetIssueTypeResponseOK, GetIssueTypesRequest, GetIssueTypesResponseOK, UpdateIssueTypeRequest, UpdateIssueTypeResponseOK } from './types/issue/type'; import { AddIssueVoteRequest, AddIssueVoteResponseOK, GetIssueVotesRequest, GetIssueVotesResponseOK, RemoveIssueVoteRequest, RemoveIssueVoteResponseOK } from './types/issue/vote'; import { AddIssueWatcherRequest, AddIssueWatcherResponseOK, GetIssueWatchersRequest, GetIssueWatchersResponseOK, RemoveIssueWatcherRequest, RemoveIssueWatcherResponseOK } from './types/issue/watcher'; import { AddIssueWorklogRequest, AddIssueWorklogResponseOK, DeleteIssueWorklogRequest, DeleteIssueWorklogResponseOK, GetDeletedIssueWorklogIdsRequest, GetDeletedIssueWorklogIdsResponseOK, GetIssueWorklogRequest, GetIssueWorklogResponseOK, GetIssueWorklogsForIdsRequest, GetIssueWorklogsForIdsResponseOK, GetIssueWorklogsRequest, GetIssueWorklogsResponseOK, GetUpdatedIssueWorklogIdsRequest, GetUpdatedIssueWorklogIdsResponseOK, UpdateIssueWorklogRequest, UpdateIssueWorklogResponseOK } from './types/issue/worklog'; import { GetIssueSecuritySchemeRequest, GetIssueSecuritySchemeResponseOK, GetIssueSecuritySchemesRequest, GetIssueSecuritySchemesResponseOK } from './types/issue/security/scheme'; import { GetNotificationSchemeRequest, GetNotificationSchemeResponseOK, GetNotificationSchemesRequest, GetNotificationSchemesResponseOK } from './types/issue/notification/scheme'; import { GetCurrentUserRequest, GetCurrentUserResponseOK, GetMyPreferenceRequest, GetMyPreferenceResponseOK, RemoveMyPreferenceRequest, RemoveMyPreferenceResponseOK, SetMyPreferenceRequest, SetMyPreferenceResponseOK } from './types/myself'; import { CreatePermissionSchemeGrantRequest, CreatePermissionSchemeGrantResponseOK, DeletePermissionSchemeGrantRequest, DeletePermissionSchemeGrantResponseOK, GetPermissionSchemeGrantRequest, GetPermissionSchemeGrantResponseOK, GetPermissionSchemeGrantsRequest, GetPermissionSchemeGrantsResponseOK } from './types/permission/scheme/grant'; import { GetPermissionSchemeAttributeRequest, GetPermissionSchemeAttributeResponseOK } from './types/permission/scheme/attribute'; import { CreatePermissionSchemeRequest, CreatePermissionSchemeResponseOK, DeletePermissionSchemeRequest, DeletePermissionSchemeResponseOK, GetPermissionSchemeRequest, GetPermissionSchemeResponseOK, GetPermissionSchemesRequest, GetPermissionSchemesResponseOK, UpdatePermissionSchemeRequest, UpdatePermissionSchemeResponseOK } from './types/permission/scheme'; import { GetMyPermissionsRequest, GetMyPermissionsResponseOK, GetPermissionsRequest, GetPermissionsResponseOK } from './types/permission'; import { CreateProjectComponentRequest, CreateProjectComponentResponseOK, DeleteProjectComponentRequest, DeleteProjectComponentResponseOK, GetProjectComponentRelatedIssueCountRequest, GetProjectComponentRelatedIssueCountResponseOK, GetProjectComponentRequest, GetProjectComponentResponseOK, UpdateProjectComponentRequest, UpdateProjectComponentResponseOK } from './types/project/component'; import { AddProjectRoleActorUsersRequest, AddProjectRoleActorUsersResponseOK, DeleteProjectRoleActorRequest, DeleteProjectRoleActorResponseOK, SetProjectRoleActorsRequest, SetProjectRoleActorsResponseOK } from './types/project/role/actor'; import { GetProjectRoleRequest, GetProjectRoleResponseOK, GetProjectRolesRequest, GetProjectRolesResponseOK } from './types/project/role'; import { GetProjectSecurityLevelsRequest, GetProjectSecurityLevelsResponseOK } from './types/project/security'; import { GetAccessibleProjectTypeRequest, GetAccessibleProjectTypeResponseOK, GetProjectTypeRequest, GetProjectTypeResponseOK, GetProjectTypesRequest, GetProjectTypesResponseOK } from './types/project/type'; import { ValidateProjectKeyRequest, ValidateProjectKeyResponseOK } from './types/project/validation'; import { CreateOrUpdateRemoteVersionLinkByIdRequest, CreateOrUpdateRemoteVersionLinkByIdResponseOK, CreateOrUpdateRemoteVersionLinkRequest, CreateOrUpdateRemoteVersionLinkResponseOK, DeleteRemoteVersionLinkRequest, DeleteRemoteVersionLinkResponseOK, DeleteRemoteVersionLinksByIdRequest, DeleteRemoteVersionLinksByIdResponseOK, GetRemoteVersionLinkRequest, GetRemoteVersionLinkResponseOK, GetRemoteVersionLinksByIdRequest, GetRemoteVersionLinksByIdResponseOK, GetRemoteVersionLinksRequest, GetRemoteVersionLinksResponseOK } from './types/project/version/remote'; import { GetProjectVersionRelatedIssueCountRequest, GetProjectVersionRelatedIssueCountResponseOK, GetProjectVersionUnresolvedIssueCountRequest, GetProjectVersionUnresolvedIssueCountResponseOK } from './types/project/version/count'; import { CreateProjectVersionRequest, CreateProjectVersionResponseOK, DeleteProjectVersionRequest, DeleteProjectVersionResponseOK, GetProjectVersionRequest, GetProjectVersionResponseOK, MergeProjectVersionRequest, MergeProjectVersionResponseOK, MoveProjectVersionRequest, MoveProjectVersionResponseOK, RemoveAndReplaceProjectVersionRequest, RemoveAndReplaceProjectVersionResponseOK, UpdateProjectVersionRequest, UpdateProjectVersionResponseOK } from './types/project/version'; import { GetProjectIssueSecuritySchemeRequest, GetProjectIssueSecuritySchemeResponseOK } from './types/project/issue/security/scheme'; import { GetProjectNotificationSchemeRequest, GetProjectNotificationSchemeResponseOK } from './types/project/notification/scheme'; import { GetProjectPermissionSchemeRequest, GetProjectPermissionSchemeResponseOK } from './types/project/permission/scheme'; import { GetPrioritySchemeRequest, GetPrioritySchemeResponseOK } from './types/project/priority/scheme'; import { AddScreenTabResponseOK, AddScreenTabRequest, GetScreenTabsRequest, GetScreenTabsResponseOK, RenameScreenTabResponseOK, RenameScreenTabRequest, DeleteScreenTabRequest, DeleteScreenTabResponseOK, MoveScreenTabRequest, MoveScreenTabResponseOK } from './types/screen/tab'; import { ArchiveProjectRequest, ArchiveProjectResponseOK, CreateProjectRequest, CreateProjectResponseOK, DeleteProjectRequest, DeleteProjectResponseOK, GetProjectComponentsRequest, GetProjectComponentsResponseOK, GetProjectRequest, GetProjectResponseOK, GetProjectsRequest, GetProjectsResponseOK, GetProjectStatusesRequest, GetProjectStatusesResponseOK, GetProjectVersionsPaginatedRequest, GetProjectVersionsPaginatedResponseOK, GetProjectVersionsRequest, GetProjectVersionsResponseOK, RestoreProjectRequest, RestoreProjectResponseOK, UpdateProjectRequest, UpdateProjectResponseOK, UpdateProjectTypeRequest, UpdateProjectTypeResponseOK } from './types/project'; import { AddFieldToDefaultScreenRequest, AddFieldToDefaultScreenResponseOK, AddScreenFieldRequest, AddScreenFieldResponseOK, GetScreenFieldsRequest, GetScreenFieldsResponseOK, MoveScreenFieldRequest, MoveScreenFieldResponseOK, RemoveScreenFieldRequest, RemoveScreenFieldResponseOK } from './types/screen/field'; import { GetScreenFieldsToAddRequest, GetScreenFieldsToAddResponseOK, GetScreensRequest, GetScreensResponseOK } from './types/screen'; import { FindAssignableUsersRequest, FindAssignableUsersResponseOK, FindUsersRequest, FindUsersResponseOK, FindUsersWithAllPermissionsRequest, FindUsersWithAllPermissionsResponseOK, FindUsersWithBrowsePermissionRequest, FindUsersWithBrowsePermissionResponseOK } from './types/user/search'; import { AddUserToApplicationRequest, AddUserToApplicationResponseOK, ChangeUserPasswordRequest, ChangeUserPasswordResponseOK, CreateUserRequest, CreateUserResponseOK, GetUserRequest, GetUserResponseOK, RemoveUserFromApplicationRequest, RemoveUserFromApplicationResponseOK, RemoveUserRequest, RemoveUserResponseOK, UpdateUserRequest, UpdateUserResponseOK } from './types/user'; import { CreateGlobalProjectRoleRequest, CreateGlobalProjectRoleResponseOK, DeleteGlobalProjectRoleRequest, DeleteGlobalProjectRoleResponseOK, GetGlobalProjectRoleRequest, GetGlobalProjectRoleResponseOK, GetGlobalProjectRolesRequest, GetGlobalProjectRolesResponseOK, UpdateGlobalProjectRoleFullyRequest, UpdateGlobalProjectRoleFullyResponseOK, UpdateGlobalProjectRolePartiallyRequest, UpdateGlobalProjectRolePartiallyResponseOK } from './types/role/project'; import { AddGlobalProjectRoleActorsRequest, AddGlobalProjectRoleActorsResponseOK, DeleteGlobalProjectRoleActorsRequest, DeleteGlobalProjectRoleActorsResponseOK, GetGlobalProjectRoleActorsRequest, GetGlobalProjectRoleActorsResponseOK } from './types/role/project/actor'; export interface JiraOnPremApiCoreOptions extends ErrorStrategyOption { } declare type GetGlobalErrorStrategy = () => ErrorStrategyOptionType | undefined; export declare abstract class JiraOnPremApiCore extends BaseApiCore { private options?; Issue: IssueGroup; Application: ApplicationGroup; Workflow: WorkflowGroup; Dashboard: DashboardGroup; Filter: FilterGroup; Group: GroupGroup; Instance: InstanceGroup; Myself: MyselfGroup; Permission: PermissionGroup; Project: ProjectGroup; Screen: ScreenGroup; User: UserGroup; Role: RoleGroup; All: AllGroup; constructor(options?: JiraOnPremApiCoreOptions); setGlobalErrorStrategy(errorStrategy: ErrorStrategyOptionType): void; protected buildResponse(url: string, status: number, statusText: string, headers: Headers, body?: string | ArrayBuffer): Response; private getGlobalErrorStrategy; } declare class AllGroup { private Issue; private Application; private Workflow; private Dashboard; private Filter; private Group; private Instance; private Myself; private Permission; private Project; private Screen; private User; private Role; constructor(Issue: IssueGroup, Application: ApplicationGroup, Workflow: WorkflowGroup, Dashboard: DashboardGroup, Filter: FilterGroup, Group: GroupGroup, Instance: InstanceGroup, Myself: MyselfGroup, Permission: PermissionGroup, Project: ProjectGroup, Screen: ScreenGroup, User: UserGroup, Role: RoleGroup); /** * Get all the ProjectRoles available in JIRA. Currently this list is global. * Alternative usage: Role.Project.getRoles * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRoles * @param options Request options. */ getGlobalProjectRoles(options?: GetGlobalProjectRolesRequest): Promise; /** * Creates a new ProjectRole to be available in Jira. The created role does not have any default actors assigned. * Alternative usage: Role.Project.createRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-createProjectRole * @param options Request options. */ createGlobalProjectRole(options: CreateGlobalProjectRoleRequest): Promise; /** * Get a specific ProjectRole available in JIRA. * Alternative usage: Role.Project.getRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRolesById * @param options Request options. */ getGlobalProjectRole(options: GetGlobalProjectRoleRequest): Promise; /** * Partially updates a roles name or description. * Alternative usage: Role.Project.updateRolePartially * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-partialUpdateProjectRole * @param options Request options. */ updateGlobalProjectRolePartially(options: UpdateGlobalProjectRolePartiallyRequest): Promise; /** * Fully updates a roles. Both name and description must be given. * Alternative usage: Role.Project.updateRoleFully * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRolesById * @param options Request options. */ updateGlobalProjectRoleFully(options: UpdateGlobalProjectRoleFullyRequest): Promise; /** * Deletes a role. May return 403 in the future. * Alternative usage: Role.Project.deleteRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-deleteProjectRole * @param options Request options. */ deleteGlobalProjectRole(options: DeleteGlobalProjectRoleRequest): Promise; /** * Gets default actors for the given role. * Alternative usage: Role.Project.Actor.getActors * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-getProjectRoleActorsForRole * @param options Request options. */ getGlobalProjectRoleActors(options: GetGlobalProjectRoleActorsRequest): Promise; /** * Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add. * Alternative usage: Role.Project.Actor.addActors * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-addProjectRoleActorsToRole * @param options Request options. */ addGlobalProjectRoleActors(options: AddGlobalProjectRoleActorsRequest): Promise; /** * Removes default actor from the given role. * Alternative usage: Role.Project.Actor.deleteActors * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-deleteProjectRoleActorsFromRole * @param options Request options. */ deleteGlobalProjectRoleActors(options: DeleteGlobalProjectRoleActorsRequest): Promise; /** * Returns a user. * Alternative usage: User.getUser * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-getUser * @param options Request options. */ getUser(options?: GetUserRequest): Promise; /** * Modify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed. * Alternative usage: User.updateUser * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-updateUser * @param options Request options. */ updateUser(options: UpdateUserRequest): Promise; /** * Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated. * Alternative usage: User.createUser * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-createUser * @param options Request options. */ createUser(options: CreateUserRequest): Promise; /** * Removes user and its references (like project roles associations, watches, history). * Alternative usage: User.removeUser * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-removeUser * @param options Request options. */ removeUser(options: RemoveUserRequest): Promise; /** * Add user to given application. Admin permission will be required to perform this operation. * Alternative usage: User.addUserToApplication * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-addUserToApplication * @param options Request options. */ addUserToApplication(options: AddUserToApplicationRequest): Promise; /** * Remove user from given application. Admin permission will be required to perform this operation. * Alternative usage: User.removeUserFromApplication * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-removeUserFromApplication * @param options Request options. */ removeUserFromApplication(options: RemoveUserFromApplicationRequest): Promise; /** * Modify user password. * Alternative usage: User.changeUserPassword * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-changeUserPassword * @param options Request options. */ changeUserPassword(options: ChangeUserPasswordRequest): Promise; /** * Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing. * Alternative usage: User.Search.findAssignableUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findAssignableUsers * @param options Request options. */ findAssignableUsers(options?: FindAssignableUsersRequest): Promise; /** * Returns a list of active users that match the search string and have all specified permissions for the project or issue. * This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights. * Alternative usage: User.Search.findUsersWithAllPermissions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsersWithAllPermissions * @param options Request options. */ findUsersWithAllPermissions(options: FindUsersWithAllPermissionsRequest): Promise; /** * Returns a list of users that match the search string. This resource cannot be accessed anonymously. * Alternative usage: User.Search.findUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsers * @param options Request options. */ findUsers(options: FindUsersRequest): Promise; /** * Returns a list of active users that match the search string. This resource cannot be accessed anonymously and requires the Browse Users global permission. Given an issue key this resource will provide a list of users that match the search string and have the browse issue permission for the issue provided. * Alternative usage: User.Search.findUsersWithBrowsePermission * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsersWithBrowsePermission * @param options Request options. */ findUsersWithBrowsePermission(options: FindUsersWithBrowsePermissionRequest): Promise; /** * Gets available fields for screen. i.e ones that haven't already been added. * Alternative usage: Screen.getFieldsToAdd * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getFieldsToAdd * @param options Request options. */ getScreenFieldsToAdd(options: GetScreenFieldsToAddRequest): Promise; /** * Gets available field screens. * Alternative usage: Screen.getScreens * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllScreens * @param options Request options. */ getScreens(options: GetScreensRequest): Promise; /** * Creates tab for given screen. * Alternative usage: Screen.Tab.addTab * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addTab * @param options Request options. */ addScreenTab(options: AddScreenTabRequest): Promise; /** * Returns a list of all tabs for the given screen. * Alternative usage: Screen.Tab.getTabs * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllTabs * @param options Request options. */ getScreenTabs(options: GetScreenTabsRequest): Promise; /** * Renames tab on given screen. * Alternative usage: Screen.Tab.renameTab * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-renameTab * @param options Request options. */ renameScreenTab(options: RenameScreenTabRequest): Promise; /** * Deletes tab to give screen. * Alternative usage: Screen.Tab.deleteTab * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-deleteTab * @param options Request options. */ deleteScreenTab(options: DeleteScreenTabRequest): Promise; /** * Moves tab position. * Alternative usage: Screen.Tab.moveTab * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-moveTab * @param options Request options. */ moveScreenTab(options: MoveScreenTabRequest): Promise; /** * Gets all fields for a given tab. * Alternative usage: Screen.Field.getFields * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllFields * @param options Request options. */ getScreenFields(options: GetScreenFieldsRequest): Promise; /** * Adds field to the given tab. * Alternative usage: Screen.Field.addField * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addField * @param options Request options. */ addScreenField(options: AddScreenFieldRequest): Promise; /** * Removes field from given tab. * Alternative usage: Screen.Field.removeField * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-removeField * @param options Request options. */ removeScreenField(options: RemoveScreenFieldRequest): Promise; /** * Moves field on the given tab. * Alternative usage: Screen.Field.moveField * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-moveField * @param options Request options. */ moveScreenField(options: MoveScreenFieldRequest): Promise; /** * Adds field or custom field to the default tab. * Alternative usage: Screen.Field.addToDefaultScreen * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addFieldToDefaultScreen * @param options Request options. */ addFieldToDefaultScreen(options: AddFieldToDefaultScreenRequest): Promise; /** * Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access. * Alternative usage: Project.getProjects * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getAllProjects * @param options Request options. */ getProjects(options?: GetProjectsRequest): Promise; /** * Creates a new project. * Alternative usage: Project.createProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-createProject * @param options Request options. */ createProject(options: CreateProjectRequest): Promise; /** * Contains a full representation of a project in JSON format. * Alternative usage: Project.getProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProject * @param options Request options. */ getProject(options: GetProjectRequest): Promise; /** * Updates a project. Only non null values sent in JSON will be updated in the project. * Alternative usage: Project.updateProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-updateProject * @param options Request options. */ updateProject(options: UpdateProjectRequest): Promise; /** * Deletes a project. * Alternative usage: Project.deleteProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-deleteProject * @param options Request options. */ deleteProject(options: DeleteProjectRequest): Promise; /** * Archives a project. For DC only. * Alternative usage: Project.archiveProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-archiveProject * @param options Request options. */ archiveProject(options: ArchiveProjectRequest): Promise; /** * Contains a full representation of a the specified project's components. * Alternative usage: Project.getComponents * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectComponents * @param options Request options. */ getProjectComponents(options: GetProjectComponentsRequest): Promise; /** * Restore an archived project. In case of success restored project should be re-indexed. For DC only. * Alternative usage: Project.restoreProject * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-restoreProject * @param options Request options. */ restoreProject(options: RestoreProjectRequest): Promise; /** * Get all issue types with valid status values for a project. * Alternative usage: Project.getStatuses * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getAllStatuses * @param options Request options. */ getProjectStatuses(options: GetProjectStatusesRequest): Promise; /** * Updates the type of a project. * Alternative usage: Project.updateProjectType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-updateProjectType * @param options Request options. */ updateProjectType(options: UpdateProjectTypeRequest): Promise; /** * Returns all versions for the specified project. Results are paginated. * Alternative usage: Project.getVersionsPaginated * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectVersionsPaginated * @param options Request options. */ getProjectVersionsPaginated(options: GetProjectVersionsPaginatedRequest): Promise; /** * Contains a full representation of a the specified project's versions. * Alternative usage: Project.getVersions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectVersions * @param options Request options. */ getProjectVersions(options: GetProjectVersionsRequest): Promise; /** * Gets a full representation of a priority scheme in JSON format used by specified project. * Alternative usage: Project.Priority.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/priorityscheme-getAssignedPriorityScheme * @param options Request options. */ getPriorityScheme(options: GetPrioritySchemeRequest): Promise; /** * Resource for associating permission schemes and projects. * Alternative usage: Project.Permission.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/permissionscheme-getAssignedPermissionScheme * @param options Request options. */ getProjectPermissionScheme(options: GetProjectPermissionSchemeRequest): Promise; /** * Gets a notification scheme associated with the project. * Alternative usage: Project.Notification.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/notificationscheme-getNotificationScheme * @param options Request options. */ getProjectNotificationScheme(options: GetProjectNotificationSchemeRequest): Promise; /** * Returns the issue security scheme for project. * Alternative usage: Project.Issue.Security.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/issuesecuritylevelscheme-getIssueSecurityScheme * @param options Request options. */ getProjectIssueSecurityScheme(options: GetProjectIssueSecuritySchemeRequest): Promise; /** * Create a version via POST. * Alternative usage: Project.Version.createVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-createVersion * @param options Request options. */ createProjectVersion(options: CreateProjectVersionRequest): Promise; /** * Modify a version's sequence within a project. * Alternative usage: Project.Version.moveVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-moveVersion * @param options Request options. */ moveProjectVersion(options: MoveProjectVersionRequest): Promise; /** * Returns a project version. * Alternative usage: Project.Version.getVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersion * @param options Request options. */ getProjectVersion(options: GetProjectVersionRequest): Promise; /** * Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored. * Alternative usage: Project.Version.updateVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-updateVersion * @param options Request options. */ updateProjectVersion(options: UpdateProjectVersionRequest): Promise; /** * Delete a project version. * Alternative usage: Project.Version.deleteVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-delete * @param options Request options. */ deleteProjectVersion(options: DeleteProjectVersionRequest): Promise; /** * Merge versions. * Alternative usage: Project.Version.mergeVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-merge * @param options Request options. */ mergeProjectVersion(options: MergeProjectVersionRequest): Promise; /** * Delete a project version. * Alternative usage: Project.Version.removeAndReplaceVersion * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-delete * @param options Request options. */ removeAndReplaceProjectVersion(options: RemoveAndReplaceProjectVersionRequest): Promise; /** * Returns a bean containing the number of fixed in and affected issues for the given version. * Alternative usage: Project.Version.Count.getVersionRelatedIssueCount * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersionRelatedIssues * @param options Request options. */ getProjectVersionRelatedIssueCount(options: GetProjectVersionRelatedIssueCountRequest): Promise; /** * Returns the number of unresolved issues for the given version * Alternative usage: Project.Version.Count.getVersionUnresolvedIssueCount * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersionUnresolvedIssues * @param options Request options. */ getProjectVersionUnresolvedIssueCount(options: GetProjectVersionUnresolvedIssueCountRequest): Promise; /** * Returns the remote version links associated with the given version ID. * Alternative usage: Project.Version.Remote.getLinksById * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-getRemoteVersionLinksByVersionId * @param options Request options. */ getRemoteVersionLinksById(options: GetRemoteVersionLinksByIdRequest): Promise; /** * Create a remote version link via POST. * Alternative usage: Project.Version.Remote.createOrUpdateLinkById * The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-createOrUpdateRemoteVersionLink * @param options Request options. */ createOrUpdateRemoteVersionLinkById(options: CreateOrUpdateRemoteVersionLinkByIdRequest): Promise; /** * Delete all remote version links for a given version ID. * Alternative usage: Project.Version.Remote.deleteLinksById * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-deleteRemoteVersionLinksByVersionId * @param options Request options. */ deleteRemoteVersionLinksById(options: DeleteRemoteVersionLinksByIdRequest): Promise; /** * A REST sub-resource representing a remote version link. * Alternative usage: Project.Version.Remote.getLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-getRemoteVersionLink * @param options Request options. */ getRemoteVersionLink(options: GetRemoteVersionLinkRequest): Promise; /** * Create a remote version link via POST. * Alternative usage: Project.Version.Remote.createOrUpdateLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-createOrUpdateRemoteVersionLink * @param options Request options. */ createOrUpdateRemoteVersionLink(options: CreateOrUpdateRemoteVersionLinkRequest): Promise; /** * Delete a specific remote version link with the given version ID and global ID. * Alternative usage: Project.Version.Remote.deleteLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-deleteRemoteVersionLink * @param options Request options. */ deleteRemoteVersionLink(options: DeleteRemoteVersionLinkRequest): Promise; /** * Delete a specific remote version link with the given version ID and global ID. * Alternative usage: Project.Version.Remote.deleteLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-deleteRemoteVersionLink * @param options Request options. */ getRemoteVersionLinks(options: GetRemoteVersionLinksRequest): Promise; /** * Validates a project key. * Alternative usage: Project.Validation.validateProjectKey * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#projectvalidate-getProject * @param options Request options. */ validateProjectKey(options: ValidateProjectKeyRequest): Promise; /** * Returns all the project types defined on the JIRA instance, not taking into account whether the license to use those project types is valid or not. * Alternative usage: Project.Type.getTypes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getAllProjectTypes * @param options Request options. */ getProjectTypes(options?: GetProjectTypesRequest): Promise; /** * Returns the project type with the given key. * Alternative usage: Project.Type.getType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getProjectTypeByKey * @param options Request options. */ getProjectType(options: GetProjectTypeRequest): Promise; /** * Returns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the Application that defines the project type. * Alternative usage: Project.Type.getAccessibleType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getAccessibleProjectTypeByKey * @param options Request options. */ getAccessibleProjectType(options: GetAccessibleProjectTypeRequest): Promise; /** * Returns all security levels for the project that the current logged in user has access to. * Alternative usage: Project.Security.getLevels * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/securitylevel-getSecurityLevelsForProject * @param options Request options. */ getProjectSecurityLevels(options: GetProjectSecurityLevelsRequest): Promise; /** * Returns all roles in the given project Id or key, with links to full details on each role. * Alternative usage: Project.Role.getRoles * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-getProjectRoles * @param options Request options. */ getProjectRoles(options: GetProjectRolesRequest): Promise; /** * Returns the details for a given project role in a project. * Alternative usage: Project.Role.getRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-getProjectRole * @param options Request options. */ getProjectRole(options: GetProjectRoleRequest): Promise; /** * Updates a project role to include the specified actors (users or groups). * Alternative usage: Project.Role.Actor.setActors * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-setActors * @param options Request options. */ setProjectRoleActors(options: SetProjectRoleActorsRequest): Promise; /** * Adds an actor (user or group) to a project role. * Alternative usage: Project.Role.Actor.addUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-addActorUsers * @param options Request options. */ addProjectRoleActorUsers(options: AddProjectRoleActorUsersRequest): Promise; /** * Deletes actors (users or groups) from a project role. * Delete a user from the role: /rest/api/2/project/{projectIdOrKey}/role/{roleId}?user={username} * Delete a group from the role: /rest/api/2/project/{projectIdOrKey}/role/{roleId}?group={groupname} * Alternative usage: Project.Role.Actor.deleteActor * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-deleteActor * @param options Request options. */ deleteProjectRoleActor(options: DeleteProjectRoleActorRequest): Promise; /** * Create a component via POST. * Alternative usage: Project.Component.createComponent * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-createComponent * @param options Request options. */ createProjectComponent(options: CreateProjectComponentRequest): Promise; /** * Returns a project component. * Alternative usage: Project.Component.getComponent * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-getComponent * @param options Request options. */ getProjectComponent(options: GetProjectComponentRequest): Promise; /** * Modify a component via PUT. If leadUserName is an empty string ("") the component lead will be removed. * Alternative usage: Project.Component.updateComponent * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-updateComponent * @param options Request options. */ updateProjectComponent(options: UpdateProjectComponentRequest): Promise; /** * Delete a project component. * Alternative usage: Project.Component.deleteComponent * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-delete * @param options Request options. */ deleteProjectComponent(options: DeleteProjectComponentRequest): Promise; /** * Returns counts of issues related to this component. * Alternative usage: Project.Component.getRelatedIssueCount * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-getComponentRelatedIssues * @param options Request options. */ getProjectComponentRelatedIssueCount(options: GetProjectComponentRelatedIssueCountRequest): Promise; /** * Returns all permissions in the system and whether the currently logged in user has them. * You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId). * Alternative usage: Permission.getMyPermissions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#-getPermissions * @param options Request options. */ getMyPermissions(options?: GetMyPermissionsRequest): Promise; /** * Returns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins * Alternative usage: Permission.getPermissions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#-getAllPermissions * @param options Request options. */ getPermissions(options?: GetPermissionsRequest): Promise; /** * Returns a permission scheme identified by the given id. * Alternative usage: Permission.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionScheme * @param options Request options. */ getPermissionSchemes(options?: GetPermissionSchemesRequest): Promise; /** * Create a new permission scheme. This method can create schemes with a defined permission set, or without. * Alternative usage: Permission.Scheme.createScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-createPermissionScheme * @param options Request options. */ createPermissionScheme(options: CreatePermissionSchemeRequest): Promise; /** * Returns a permission scheme identified by the given id. * Alternative usage: Permission.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionScheme * @param options Request options. */ getPermissionScheme(options: GetPermissionSchemeRequest): Promise; /** * Deletes a permission scheme identified by the given id. * Alternative usage: Permission.Scheme.deleteScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-deletePermissionScheme * @param options Request options. */ deletePermissionScheme(options: DeletePermissionSchemeRequest): Promise; /** * Updates a permission scheme. * If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. * Sending an empty list will remove all permission grants from the permission scheme. * To update just the name and description, do not send permissions list at all. * Alternative usage: Permission.Scheme.updateScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-updatePermissionScheme * @param options Request options. */ updatePermissionScheme(options: UpdatePermissionSchemeRequest): Promise; /** * Returns scheme attribute. * Alternative usage: Permission.Scheme.Attribute.getAttribute * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getSchemeAttribute * @param options Request options. */ getPermissionSchemeAttribute(options: GetPermissionSchemeAttributeRequest): Promise; /** * Returns all permission grants of the given permission scheme. * Alternative usage: Permission.Scheme.Grant.getGrants * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemeGrants * @param options Request options. */ getPermissionSchemeGrants(options: GetPermissionSchemeGrantsRequest): Promise; /** * Creates a permission grant in a permission scheme. * Alternative usage: Permission.Scheme.Grant.createGrant * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-createPermissionGrant * @param options Request options. */ createPermissionSchemeGrant(options: CreatePermissionSchemeGrantRequest): Promise; /** * Deletes a permission grant from a permission scheme. * Alternative usage: Permission.Scheme.Grant.deleteGrant * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-deletePermissionSchemeEntity * @param options Request options. */ deletePermissionSchemeGrant(options: DeletePermissionSchemeGrantRequest): Promise; /** * Returns a permission grant identified by the given id. * Alternative usage: Permission.Scheme.Grant.getGrant * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemeGrant * @param options Request options. */ getPermissionSchemeGrant(options: GetPermissionSchemeGrantRequest): Promise; /** * Sets preference of the currently logged in user. * Preference key must be provided as input parameters (key). * Value must be provided as post body. If key or value parameter is not provided - status code 404. * If preference is set - status code 204. * Alternative usage: Issue.Myself.setPreference * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-setPreference * @param options Request options. */ setMyPreference(options: SetMyPreferenceRequest): Promise; /** * Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). * If key parameter is not provided or wrong - status code 404. * If preference is unset - status code 204. * Alternative usage: Issue.Myself.removePreference * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-removePreference * @param options Request options. */ removeMyPreference(options: RemoveMyPreferenceRequest): Promise; /** * Returns preference of the currently logged in user. * Preference key must be provided as input parameter (key). * The value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. * If value is found - status code 200. * Alternative usage: Issue.Myself.getPreference * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-getPreference * @param options Request options. */ getMyPreference(options: GetMyPreferenceRequest): Promise; /** * Returns currently logged in user. * Alternative usage: Myself.getCurrentUser * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#myself-getUser * @param options Request options. */ getCurrentUser(options?: GetCurrentUserRequest): Promise; /** * Returns a paginated list of notification schemes. * Alternative usage: Issue.Notification.Scheme.getSchemes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#notificationscheme-getNotificationSchemes * @param options Request options. */ getNotificationSchemes(options?: GetNotificationSchemesRequest): Promise; /** * Returns a full representation of the notification scheme for the given id. * Alternative usage: Issue.Notification.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#notificationscheme-getNotificationScheme * @param options Request options. */ getNotificationScheme(options: GetNotificationSchemeRequest): Promise; /** * Returns all issue security schemes that are defined. * Alternative usage: Issue.Security.Scheme.getSchemes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuesecurityschemes-getIssueSecuritySchemes * @param options Request options. */ getIssueSecuritySchemes(options?: GetIssueSecuritySchemesRequest): Promise; /** * Returns the issue security scheme along with that are defined. * Alternative usage: Issue.Security.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuesecurityschemes-getIssueSecurityScheme * @param options Request options. */ getIssueSecurityScheme(options: GetIssueSecuritySchemeRequest): Promise; /** * Returns all work logs for an issue. Work logs won't be returned if the Log work field is hidden for the project. * Alternative usage: Issue.Worklog.getWorklogs * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssueWorklog * @param options Request options. */ getIssueWorklogs(options: GetIssueWorklogsRequest): Promise; /** * Adds a new worklog entry to an issue. * Alternative usage: Issue.Worklog.addWorklog * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addWorklog * @param options Request options. */ addIssueWorklog(options: AddIssueWorklogRequest): Promise; /** * Returns a specific worklog. The work log won't be returned if the Log work field is hidden for the project. * Alternative usage: Issue.Worklog.getWorklog * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getWorklog * @param options Request options. */ getIssueWorklog(options: GetIssueWorklogRequest): Promise; /** * Updates an existing worklog entry. Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds. Either timeSpent or timeSpentSeconds can be set. Fields which are not set will not be updated. For a request to be valid, it has to have at least one field change. * Alternative usage: Issue.Worklog.updateWorklog * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateWorklog * @param options Request options. */ updateIssueWorklog(options: UpdateIssueWorklogRequest): Promise; /** * Deletes an existing worklog entry. * Alternative usage: Issue.Worklog.deleteWorklog * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteWorklog * @param options Request options. */ deleteIssueWorklog(options: DeleteIssueWorklogRequest): Promise; /** * Returns worklogs id and delete time of worklogs that was deleted since given time. The returns set of worklogs is limited to 1000 elements. This API will not return worklogs deleted during last minute. * Alternative usage: Issue.Worklog.getDeletedWorklogIds * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getIdsOfWorklogsDeletedSince * @param options Request options. */ getDeletedIssueWorklogIds(options?: GetDeletedIssueWorklogIdsRequest): Promise; /** * Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result. The returns set of worklogs is limited to 1000 elements. * Alternative usage: Issue.Worklog.getWorklogsForIds * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getWorklogsForIds * @param options Request options. */ getIssueWorklogsForIds(options: GetIssueWorklogsForIdsRequest): Promise; /** * Returns worklogs id and update time of worklogs that was updated since given time. The returns set of worklogs is limited to 1000 elements. This API will not return worklogs updated during last minute. * Alternative usage: Issue.Worklog.getUpdatedWorklogIds * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getIdsOfWorklogsModifiedSince * @param options Request options. */ getUpdatedIssueWorklogIds(options?: GetUpdatedIssueWorklogIdsRequest): Promise; /** * Returns the list of watchers for the issue with the given key. * Alternative usage: Issue.Watcher.getWatchers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssueWatchers * @param options Request options. */ getIssueWatchers(options: GetIssueWatchersRequest): Promise; /** * Adds a user to an issue's watcher list. * Alternative usage: Issue.Watcher.addWatcher * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addWatcher * @param options Request options. */ addIssueWatcher(options: AddIssueWatcherRequest): Promise; /** * Removes a user from an issue's watcher list. * Alternative usage: Issue.Watcher.removeWatcher * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-removeWatcher * @param options Request options. */ removeIssueWatcher(options: RemoveIssueWatcherRequest): Promise; /** * Remove your vote from an issue. (i.e. "unvote"). * Alternative usage: Issue.Vote.removeVote * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-removeVote * @param options Request options. */ removeIssueVote(options: RemoveIssueVoteRequest): Promise; /** * Cast your vote in favour of an issue. * Alternative usage: Issue.Vote.addVote * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addVote * @param options Request options. */ addIssueVote(options: AddIssueVoteRequest): Promise; /** * A REST sub-resource representing the voters on the issue. * Alternative usage: Issue.Vote.getVotes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getVotes * @param options Request options. */ getIssueVotes(options: GetIssueVotesRequest): Promise; /** * Returns a list of all issue types visible to the user. * Alternative usage: Issue.Type.getTypes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getIssueAllTypes * @param options Request options. */ getIssueTypes(options?: GetIssueTypesRequest): Promise; /** * Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme. * Alternative usage: Issue.Type.createType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-createIssueType * @param options Request options. */ createIssueType(options: CreateIssueTypeRequest): Promise; /** * Returns a full representation of the issue type that has the given id. * Alternative usage: Issue.Type.getType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getIssueType * @param options Request options. */ getIssueType(options: GetIssueTypeRequest): Promise; /** * Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter. * You can determine the alternative issue types by calling the /rest/api/2/issuetype/{id}/alternatives resource. * Alternative usage: Issue.Type.deleteType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-deleteIssueType * @param options Request options. */ deleteIssueType(options: DeleteIssueTypeRequest): Promise; /** * Updates the specified issue type from a JSON representation. * Alternative usage: Issue.Type.updateType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-updateIssueType * @param options Request options. */ updateIssueType(options: UpdateIssueTypeRequest): Promise; /** * Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given issue type can be migrated. * The suitable alternatives are issue types which are assigned to the same workflow, the same field configuration and the same screen scheme. * Alternative usage: Issue.Type.getAlternativeTypes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getAlternativeIssueTypes * @param options Request options. */ getAlternativeIssueTypes(options: GetAlternativeIssueTypesRequest): Promise; /** * Creates an issue type scheme from a JSON representation. (Admin required) * Alternative usage: Issue.Type.Scheme.createScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-createIssueTypeScheme * @param options Request options. */ createIssueTypeScheme(options: CreateIssueTypeSchemeRequest): Promise; /** * Returns a list of all issue type schemes visible to the user (must be admin). * All issue types associated with the scheme will only be returned if an additional query parameter is provided: expand=schemes.issueTypes. * Similarly, the default issue type associated with the scheme (if one exists) will only be returned if additional an query parameter is provided: expand=schemes.defaultIssueType. * Note that both query parameters can be used together: expand=schemes.issueTypes,schemes.defaultIssueType. * Alternative usage: Issue.Type.Scheme.getSchemes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getAllIssueTypeSchemes * @param options Request options. */ getIssueTypeSchemes(options?: GetIssueTypeSchemesRequest): Promise; /** * Returns a full representation of the issue type scheme that has the given id (must be admin). * Alternative usage: Issue.Type.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getIssueTypeScheme * @param options Request options. */ getIssueTypeScheme(options: GetIssueTypeSchemeRequest): Promise; /** * Updates the specified issue type scheme from a JSON representation. (Admin required) * Alternative usage: Issue.Type.Scheme.updateScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-updateIssueTypeScheme * @param options Request options. */ updateIssueTypeScheme(options: UpdateIssueTypeSchemeRequest): Promise; /** * Deletes the specified issue type scheme. * Any projects associated with this IssueTypeScheme will be automatically associated with the global default IssueTypeScheme. (Admin required) * Alternative usage: Issue.Type.Scheme.deleteScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-deleteIssueTypeScheme * @param options Request options. */ deleteIssueTypeScheme(options: DeleteIssueTypeSchemeRequest): Promise; /** * Adds additional projects to those already associated with the specified issue type scheme. (Admin required) * Alternative usage: Issue.Type.Scheme.Project.addAssociations * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-addProjectAssociationsToScheme * @param options Request options. */ addProjectAssociationsToIssueTypeScheme(options: AddProjectAssociationsToIssueTypeSchemeRequest): Promise; /** * For the specified issue type scheme, returns all of the associated projects. (Admin required) * Alternative usage: Issue.Type.Scheme.Project.getAssociations * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getAssociatedProjects * @param options Request options. */ getProjectAssociationsForIssueTypeScheme(options: GetProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * Associates the given projects with the specified issue type scheme. * Any existing project-associations the issue type scheme has will be overwritten. (Admin required) * Alternative usage: Issue.Type.Scheme.Project.setAssociations * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-setProjectAssociationsForScheme * @param options Request options. */ setProjectAssociationsForIssueTypeScheme(options: SetProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * Removes all project associations for the specified issue type scheme. * These projects revert to an association with the default/global issue type scheme.(Admin required) * Alternative usage: Issue.Type.Scheme.Project.removeAssociations * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-removeAllProjectAssociations * @param options Request options. */ removeProjectAssociationsForIssueTypeScheme(options: RemoveProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * For the specified issue type scheme, removes the given project association. * This project reverts to an association with the default/global issue type scheme.(Admin required) * Alternative usage: Issue.Type.Scheme.Project.removeAssociation * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-removeProjectAssociation * @param options Request options. */ removeProjectAssociationForIssueTypeScheme(options: RemoveProjectAssociationForIssueTypeSchemeRequest): Promise; /** * Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types. * Fields will only be returned if expand=transitions.fields. * The fields in the metadata correspond to the fields in the transition screen for that transition. Fields not in the screen will not be in the metadata. * Alternative usage: Issue.Transition.getTransitions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getTransitions * @param options Request options. */ getIssueTransitions(options: GetIssueTransitionsRequest): Promise; /** * Perform a transition on an issue. When performing the transition you can update or set other issue fields. * The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted. The updateHistory param adds the issues retrieved by this method to the current user's issue history, if set to true (by default, the issue history does not include issues retrieved via the REST API). You can view the issue history in the JIRA application, via the Issues dropdown or by using the lastViewed JQL field in an issue search. * Alternative usage: Issue.Transition.performTransition * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-doTransition * @param options Request options. */ performIssueTransition(options: PerformIssueTransitionRequest): Promise; /** * Returns an issue's subtask list. * Alternative usage: Issue.SubTask.getSubTasks * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-getSubTasks * @param options Request options. */ getIssueSubTasks(options: GetIssueSubTasksRequest): Promise; /** * Alternative usage: Issue.SubTask.canMoveSubTask * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-canMoveSubTask * @param options Request options. */ canMoveIssueSubTask(options: CanMoveIssueSubTaskRequest): Promise; /** * Alternative usage: Issue.SubTask.canMoveSubTask * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-canMoveSubTask * @param options Request options. */ moveIssueSubTasks(options: MoveIssueSubTasksRequest): Promise; /** * Performs a search using JQL. * Alternative usage: Issue.Search.searchByJql * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#search-searchUsingSearchRequest * @param options Request options. */ searchIssuesByJql(options: SearchIssuesByJqlRequest): Promise; /** * Returns a list of all resolutions. * Alternative usage: Issue.Resolution.getResolutions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#resolution-getResolutions * @param options Request options. */ getIssueResolutions(options?: GetIssueResolutionsRequest): Promise; /** * Returns a resolution. * Alternative usage: Issue.Resolution.getResolution * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#resolution-getResolution * @param options Request options. */ getIssueResolution(options: GetIssueResolutionRequest): Promise; /** * Returns the keys of all properties for the issue identified by the key or by the id. * Alternative usage: Issue.Property.getPropertyKeys * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-getPropertiesKeys * @param options Request options. */ getIssuePropertyKeys(options: GetIssuePropertyKeysRequest): Promise; /** * Removes the property from the issue identified by the key or by the id. * Ths user removing the property is required to have permissions to edit the issue. * Alternative usage: Issue.Property.deleteProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-deleteProperty * @param options Request options. */ deleteIssueProperty(options: DeleteIssuePropertyRequest): Promise; /** * Sets the value of the specified issue's property. * You can use this resource to store a custom data against the issue identified by the key or by the id. * The user who stores the data is required to have permissions to edit the issue. * Alternative usage: Issue.Property.setProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-setProperty * @param options Request options. */ setIssueProperty(options: SetIssuePropertyRequest): Promise; /** * Returns the value of the property with a given key from the issue identified by the key or by the id. * The user who retrieves the property is required to have permissions to read the issue. * Alternative usage: Issue.Property.getProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-getProperty * @param options Request options. */ getIssueProperty(options: GetIssuePropertyRequest): Promise; /** * Returns a list of all issue priorities. * Alternative usage: Issue.Priority.getPriorities * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#priority-getPriorities * @param options Request options. */ getIssuePriorities(options?: GetIssuePrioritiesRequest): Promise; /** * Returns an issue priority. * Alternative usage: Issue.Priority.getPriority * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#priority-getPriority * @param options Request options. */ getIssuePriority(options: GetIssuePriorityRequest): Promise; /** * Creates new priority scheme. * Alternative usage: Issue.Priority.Scheme.createScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-createPriorityScheme * @param options Request options. */ createIssuePriorityScheme(options: CreateIssuePrioritySchemeRequest): Promise; /** * Returns all priority schemes. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=schemes.projectKeys. * Alternative usage: Issue.Priority.Scheme.getSchemes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-getPrioritySchemes * @param options Request options. */ getIssuePrioritySchemes(options?: GetIssuePrioritySchemesRequest): Promise; /** * Deletes a priority scheme. * All projects using deleted scheme will use default priority scheme afterwards. Default priority scheme can't be deleted. * Alternative usage: Issue.Priority.Scheme.deleteScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-deletePriorityScheme * @param options Request options. */ deleteIssuePriorityScheme(options: DeleteIssuePrioritySchemeRequest): Promise; /** * Updates a priority scheme. * Update will be rejected if issue migration would be needed as a result of scheme update. * Priority scheme update with migration is possible from the UI. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys. * Alternative usage: Issue.Priority.Scheme.updateScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-updatePriorityScheme * @param options Request options. */ updateIssuePriorityScheme(options: UpdateIssuePrioritySchemeRequest): Promise; /** * Gets a full representation of a priority scheme in JSON format. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys. * Alternative usage: Issue.Priority.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-getPriorityScheme * @param options Request options. */ getIssuePriorityScheme(options: GetIssuePrioritySchemeRequest): Promise; /** * Returns the meta data for editing an issue. The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editmeta. * Alternative usage: Issue.Metadata.getEditMetadata * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getEditIssueMeta * @param options Request options. */ getEditIssueMetadata(options: GetEditIssueMetadataRequest): Promise; /** * Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project. * The fields in the createmeta correspond to the fields in the create screen for the project/issuetype. Fields not in the screen will not be in the createmeta. * Fields will only be returned if expand=projects.issuetypes.fields. * The results can be filtered by project and/or issue type, given by the query params. * Alternative usage: Issue.Metadata.getCreateMetadata * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getCreateIssueMeta * @param options Request options. * @deprecated */ getCreateIssueMetadata(options?: GetCreateIssueMetadataRequest): Promise; /** * Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role. * Alternative usage: Issue.Link.createLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-linkIssues * @param options Request options. */ createIssueLink(options: CreateIssueLinkRequest): Promise; /** * Returns an issue link with the specified id. * Alternative usage: Issue.Link.getLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-getIssueLink * @param options Request options. */ getIssueLink(options: GetIssueLinkRequest): Promise; /** * Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues. * Alternative usage: Issue.Link.deleteLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-deleteIssueLink * @param options Request options. */ deleteIssueLink(options: DeleteIssueLinkRequest): Promise; /** * A REST sub-resource representing the remote issue links on the issue. * Alternative usage: Issue.Link.Remote.getLinks * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getRemoteIssueLinks * @param options Request options. */ getRemoteIssueLinks(options: GetRemoteIssueLinksRequest): Promise; /** * Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created. * Alternative usage: Issue.Link.Remote.createOrUpdateLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-createOrUpdateRemoteIssueLink * @param options Request options. */ createOrUpdateRemoteIssueLink(options: CreateOrUpdateRemoteIssueLinkRequest): Promise; /** * Delete the remote issue link with the given global id on the issue. * Alternative usage: Issue.Link.Remote.deleteLinkByGlobalId * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteRemoteIssueLinkByGlobalId * @param options Request options. */ deleteRemoteIssueLinkByGlobalId(options: DeleteRemoteIssueLinkByGlobalIdRequest): Promise; /** * Get the remote issue link with the given id on the issue. * Alternative usage: Issue.Link.Remote.getLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getRemoteIssueLinkById * @param options Request options. */ getRemoteIssueLink(options: GetRemoteIssueLinkRequest): Promise; /** * Updates a remote issue link from a JSON representation. Any fields not provided are set to null. * Alternative usage: Issue.Link.Remote.updateLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateRemoteIssueLink * @param options Request options. */ updateRemoteIssueLink(options: UpdateRemoteIssueLinkRequest): Promise; /** * Delete the remote issue link with the given id on the issue. * Alternative usage: Issue.Link.Remote.deleteLink * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteRemoteIssueLinkById * @param options Request options. */ deleteRemoteIssueLink(options: DeleteRemoteIssueLinkRequest): Promise; /** * Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship. * Alternative usage: Issue.Link.Type.getTypes * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-getIssueLinkTypes * @param options Request options. */ getIssueLinkTypes(options?: GetIssueLinkTypesRequest): Promise; /** * Returns for a given issue link type id all information about this issue link type. * Alternative usage: Issue.Link.Type.getType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-getIssueLinkType * @param options Request options. */ getIssueLinkType(options: GetIssueLinkTypeRequest): Promise; /** * Create a new issue link type. * Alternative usage: Issue.Link.Type.createType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-createIssueLinkType * @param options Request options. */ createIssueLinkType(options: CreateIssueLinkTypeRequest): Promise; /** * Delete the specified issue link type. * Alternative usage: Issue.Link.Type.deleteType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-deleteIssueLinkType * @param options Request options. */ deleteIssueLinkType(options: DeleteIssueLinkTypeRequest): Promise; /** * Update the specified issue link type. * Alternative usage: Issue.Link.Type.updateType * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-updateIssueLinkType * @param options Request options. */ updateIssueLinkType(options: UpdateIssueLinkTypeRequest): Promise; /** * Returns a list of all fields, both System and Custom. * Alternative usage: Issue.Field.getFields * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#field-getFields * @param options Request options. */ getIssueFields(options: GetIssueFieldsRequest): Promise; /** * Alternative: Issue.Field.Custom.getFields * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#customFields-getCustomFields * @param options Request options. */ getIssueCustomFields(options?: GetIssueCustomFieldsRequest): Promise; /** * Returns a full representation of the Custom Field Option that has the given id. * Alternative: Issue.Field.Custom.Option.getOption * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#customFieldOption-getCustomFieldOption * @param options Request options. */ getIssueCustomFieldOption(options: GetIssueCustomFieldOptionRequest): Promise; /** * Returns the meta-data for an attachment, including the URI of the actual attached file. * Alternative usage: Issue.Attachment.getAttachment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-getAttachment * @param options Request options. */ getIssueAttachment(options: GetIssueAttachmentRequest): Promise; /** * Remove an attachment from an issue. * Alternative usage: Issue.Attachment.removeAttachment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-removeAttachment * @param options Request options. */ removeIssueAttachment(options: RemoveIssueAttachmentRequest): Promise; /** * Add one or more attachments to an issue. * Alternative usage: Issue.Attachment.addAttachment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/attachments-addAttachment * @param options Request options. */ addIssueAttachment(options: AddIssueAttachmentRequest): Promise; /** * Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size allowed. * Alternative usage: Issue.Attachment.Metadata.getMetadata * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-getAttachmentMeta * @param options Request options. */ getIssueAttachmentMetadata(options?: GetIssueAttachmentMetadataRequest): Promise; /** * Returns the keys of all properties for the comment identified by the key or by the id. * Alternative usage: Issue.Comment.Property.getPropertyKeys * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-getPropertiesKeys * @param options Request options. */ getIssueCommentPropertyKeys(options: GetIssueCommentPropertyKeysRequest): Promise; /** * Removes the property from the comment identified by the key or by the id. * Ths user removing the property is required to have permissions to administer the comment. * Alternative usage: Issue.Comment.Property.deleteProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-deleteProperty * @param options Request options. */ deleteIssueCommentProperty(options: DeleteIssueCommentPropertyRequest): Promise; /** * Sets the value of the specified comment's property. * You can use this resource to store a custom data against the comment identified by the key or by the id. * The user who stores the data is required to have permissions to administer the comment. * Alternative usage: Issue.Comment.Property.setProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-setProperty * @param options Request options. */ setIssueCommentProperty(options: SetIssueCommentPropertyRequest): Promise; /** * Sets the value of the specified comment's property. * You can use this resource to store a custom data against the comment identified by the key or by the id. * The user who stores the data is required to have permissions to administer the comment. * Alternative usage: Issue.Comment.Property.setProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-setProperty * @param options Request options. */ getIssueCommentProperty(options: GetIssueCommentPropertyRequest): Promise; /** * Returns an application property. * Alternative usage: Instance.getApplicationProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getProperty * @param options Request options. */ getApplicationProperty(options?: GetApplicationPropertyRequest): Promise; /** * Modify an application property via PUT. The "value" field present in the PUT will override the existing value. * Alternative usage: Instance.setApplicationProperty * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-setPropertyViaRestfulTable * @param options Request options. */ setApplicationProperty(options: SetApplicationPropertyRequest): Promise; /** * Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. * Alternative usage: Instance.getAdvancedSettings * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getAdvancedSettings * @param options Request options. */ getAdvancedSettings(options?: GetAdvancedSettingsRequest): Promise; /** * Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. * Alternative usage: Instance.getAdvancedSettings * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getAdvancedSettings * @param options Request options. */ getInstanceConfiguration(options?: GetInstanceConfigurationRequest): Promise; /** * Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. * Alternative usage: Instance.getAdvancedSettings * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getAdvancedSettings * @param options Request options. */ getInstanceInfo(options?: GetInstanceInfoRequest): Promise; /** * Creates a group by given group parameter. * Alternative usage: Group.createGroup * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-createGroup * @param options Request options. */ createGroup(options: CreateGroupRequest): Promise; /** * Deletes a group by given group parameter. * Alternative usage: Group.removeGroup * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-removeGroup * @param options Request options. */ removeGroup(options?: RemoveGroupRequest): Promise; /** * This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions. * Alternative usage: Group.User.getUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-getUsersFromGroup * @param options Request options. */ getUsersFromGroup(options: GetUsersFromGroupRequest): Promise; /** * Adds given user to a group. * Alternative usage: Group.User.addUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-addUserToGroup * @param options Request options. */ addUsersToGroup(options: AddUsersToGroupRequest): Promise; /** * Removes given user from a group. * Alternative usage: Group.User.removeUsers * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-removeUserFromGroup * @param options Request options. */ removeUsersFromGroup(options?: RemoveUsersFromGroupRequest): Promise; /** * Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions. * Alternative usage: Filter.createFilter * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-createFilter * @param options Request options. */ createFilter(options: CreateFilterRequest): Promise; /** * Returns a filter given an id. * Alternative usage: Filter.getFilter * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getFilter * @param options Request options. */ getFilter(options: GetFilterRequest): Promise; /** * Updates an existing filter, and returns its new value. * Alternative usage: Filter.editFilter * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-editFilter * @param options Request options. */ editFilter(options: EditFilterRequest): Promise; /** * Delete a filter. * Alternative usage: Filter.deleteFilter * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-deleteFilter * @param options Request options. */ deleteFilter(options: DeleteFilterRequest): Promise; /** * Returns the favourite filters of the logged-in user. * Alternative usage: Filter.getMyFavouriteFilters * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getFavouriteFilters * @param options Request options. */ getMyFavouriteFilters(options?: GetMyFavouriteFiltersRequest): Promise; /** * Returns the default share scope of the logged-in user. * Alternative usage: Filter.Share.getShareScope * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getDefaultShareScope * @param options Request options. */ getDefaultShareScope(options?: GetDefaultShareScopeRequest): Promise; /** * Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE. * Alternative usage: Filter.Share.setShareScope * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-setDefaultShareScope * @param options Request options. */ setDefaultShareScope(options: SetDefaultShareScopeRequest): Promise; /** * Returns the default columns for the given filter. Currently logged in user will be used as the user making such request. * Alternative usage: Filter.Column.getDefaultColumns * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-defaultColumns * @param options Request options. */ getFilterDefaultColumns(options: GetFilterDefaultColumnsRequest): Promise; /** * Sets the default columns for the given filter. * Alternative usage: Filter.Column.setDefaultColumns * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-setColumns * @param options Request options. */ setFilterDefaultColumns(options: SetFilterDefaultColumnsRequest): Promise; /** * Resets the columns for the given filter such that the filter no longer has its own column config. * Alternative usage: Filter.Column.resetColumns * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-resetColumns * @param options Request options. */ resetFilterColumns(options: ResetFilterColumnsRequest): Promise; /** * Returns all share permissions of the given filter. * Alternative usage: Filter.Share.Permission.getSharePermissions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermissions * @param options Request options. */ getFilterSharePermissions(options: GetFilterSharePermissionsRequest): Promise; /** * Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter. * Alternative usage: Filter.Share.Permission.addSharePermission * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-addSharePermission * @param options Request options. */ addFilterSharePermission(options: AddFilterSharePermissionRequest): Promise; /** * Returns a single share permission of the given filter. * Alternative usage: Filter.Share.Permission.getSharePermissions * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermission * @param options Request options. */ getFilterSharePermission(options: GetFilterSharePermissionRequest): Promise; /** * Removes a share permissions from the given filter. * Alternative usage: Filter.Share.Permission.deleteSharePermission * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermission * @param options Request options. */ deleteFilterSharePermission(options: DeleteFilterSharePermissionRequest): Promise; /** * Returns a list of all dashboards, optionally filtering them. * Alternative usage: Dashboard.getDashboards * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#dashboard-list * @param options Request options. */ getAllDashboards(options?: GetAllDashboardsRequest): Promise; /** * Returns a single dashboard. * Alternative usage: Dashboard.getDashboard * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#dashboard-getDashboard * @param options Request options. */ getDashboardById(options: GetDashboardByIdRequest): Promise; /** * Create a new workflow scheme. * The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults. * Alternative usage: Workflow.Scheme.createScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-createScheme * @param options Request options. */ createWorkflowScheme(options: CreateWorkflowSchemeRequest): Promise; /** * Returns the requested workflow scheme to the caller. * Alternative usage: Workflow.Scheme.getScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-getById * @param options Request options. */ getWorkflowScheme(options: GetWorkflowSchemeRequest): Promise; /** * Delete the passed workflow scheme. * Alternative usage: Workflow.Scheme.deleteScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-deleteScheme * @param options Request options. */ deleteWorkflowScheme(options: DeleteWorkflowSchemeRequest): Promise; /** * Update the passed workflow scheme. * The body of the request is a representation of the workflow scheme. * Values not passed are assumed to indicate no change for that field. * Alternative usage: Workflow.Scheme.updateScheme * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-update * @param options Request options. */ updateWorkflowScheme(options: UpdateWorkflowSchemeRequest): Promise; /** * Returns a list of all statuses. * Alternative usage: Workflow.Status.getStatuses * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#status-getStatuses * @param options Request options. */ getWorkflowStatuses(options?: GetWorkflowStatusesRequest): Promise; /** * Returns a full representation of the Status having the given id or name. * Alternative usage: Workflow.Status.getStatus * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#status-getStatus * @param options Request options. */ getWorkflowStatus(options: GetWorkflowStatusRequest): Promise; /** * Returns a list of all status categories. * Alternative usage: Workflow.Status.Category.getCategories * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#statuscategory-getStatusCategories * @param options Request options. */ getWorkflowStatusCategories(options?: GetWorkflowStatusCategoriesRequest): Promise; /** * Returns a full representation of the StatusCategory having the given id or key. * Alternative usage: Workflow.Status.Category.getCategory * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#statuscategory-getStatusCategory * @param options Request options. */ getWorkflowStatusCategory(options: GetWorkflowStatusCategoryRequest): Promise; /** * Returns all workflows. * Alternative usage: Workflow.getWorkflows * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#workflow-getAllWorkflows * @param options Request options. */ getWorkflows(options?: GetWorkflowsRequest): Promise; /** * Returns all ApplicationRoles in the system. * Will also return an ETag header containing a version hash of the collection of ApplicationRoles. * Alternative usage: Application.Role.getRoles * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-getAll * @param options Request options. */ getApplicationRoles(options?: GetApplicationRolesRequest): Promise; /** * Returns the ApplicationRole with passed key if it exists. * Alternative usage: Application.Role.getRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-get * @param options Request options. */ getApplicationRole(options: GetApplicationRoleRequest): Promise; /** * Updates the ApplicationRole with the passed data. * Only the groups and default groups setting of the role may be updated. * Requests to change the key or the name of the role will be silently ignored. * Alternative usage: Application.Role.updateRole * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-put * @param options Request options. */ updateApplicationRole(options: UpdateApplicationRoleRequest): Promise; /** * Creates an issue or a sub-task from a JSON representation. * The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted. * Creating a sub-task is similar to creating a regular issue, with two important differences: * the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and you must provide a parent field in the issue create request containing the id or key of the parent issue. * Alternative usage: Issue.createIssue * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-createIssue * @param options Request options. */ createIssue(options: CreateIssueRequest): Promise; /** * Returns a full representation of the issue for the given issue key. * JIRA will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id, or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect will not be returned). The issue key contained in the response will indicate the current value of issue's key. * Alternative usage: Issue.getIssue * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssue * @param options Request options. */ getIssue(options: GetIssueRequest): Promise; /** * Edits an issue from a JSON representation. * The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value. * The fields that can be updated, in either the fields parameter or the update parameter, can be determined using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource. * If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field validation error will occur if it is submitted. * Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section. * Field should appear either in "fields" or "update", not in both. * Alternative usage: Issue.editIssue * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-editIssue * @param options Request options. */ editIssue(options: EditIssueRequest): Promise; /** * Delete an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted. * Alternative usage: Issue.deleteIssue * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteIssue * @param options Request options. */ deleteIssue(options: DeleteIssueRequest): Promise; /** * Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee. * Alternative usage: Issue.assignIssue * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-assign * @param options Request options. */ assignIssue(options: AssignIssueRequest): Promise; /** * Sends a notification (email) to the list or recipients defined in the request. * Alternative usage: Issue.sendNotification * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-notify * @param options Request options. */ sendNotificationForIssue(options: SendNotificationForIssueRequest): Promise; /** * Returns all comments for an issue. * Alternative usage: Issue.Comment.getComments * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getComments * @param options Request options. */ getIssueComments(options: GetIssueCommentsRequest): Promise; /** * Adds a new comment to an issue. * Alternative usage: Issue.Comment.addComment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addComment * @param options Request options. */ addIssueComment(options: AddIssueCommentRequest): Promise; /** * Returns a single comment. * Alternative usage: Issue.Comment.getComment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getComment * @param options Request options. */ getIssueComment(options: GetIssueCommentRequest): Promise; /** * Updates an existing comment using its JSON representation. * Alternative usage: Issue.Comment.updateComment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateComment * @param options Request options. */ updateIssueComment(options: UpdateIssueCommentRequest): Promise; /** * Deletes an existing comment. * Alternative usage: Issue.Comment.deleteComment * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteComment * @param options Request options. */ deleteIssueComment(options: DeleteIssueCommentRequest): Promise; } declare class IssueGroup { private implementation; private getGlobalErrorStrategy; Comment: CommentGroup; Metadata: MetadataGroup; Link: LinkGroup; Vote: VoteGroup; Watcher: WatcherGroup; Worklog: WorklogGroup; Transition: TransitionGroup; SubTask: SubTaskGroup; Field: FieldGroup; Attachment: AttachmentGroup; Type: TypeGroup; Priority: PriorityGroup; Resolution: ResolutionGroup; Search: SearchGroup; Security: IssueSecurityGroup; Notification: IssueNotificationGroup; Property: IssuePropertyGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates an issue or a sub-task from a JSON representation. * The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted. * Creating a sub-task is similar to creating a regular issue, with two important differences: * the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and you must provide a parent field in the issue create request containing the id or key of the parent issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-createIssue * @param options Request options. */ createIssue(options: CreateIssueRequest): Promise; /** * Returns a full representation of the issue for the given issue key. * JIRA will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id, or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect will not be returned). The issue key contained in the response will indicate the current value of issue's key. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssue * @param options Request options. */ getIssue(options: GetIssueRequest): Promise; /** * Delete an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteIssue * @param options Request options. */ deleteIssue(options: DeleteIssueRequest): Promise; /** * Edits an issue from a JSON representation. * The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value. * The fields that can be updated, in either the fields parameter or the update parameter, can be determined using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource. * If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field validation error will occur if it is submitted. * Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section. * Field should appear either in "fields" or "update", not in both. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-editIssue * @param options Request options. */ editIssue(options: EditIssueRequest): Promise; /** * Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-assign * @param options Request options. */ assignIssue(options: AssignIssueRequest): Promise; /** * Sends a notification (email) to the list or recipients defined in the request. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-notify * @param options Request options. */ sendNotification(options: SendNotificationForIssueRequest): Promise; } declare class CommentGroup { private implementation; private getGlobalErrorStrategy; Property: IssueCommentPropertyGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all comments for an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getComments * @param options Request options. */ getComments(options: GetIssueCommentsRequest): Promise; /** * Adds a new comment to an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addComment * @param options Request options. */ addComment(options: AddIssueCommentRequest): Promise; /** * Returns a single comment. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getComment * @param options Request options. */ getComment(options: GetIssueCommentRequest): Promise; /** * Updates an existing comment using its JSON representation. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateComment * @param options Request options. */ updateComment(options: UpdateIssueCommentRequest): Promise; /** * Deletes an existing comment. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteComment * @param options Request options. */ deleteComment(options: DeleteIssueCommentRequest): Promise; } declare class IssueCommentPropertyGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the keys of all properties for the comment identified by the key or by the id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-getPropertiesKeys * @param options Request options. */ getPropertyKeys(options: GetIssueCommentPropertyKeysRequest): Promise; /** * Removes the property from the comment identified by the key or by the id. * Ths user removing the property is required to have permissions to administer the comment. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-deleteProperty * @param options Request options. */ deleteProperty(options: DeleteIssueCommentPropertyRequest): Promise; /** * Sets the value of the specified comment's property. * You can use this resource to store a custom data against the comment identified by the key or by the id. * The user who stores the data is required to have permissions to administer the comment. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-setProperty * @param options Request options. */ setProperty(options: SetIssueCommentPropertyRequest): Promise; /** * Sets the value of the specified comment's property. * You can use this resource to store a custom data against the comment identified by the key or by the id. * The user who stores the data is required to have permissions to administer the comment. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#comment/{commentId}/properties-setProperty * @param options Request options. */ getProperty(options: GetIssueCommentPropertyRequest): Promise; } declare class AttachmentGroup { private implementation; private getGlobalErrorStrategy; Metadata: AttachmentMetadataGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the meta-data for an attachment, including the URI of the actual attached file. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-getAttachment * @param options Request options. */ getAttachment(options: GetIssueAttachmentRequest): Promise; /** * Remove an attachment from an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-removeAttachment * @param options Request options. */ removeAttachment(options: RemoveIssueAttachmentRequest): Promise; /** * Add one or more attachments to an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/attachments-addAttachment * @param options Request options. */ addAttachment(options: AddIssueAttachmentRequest): Promise; } declare class AttachmentMetadataGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size allowed. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#attachment-getAttachmentMeta * @param options Request options. */ getMetadata(options?: GetIssueAttachmentMetadataRequest): Promise; } declare class FieldGroup { private implementation; private getGlobalErrorStrategy; Custom: CustomGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all fields, both System and Custom. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#field-getFields * @param options Request options. */ getFields(options?: GetIssueFieldsRequest): Promise; } declare class CustomGroup { private implementation; private getGlobalErrorStrategy; Option: OptionGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#customFields-getCustomFields * @param options Request options. */ getFields(options?: GetIssueCustomFieldsRequest): Promise; } declare class OptionGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a full representation of the Custom Field Option that has the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#customFieldOption-getCustomFieldOption * @param options Request options. */ getOption(options: GetIssueCustomFieldOptionRequest): Promise; } declare class LinkGroup { private implementation; private getGlobalErrorStrategy; Type: LinkTypeGroup; Remote: RemoteGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-linkIssues * @param options Request options. */ createLink(options: CreateIssueLinkRequest): Promise; /** * Returns an issue link with the specified id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-getIssueLink * @param options Request options. */ getLink(options: GetIssueLinkRequest): Promise; /** * Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLink-deleteIssueLink * @param options Request options. */ deleteLink(options: DeleteIssueLinkRequest): Promise; } declare class LinkTypeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-getIssueLinkTypes * @param options Request options. */ getTypes(options?: GetIssueLinkTypesRequest): Promise; /** * Returns for a given issue link type id all information about this issue link type. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-getIssueLinkType * @param options Request options. */ getType(options: GetIssueLinkTypeRequest): Promise; /** * Create a new issue link type. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-createIssueLinkType * @param options Request options. */ createType(options: CreateIssueLinkTypeRequest): Promise; /** * Delete the specified issue link type. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-deleteIssueLinkType * @param options Request options. */ deleteType(options: DeleteIssueLinkTypeRequest): Promise; /** * Update the specified issue link type. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issueLinkType-updateIssueLinkType * @param options Request options. */ updateType(options: UpdateIssueLinkTypeRequest): Promise; } declare class RemoteGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * A REST sub-resource representing the remote issue links on the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getRemoteIssueLinks * @param options Request options. */ getLinks(options: GetRemoteIssueLinksRequest): Promise; /** * Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-createOrUpdateRemoteIssueLink * @param options Request options. */ createOrUpdateLink(options: CreateOrUpdateRemoteIssueLinkRequest): Promise; /** * Delete the remote issue link with the given global id on the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteRemoteIssueLinkByGlobalId * @param options Request options. */ deleteLinkByGlobalId(options: DeleteRemoteIssueLinkByGlobalIdRequest): Promise; /** * Get the remote issue link with the given id on the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getRemoteIssueLinkById * @param options Request options. */ getLink(options: GetRemoteIssueLinkRequest): Promise; /** * Updates a remote issue link from a JSON representation. Any fields not provided are set to null. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateRemoteIssueLink * @param options Request options. */ updateLink(options: UpdateRemoteIssueLinkRequest): Promise; /** * Delete the remote issue link with the given id on the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteRemoteIssueLinkById * @param options Request options. */ deleteLink(options: DeleteRemoteIssueLinkRequest): Promise; } declare class MetadataGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the meta data for editing an issue. The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editmeta. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getEditIssueMeta * @param options Request options. */ getEditMetadata(options: GetEditIssueMetadataRequest): Promise; /** * Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project. * The fields in the createmeta correspond to the fields in the create screen for the project/issuetype. Fields not in the screen will not be in the createmeta. * Fields will only be returned if expand=projects.issuetypes.fields. * The results can be filtered by project and/or issue type, given by the query params. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getCreateIssueMeta * @param options Request options. * @deprecated */ getCreateMetadata(options?: GetCreateIssueMetadataRequest): Promise; } declare class PriorityGroup { private implementation; private getGlobalErrorStrategy; Scheme: IssuePrioritySchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all issue priorities. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#priority-getPriorities * @param options Request options. */ getPriorities(options?: GetIssuePrioritiesRequest): Promise; /** * Returns an issue priority. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#priority-getPriority * @param options Request options. */ getPriority(options: GetIssuePriorityRequest): Promise; } declare class IssuePrioritySchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates new priority scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-createPriorityScheme * @param options Request options. */ createScheme(options: CreateIssuePrioritySchemeRequest): Promise; /** * Returns all priority schemes. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=schemes.projectKeys. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-getPrioritySchemes * @param options Request options. */ getSchemes(options?: GetIssuePrioritySchemesRequest): Promise; /** * Deletes a priority scheme. * All projects using deleted scheme will use default priority scheme afterwards. Default priority scheme can't be deleted. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-deletePriorityScheme * @param options Request options. */ deleteScheme(options: DeleteIssuePrioritySchemeRequest): Promise; /** * Updates a priority scheme. * Update will be rejected if issue migration would be needed as a result of scheme update. * Priority scheme update with migration is possible from the UI. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-updatePriorityScheme * @param options Request options. */ updateScheme(options: UpdateIssuePrioritySchemeRequest): Promise; /** * Gets a full representation of a priority scheme in JSON format. * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#priorityschemes-getPriorityScheme * @param options Request options. */ getScheme(options: GetIssuePrioritySchemeRequest): Promise; } declare class IssuePropertyGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the keys of all properties for the issue identified by the key or by the id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-getPropertiesKeys * @param options Request options. */ getPropertyKeys(options: GetIssuePropertyKeysRequest): Promise; /** * Removes the property from the issue identified by the key or by the id. * Ths user removing the property is required to have permissions to edit the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-deleteProperty * @param options Request options. */ deleteProperty(options: DeleteIssuePropertyRequest): Promise; /** * Sets the value of the specified issue's property. * You can use this resource to store a custom data against the issue identified by the key or by the id. * The user who stores the data is required to have permissions to edit the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-setProperty * @param options Request options. */ setProperty(options: SetIssuePropertyRequest): Promise; /** * Returns the value of the property with a given key from the issue identified by the key or by the id. * The user who retrieves the property is required to have permissions to read the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issue/{issueIdOrKey}/properties-getProperty * @param options Request options. */ getProperty(options: GetIssuePropertyRequest): Promise; } declare class ResolutionGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all resolutions. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#resolution-getResolutions * @param options Request options. */ getResolutions(options?: GetIssueResolutionsRequest): Promise; /** * Returns a resolution. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#resolution-getResolution * @param options Request options. */ getResolution(options: GetIssueResolutionRequest): Promise; } declare class SearchGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a resolution. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#resolution-getResolution * @param options Request options. */ searchByJql(options: SearchIssuesByJqlRequest): Promise; } declare class SubTaskGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns an issue's subtask list. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-getSubTasks * @param options Request options. */ getSubTasks(options: GetIssueSubTasksRequest): Promise; /** * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-canMoveSubTask * @param options Request options. */ canMoveSubTask(options: CanMoveIssueSubTaskRequest): Promise; /** * Reorders an issue's subtasks by moving the subtask at index "from" to index "to". * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-moveSubTasks * @param options Request options. */ moveSubTasks(options: MoveIssueSubTasksRequest): Promise; } declare class TransitionGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Reorders an issue's subtasks by moving the subtask at index "from" to index "to". * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue/{issueIdOrKey}/subtask-moveSubTasks * @param options Request options. */ getTransitions(options: GetIssueTransitionsRequest): Promise; /** * Perform a transition on an issue. When performing the transition you can update or set other issue fields. * The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted. The updateHistory param adds the issues retrieved by this method to the current user's issue history, if set to true (by default, the issue history does not include issues retrieved via the REST API). You can view the issue history in the JIRA application, via the Issues dropdown or by using the lastViewed JQL field in an issue search. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-doTransition * @param options Request options. */ performTransition(options: PerformIssueTransitionRequest): Promise; } declare class TypeGroup { private implementation; private getGlobalErrorStrategy; Scheme: IssueTypeSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all issue types visible to the user. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getIssueAllTypes * @param options Request options. */ getTypes(options?: GetIssueTypesRequest): Promise; /** * Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-createIssueType * @param options Request options. */ createType(options: CreateIssueTypeRequest): Promise; /** * Returns a full representation of the issue type that has the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getIssueType * @param options Request options. */ getType(options: GetIssueTypeRequest): Promise; /** * Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter. * You can determine the alternative issue types by calling the /rest/api/2/issuetype/{id}/alternatives resource. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-deleteIssueType * @param options Request options. */ deleteType(options: DeleteIssueTypeRequest): Promise; /** * Updates the specified issue type from a JSON representation. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-updateIssueType * @param options Request options. */ updateType(options: UpdateIssueTypeRequest): Promise; /** * Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given issue type can be migrated. * The suitable alternatives are issue types which are assigned to the same workflow, the same field configuration and the same screen scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issuetype-getAlternativeIssueTypes * @param options Request options. */ getAlternativeTypes(options: GetAlternativeIssueTypesRequest): Promise; } declare class IssueTypeSchemeGroup { private implementation; private getGlobalErrorStrategy; Project: IssueTypeSchemeProjectGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates an issue type scheme from a JSON representation. (Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-createIssueTypeScheme * @param options Request options. */ createScheme(options: CreateIssueTypeSchemeRequest): Promise; /** * Returns a list of all issue type schemes visible to the user (must be admin). * All issue types associated with the scheme will only be returned if an additional query parameter is provided: expand=schemes.issueTypes. * Similarly, the default issue type associated with the scheme (if one exists) will only be returned if additional an query parameter is provided: expand=schemes.defaultIssueType. * Note that both query parameters can be used together: expand=schemes.issueTypes,schemes.defaultIssueType. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getAllIssueTypeSchemes * @param options Request options. */ getSchemes(options?: GetIssueTypeSchemesRequest): Promise; /** * Returns a full representation of the issue type scheme that has the given id (must be admin). * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getIssueTypeScheme * @param options Request options. */ getScheme(options: GetIssueTypeSchemeRequest): Promise; /** * Updates the specified issue type scheme from a JSON representation. (Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-updateIssueTypeScheme * @param options Request options. */ updateScheme(options: UpdateIssueTypeSchemeRequest): Promise; /** * Deletes the specified issue type scheme. * Any projects associated with this IssueTypeScheme will be automatically associated with the global default IssueTypeScheme. (Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-deleteIssueTypeScheme * @param options Request options. */ deleteScheme(options: DeleteIssueTypeSchemeRequest): Promise; } declare class IssueTypeSchemeProjectGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Perform a transition on an issue. When performing the transition you can update or set other issue fields. * The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource. If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted. The updateHistory param adds the issues retrieved by this method to the current user's issue history, if set to true (by default, the issue history does not include issues retrieved via the REST API). You can view the issue history in the JIRA application, via the Issues dropdown or by using the lastViewed JQL field in an issue search. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-doTransition * @param options Request options. */ addAssociations(options: AddProjectAssociationsToIssueTypeSchemeRequest): Promise; /** * For the specified issue type scheme, returns all of the associated projects. (Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-getAssociatedProjects * @param options Request options. */ getAssociations(options: GetProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * Associates the given projects with the specified issue type scheme. * Any existing project-associations the issue type scheme has will be overwritten. (Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-setProjectAssociationsForScheme * @param options Request options. */ setAssociations(options: SetProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * Removes all project associations for the specified issue type scheme. * These projects revert to an association with the default/global issue type scheme.(Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-removeAllProjectAssociations * @param options Request options. */ removeAssociations(options: RemoveProjectAssociationsForIssueTypeSchemeRequest): Promise; /** * For the specified issue type scheme, removes the given project association. * This project reverts to an association with the default/global issue type scheme.(Admin required) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuetypescheme-removeProjectAssociation * @param options Request options. */ removeAssociation(options: RemoveProjectAssociationForIssueTypeSchemeRequest): Promise; } declare class VoteGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Remove your vote from an issue. (i.e. "unvote"). * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-removeVote * @param options Request options. */ removeVote(options: RemoveIssueVoteRequest): Promise; /** * Cast your vote in favour of an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addVote * @param options Request options. */ addVote(options: AddIssueVoteRequest): Promise; /** * A REST sub-resource representing the voters on the issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getVotes * @param options Request options. */ getVotes(options: GetIssueVotesRequest): Promise; } declare class WatcherGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the list of watchers for the issue with the given key. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssueWatchers * @param options Request options. */ getWatchers(options: GetIssueWatchersRequest): Promise; /** * Adds a user to an issue's watcher list. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addWatcher * @param options Request options. */ addWatcher(options: AddIssueWatcherRequest): Promise; /** * Removes a user from an issue's watcher list. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-removeWatcher * @param options Request options. */ removeWatcher(options: RemoveIssueWatcherRequest): Promise; } declare class WorklogGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all work logs for an issue. Work logs won't be returned if the Log work field is hidden for the project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getIssueWorklog * @param options Request options. */ getWorklogs(options: GetIssueWorklogsRequest): Promise; /** * Adds a new worklog entry to an issue. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-addWorklog * @param options Request options. */ addWorklog(options: AddIssueWorklogRequest): Promise; /** * Returns a specific worklog. The work log won't be returned if the Log work field is hidden for the project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-getWorklog * @param options Request options. */ getWorklog(options: GetIssueWorklogRequest): Promise; /** * Updates an existing worklog entry. Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds. Either timeSpent or timeSpentSeconds can be set. Fields which are not set will not be updated. For a request to be valid, it has to have at least one field change. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-updateWorklog * @param options Request options. */ updateWorklog(options: UpdateIssueWorklogRequest): Promise; /** * Deletes an existing worklog entry. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#issue-deleteWorklog * @param options Request options. */ deleteWorklog(options: DeleteIssueWorklogRequest): Promise; /** * Returns worklogs id and delete time of worklogs that was deleted since given time. The returns set of worklogs is limited to 1000 elements. This API will not return worklogs deleted during last minute. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getIdsOfWorklogsDeletedSince * @param options Request options. */ getDeletedWorklogIds(options?: GetDeletedIssueWorklogIdsRequest): Promise; /** * Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result. The returns set of worklogs is limited to 1000 elements. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getWorklogsForIds * @param options Request options. */ getWorklogsForIds(options: GetIssueWorklogsForIdsRequest): Promise; /** * Returns worklogs id and update time of worklogs that was updated since given time. The returns set of worklogs is limited to 1000 elements. This API will not return worklogs updated during last minute. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#worklog-getIdsOfWorklogsModifiedSince * @param options Request options. */ getUpdatedWorklogIds(options?: GetUpdatedIssueWorklogIdsRequest): Promise; } declare class IssueSecurityGroup { private implementation; private getGlobalErrorStrategy; Scheme: IssueSecuritySchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class IssueSecuritySchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all issue security schemes that are defined. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuesecurityschemes-getIssueSecuritySchemes * @param options Request options. */ getSchemes(options?: GetIssueSecuritySchemesRequest): Promise; /** * Returns the issue security scheme along with that are defined. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#issuesecurityschemes-getIssueSecurityScheme * @param options Request options. */ getScheme(options: GetIssueSecuritySchemeRequest): Promise; } declare class IssueNotificationGroup { private implementation; private getGlobalErrorStrategy; Scheme: IssueNotificationSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class IssueNotificationSchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a paginated list of notification schemes. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#notificationscheme-getNotificationSchemes * @param options Request options. */ getSchemes(options?: GetNotificationSchemesRequest): Promise; /** * Returns a full representation of the notification scheme for the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#notificationscheme-getNotificationScheme * @param options Request options. */ getScheme(options: GetNotificationSchemeRequest): Promise; } declare class ApplicationGroup { private implementation; private getGlobalErrorStrategy; Role: ApplicationRoleGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ApplicationRoleGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all ApplicationRoles in the system. * Will also return an ETag header containing a version hash of the collection of ApplicationRoles. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-getAll * @param options Request options. */ getRoles(options?: GetApplicationRolesRequest): Promise; /** * Returns the ApplicationRole with passed key if it exists. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-get * @param options Request options. */ getRole(options: GetApplicationRoleRequest): Promise; /** * Updates the ApplicationRole with the passed data. * Only the groups and default groups setting of the role may be updated. * Requests to change the key or the name of the role will be silently ignored. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#applicationrole-put * @param options Request options. */ updateRole(options: UpdateApplicationRoleRequest): Promise; } declare class WorkflowGroup { private implementation; private getGlobalErrorStrategy; Status: WorkflowStatusGroup; Scheme: WorkflowSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all workflows. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#workflow-getAllWorkflows * @param options Request options. */ getWorkflows(options?: GetWorkflowsRequest): Promise; } declare class WorkflowStatusGroup { private implementation; private getGlobalErrorStrategy; Category: StatusCategoryGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all statuses. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#status-getStatuses * @param options Request options. */ getStatuses(options?: GetWorkflowStatusesRequest): Promise; /** * Returns a full representation of the Status having the given id or name. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#status-getStatus * @param options Request options. */ getStatus(options: GetWorkflowStatusRequest): Promise; } declare class StatusCategoryGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all status categories. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#statuscategory-getStatusCategories * @param options Request options. */ getCategories(options?: GetWorkflowStatusCategoriesRequest): Promise; /** * Returns a list of all status categories. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#statuscategory-getStatusCategories * @param options Request options. */ getCategory(options: GetWorkflowStatusCategoryRequest): Promise; } declare class WorkflowSchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Create a new workflow scheme. * The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-createScheme * @param options Request options. */ createScheme(options: CreateWorkflowSchemeRequest): Promise; /** * Returns the requested workflow scheme to the caller. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-getById * @param options Request options. */ getScheme(options: GetWorkflowSchemeRequest): Promise; /** * Returns the requested workflow scheme to the caller. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-getById * @param options Request options. */ deleteScheme(options: DeleteWorkflowSchemeRequest): Promise; /** * Update the passed workflow scheme. * The body of the request is a representation of the workflow scheme. * Values not passed are assumed to indicate no change for that field. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#workflowscheme-update * @param options Request options. */ updateScheme(options: UpdateWorkflowSchemeRequest): Promise; } declare class DashboardGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all dashboards, optionally filtering them. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#dashboard-list * @param options Request options. */ getDashboards(options?: GetAllDashboardsRequest): Promise; /** * Returns a single dashboard. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#dashboard-getDashboard * @param options Request options. */ getDashboard(options: GetDashboardByIdRequest): Promise; } declare class FilterGroup { private implementation; private getGlobalErrorStrategy; Column: FilterColumnGroup; Share: FilterShareGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a filter given an id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getFilter * @param options Request options. */ getFilter(options: GetFilterRequest): Promise; /** * Returns the favourite filters of the logged-in user. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getFavouriteFilters * @param options Request options. */ getMyFavouriteFilters(options?: GetMyFavouriteFiltersRequest): Promise; /** * Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-createFilter * @param options Request options. */ createFilter(options: CreateFilterRequest): Promise; /** * Updates an existing filter, and returns its new value. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-editFilter * @param options Request options. */ editFilter(options: EditFilterRequest): Promise; /** * Delete a filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-deleteFilter * @param options Request options. */ deleteFilter(options: DeleteFilterRequest): Promise; } declare class FilterColumnGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the default columns for the given filter. Currently logged in user will be used as the user making such request. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-defaultColumns * @param options Request options. */ getDefaultColumns(options: GetFilterDefaultColumnsRequest): Promise; /** * Sets the default columns for the given filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-setColumns * @param options Request options. */ setDefaultColumns(options: SetFilterDefaultColumnsRequest): Promise; /** * Resets the columns for the given filter such that the filter no longer has its own column config. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-resetColumns * @param options Request options. */ resetColumns(options: ResetFilterColumnsRequest): Promise; } declare class FilterShareGroup { private implementation; private getGlobalErrorStrategy; Permission: SharePermissionGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the default share scope of the logged-in user. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getDefaultShareScope * @param options Request options. */ getShareScope(options?: GetDefaultShareScopeRequest): Promise; /** * Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-setDefaultShareScope * @param options Request options. */ setShareScope(options: SetDefaultShareScopeRequest): Promise; } declare class SharePermissionGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all share permissions of the given filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermissions * @param options Request options. */ getSharePermissions(options: GetFilterSharePermissionsRequest): Promise; /** * Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-addSharePermission * @param options Request options. */ addSharePermission(options: AddFilterSharePermissionRequest): Promise; /** * Returns a single share permission of the given filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermission * @param options Request options. */ getSharePermission(options: GetFilterSharePermissionRequest): Promise; /** * Removes a share permissions from the given filter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#filter-getSharePermission * @param options Request options. */ deleteSharePermission(options: DeleteFilterSharePermissionRequest): Promise; } declare class GroupGroup { private implementation; private getGlobalErrorStrategy; User: GroupUserGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates a group by given group parameter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-createGroup * @param options Request options. */ createGroup(options: CreateGroupRequest): Promise; /** * Deletes a group by given group parameter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-removeGroup * @param options Request options. */ removeGroup(options?: RemoveGroupRequest): Promise; } declare class GroupUserGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * This resource returns a paginated list of users who are members of the specified group and its subgroups. Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-getUsersFromGroup * @param options Request options. */ getUsers(options: GetUsersFromGroupRequest): Promise; /** * Adds given user to a group. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-addUserToGroup * @param options Request options. */ addUsers(options: AddUsersToGroupRequest): Promise; /** * Removes given user from a group. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#group-removeUserFromGroup * @param options Request options. */ removeUsers(options?: RemoveUsersFromGroupRequest): Promise; } declare class InstanceGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns an application property. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getProperty * @param options Request options. */ getApplicationProperty(options?: GetApplicationPropertyRequest): Promise; /** * Modify an application property via PUT. The "value" field present in the PUT will override the existing value. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-setPropertyViaRestfulTable * @param options Request options. */ setApplicationProperty(options: SetApplicationPropertyRequest): Promise; /** * Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#application-properties-getAdvancedSettings * @param options Request options. */ getAdvancedSettings(options?: GetAdvancedSettingsRequest): Promise; /** * Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled, it also returns the detailed information about time tracking configuration. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#configuration-getConfiguration * @param options Request options. */ getConfiguration(options?: GetInstanceConfigurationRequest): Promise; /** * Returns general information about the current JIRA server. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#serverInfo-getServerInfo * @param options Request options. */ getInfo(options?: GetInstanceInfoRequest): Promise; } declare class MyselfGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Sets preference of the currently logged in user. * Preference key must be provided as input parameters (key). * Value must be provided as post body. If key or value parameter is not provided - status code 404. * If preference is set - status code 204. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-setPreference * @param options Request options. */ setPreference(options: SetMyPreferenceRequest): Promise; /** * Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). * If key parameter is not provided or wrong - status code 404. * If preference is unset - status code 204. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-removePreference * @param options Request options. */ removePreference(options: RemoveMyPreferenceRequest): Promise; /** * Returns preference of the currently logged in user. * Preference key must be provided as input parameter (key). * The value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. * If value is found - status code 200. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#mypreferences-getPreference * @param options Request options. */ getPreference(options: GetMyPreferenceRequest): Promise; /** * Returns currently logged in user. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#myself-getUser * @param options Request options. */ getCurrentUser(options?: GetCurrentUserRequest): Promise; } declare class PermissionGroup { private implementation; private getGlobalErrorStrategy; Scheme: PermissionSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all permissions in the system and whether the currently logged in user has them. * You can optionally provide a specific context to get permissions for (projectKey OR projectId OR issueKey OR issueId) * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#-getPermissions * @param options Request options. */ getMyPermissions(options?: GetMyPermissionsRequest): Promise; /** * Returns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#-getAllPermissions * @param options Request options. */ getPermissions(options?: GetPermissionsRequest): Promise; } declare class PermissionSchemeGroup { private implementation; private getGlobalErrorStrategy; Attribute: PermissionSchemeAttributeGroup; Grant: PermissionSchemeGrantGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of all permission schemes. * By default only shortened beans are returned. * If you want to include permissions of all the schemes, then specify the permissions expand parameter. * Permissions will be included also if you specify any other expand parameter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemes * @param options Request options. */ getSchemes(options?: GetPermissionSchemesRequest): Promise; /** * Returns a list of all permission schemes. * By default only shortened beans are returned. * If you want to include permissions of all the schemes, then specify the permissions expand parameter. * Permissions will be included also if you specify any other expand parameter. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemes * @param options Request options. */ createScheme(options: CreatePermissionSchemeRequest): Promise; /** * Returns a permission scheme identified by the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionScheme * @param options Request options. */ getScheme(options: GetPermissionSchemeRequest): Promise; /** * Deletes a permission scheme identified by the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-deletePermissionScheme * @param options Request options. */ deleteScheme(options: DeletePermissionSchemeRequest): Promise; /** * Updates a permission scheme. * If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that existed in the permission scheme. * Sending an empty list will remove all permission grants from the permission scheme. * To update just the name and description, do not send permissions list at all. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-updatePermissionScheme * @param options Request options. */ updateScheme(options: UpdatePermissionSchemeRequest): Promise; } declare class PermissionSchemeAttributeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns scheme attribute. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getSchemeAttribute * @param options Request options. */ getAttribute(options: GetPermissionSchemeAttributeRequest): Promise; } declare class PermissionSchemeGrantGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all permission grants of the given permission scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemeGrants * @param options Request options. */ getGrants(options: GetPermissionSchemeGrantsRequest): Promise; /** * Creates a permission grant in a permission scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-createPermissionGrant * @param options Request options. */ createGrant(options: CreatePermissionSchemeGrantRequest): Promise; /** * Deletes a permission grant from a permission scheme. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-deletePermissionSchemeEntity * @param options Request options. */ deleteGrant(options: DeletePermissionSchemeGrantRequest): Promise; /** * Returns a permission grant identified by the given id. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#permissionscheme-getPermissionSchemeGrant * @param options Request options. */ getGrant(options: GetPermissionSchemeGrantRequest): Promise; } declare class ProjectGroup { private implementation; private getGlobalErrorStrategy; Component: ComponentGroup; Role: ProjectRoleGroup; Type: ProjectTypeGroup; Validation: ProjectValidationGroup; Version: ProjectVersionGroup; Issue: ProjectIssueGroup; Notification: ProjectNotificationGroup; Permission: ProjectPermissionGroup; Priority: ProjectPriorityGroup; Security: ProjectSecurityGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getAllProjects * @param options Request options. */ getProjects(options?: GetProjectsRequest): Promise; /** * Creates a new project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-createProject * @param options Request options. */ createProject(options: CreateProjectRequest): Promise; /** * Contains a full representation of a project in JSON format. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProject * @param options Request options. */ getProject(options: GetProjectRequest): Promise; /** * Contains a full representation of a project in JSON format. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProject * @param options Request options. */ updateProject(options: UpdateProjectRequest): Promise; /** * Deletes a project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-deleteProject * @param options Request options. */ deleteProject(options: DeleteProjectRequest): Promise; /** * Archives a project. Only for DC. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-archiveProject * @param options Request options. */ archiveProject(options: ArchiveProjectRequest): Promise; /** * Contains a full representation of a the specified project's components. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectComponents * @param options Request options. */ getComponents(options: GetProjectComponentsRequest): Promise; /** * Contains a full representation of a the specified project's components. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectComponents * @param options Request options. */ restoreProject(options: RestoreProjectRequest): Promise; /** * Get all issue types with valid status values for a project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getAllStatuses * @param options Request options. */ getStatuses(options: GetProjectStatusesRequest): Promise; /** * Updates the type of a project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-updateProjectType * @param options Request options. */ updateProjectType(options: UpdateProjectTypeRequest): Promise; /** * Returns all versions for the specified project. Results are paginated. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectVersionsPaginated * @param options Request options. */ getVersionsPaginated(options: GetProjectVersionsPaginatedRequest): Promise; /** * Contains a full representation of a the specified project's versions. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project-getProjectVersions * @param options Request options. */ getVersions(options: GetProjectVersionsRequest): Promise; } declare class ComponentGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Create a component via POST. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-createComponent * @param options Request options. */ createComponent(options: CreateProjectComponentRequest): Promise; /** * Returns a project component. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-getComponent * @param options Request options. */ getComponent(options: GetProjectComponentRequest): Promise; /** * Modify a component via PUT. If leadUserName is an empty string ("") the component lead will be removed. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-updateComponent * @param options Request options. */ updateComponent(options: UpdateProjectComponentRequest): Promise; /** * Delete a project component. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-delete * @param options Request options. */ deleteComponent(options: DeleteProjectComponentRequest): Promise; /** * Returns counts of issues related to this component. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#component-getComponentRelatedIssues * @param options Request options. */ getRelatedIssueCount(options: GetProjectComponentRelatedIssueCountRequest): Promise; } declare class ProjectRoleGroup { private implementation; private getGlobalErrorStrategy; Actor: RoleActorGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all roles in the given project Id or key, with links to full details on each role. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-getProjectRoles * @param options Request options. */ getRoles(options: GetProjectRolesRequest): Promise; /** * Returns the details for a given project role in a project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-getProjectRole * @param options Request options. */ getRole(options: GetProjectRoleRequest): Promise; } declare class RoleActorGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Updates a project role to include the specified actors (users or groups). * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-setActors * @param options Request options. */ setActors(options: SetProjectRoleActorsRequest): Promise; /** * Adds an actor (user or group) to a project role. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-addActorUsers * @param options Request options. */ addUsers(options: AddProjectRoleActorUsersRequest): Promise; /** * Deletes actors (users or groups) from a project role. * Delete a user from the role: /rest/api/2/project/{projectIdOrKey}/role/{roleId}?user={username} * Delete a group from the role: /rest/api/2/project/{projectIdOrKey}/role/{roleId}?group={groupname} * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/{projectIdOrKey}/role-deleteActor * @param options Request options. */ deleteActor(options: DeleteProjectRoleActorRequest): Promise; } declare class ProjectSecurityGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all security levels for the project that the current logged in user has access to. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/securitylevel-getSecurityLevelsForProject * @param options Request options. */ getLevels(options: GetProjectSecurityLevelsRequest): Promise; } declare class ProjectTypeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns all the project types defined on the JIRA instance, not taking into account whether the license to use those project types is valid or not. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getAllProjectTypes * @param options Request options. */ getTypes(options?: GetProjectTypesRequest): Promise; /** * Returns the project type with the given key. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getProjectTypeByKey * @param options Request options. */ getType(options: GetProjectTypeRequest): Promise; /** * Returns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the Application that defines the project type. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#project/type-getAccessibleProjectTypeByKey * @param options Request options. */ getAccessibleType(options: GetAccessibleProjectTypeRequest): Promise; } declare class ProjectValidationGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Validates a project key. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#projectvalidate-getProject * @param options Request options. */ validateProjectKey(options: ValidateProjectKeyRequest): Promise; } declare class ProjectVersionGroup { private implementation; private getGlobalErrorStrategy; Count: VersionCountGroup; Remote: ProjectVersionRemoteGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Create a version via POST. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-createVersion * @param options Request options. */ createVersion(options: CreateProjectVersionRequest): Promise; /** * Modify a version's sequence within a project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-moveVersion * @param options Request options. */ moveVersion(options: MoveProjectVersionRequest): Promise; /** * Returns a project version. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersion * @param options Request options. */ getVersion(options: GetProjectVersionRequest): Promise; /** * Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-updateVersion * @param options Request options. */ updateVersion(options: UpdateProjectVersionRequest): Promise; /** * Delete a project version. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-delete * @param options Request options. */ deleteVersion(options: DeleteProjectVersionRequest): Promise; /** * Merge versions. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-merge * @param options Request options. */ mergeVersion(options: MergeProjectVersionRequest): Promise; /** * Delete a project version. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-delete * @param options Request options. */ removeAndReplaceVersion(options: RemoveAndReplaceProjectVersionRequest): Promise; } declare class VersionCountGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a bean containing the number of fixed in and affected issues for the given version. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersionRelatedIssues * @param options Request options. */ getVersionRelatedIssueCount(options: GetProjectVersionRelatedIssueCountRequest): Promise; /** * Returns the number of unresolved issues for the given version * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#version-getVersionUnresolvedIssues * @param options Request options. */ getVersionUnresolvedIssueCount(options: GetProjectVersionUnresolvedIssueCountRequest): Promise; } declare class ProjectVersionRemoteGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the remote version links associated with the given version ID. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-getRemoteVersionLinksByVersionId * @param options Request options. */ getLinksById(options: GetRemoteVersionLinksByIdRequest): Promise; /** * Create a remote version link via POST. * The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-createOrUpdateRemoteVersionLink * @param options Request options. */ createOrUpdateLinkById(options: CreateOrUpdateRemoteVersionLinkByIdRequest): Promise; /** * Delete all remote version links for a given version ID. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-deleteRemoteVersionLinksByVersionId * @param options Request options. */ deleteLinksById(options: DeleteRemoteVersionLinksByIdRequest): Promise; /** * A REST sub-resource representing a remote version link. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-getRemoteVersionLink * @param options Request options. */ getLink(options: GetRemoteVersionLinkRequest): Promise; /** * Create a remote version link via POST. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-createOrUpdateRemoteVersionLink * @param options Request options. */ createOrUpdateLink(options: CreateOrUpdateRemoteVersionLinkRequest): Promise; /** * Delete a specific remote version link with the given version ID and global ID. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-deleteRemoteVersionLink * @param options Request options. */ deleteLink(options: DeleteRemoteVersionLinkRequest): Promise; /** * Returns the remote version links for a given global ID. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#version-getRemoteVersionLinks * @param options Request options. */ getLinks(options: GetRemoteVersionLinksRequest): Promise; } declare class ProjectIssueGroup { private implementation; private getGlobalErrorStrategy; Security: ProjectIssueSecurityGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ProjectIssueSecurityGroup { private implementation; private getGlobalErrorStrategy; Scheme: ProjectIssueSecuritySchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ProjectIssueSecuritySchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns the issue security scheme for project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/issuesecuritylevelscheme-getIssueSecurityScheme * @param options Request options. */ getScheme(options: GetProjectIssueSecuritySchemeRequest): Promise; } declare class ProjectNotificationGroup { private implementation; private getGlobalErrorStrategy; Scheme: ProjectNotificationSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ProjectNotificationSchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Gets a notification scheme associated with the project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/notificationscheme-getNotificationScheme * @param options Request options. */ getScheme(options: GetProjectNotificationSchemeRequest): Promise; } declare class ProjectPermissionGroup { private implementation; private getGlobalErrorStrategy; Scheme: ProjectPermissionSchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ProjectPermissionSchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Resource for associating permission schemes and projects. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/permissionscheme-getAssignedPermissionScheme * @param options Request options. */ getScheme(options: GetProjectPermissionSchemeRequest): Promise; } declare class ProjectPriorityGroup { private implementation; private getGlobalErrorStrategy; Scheme: ProjectPrioritySchemeGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class ProjectPrioritySchemeGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Gets a full representation of a priority scheme in JSON format used by specified project. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#project/{projectKeyOrId}/priorityscheme-getAssignedPriorityScheme * @param options Request options. */ getScheme(options: GetPrioritySchemeRequest): Promise; } declare class ScreenGroup { private implementation; private getGlobalErrorStrategy; Tab: ScreenTabGroup; Field: ScreenFieldGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Gets available fields for screen. i.e ones that haven't already been added. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getFieldsToAdd * @param options Request options. */ getFieldsToAdd(options: GetScreenFieldsToAddRequest): Promise; /** * Gets available field screens. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllScreens * @param options Request options. */ getScreens(options?: GetScreensRequest): Promise; } declare class ScreenTabGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Creates tab for given screen. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addTab * @param options Request options. */ addTab(options: AddScreenTabRequest): Promise; /** * Returns a list of all tabs for the given screen. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllTabs * @param options Request options. */ getTabs(options: GetScreenTabsRequest): Promise; /** * Renames tab on given screen. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-renameTab * @param options Request options. */ renameTab(options: RenameScreenTabRequest): Promise; /** * Deletes tab to give screen. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-deleteTab * @param options Request options. */ deleteTab(options: DeleteScreenTabRequest): Promise; /** * Moves tab position. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-moveTab * @param options Request options. */ moveTab(options: MoveScreenTabRequest): Promise; } declare class ScreenFieldGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Gets all fields for a given tab. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-getAllFields * @param options Request options. */ getFields(options: GetScreenFieldsRequest): Promise; /** * Adds field to the given tab. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addField * @param options Request options. */ addField(options: AddScreenFieldRequest): Promise; /** * Removes field from given tab. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-removeField * @param options Request options. */ removeField(options: RemoveScreenFieldRequest): Promise; /** * Moves field on the given tab. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-moveField * @param options Request options. */ moveField(options: MoveScreenFieldRequest): Promise; /** * Adds field or custom field to the default tab. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#screens-addFieldToDefaultScreen * @param options Request options. */ addToDefaultScreen(options: AddFieldToDefaultScreenRequest): Promise; } declare class UserGroup { private implementation; private getGlobalErrorStrategy; Search: UserSearchGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a user. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-getUser * @param options Request options. */ getUser(options?: GetUserRequest): Promise; /** * Modify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-updateUser * @param options Request options. */ updateUser(options: UpdateUserRequest): Promise; /** * Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-createUser * @param options Request options. */ createUser(options: CreateUserRequest): Promise; /** * Removes user and its references (like project roles associations, watches, history). * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-removeUser * @param options Request options. */ removeUser(options: RemoveUserRequest): Promise; /** * Add user to given application. Admin permission will be required to perform this operation. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-addUserToApplication * @param options Request options. */ addUserToApplication(options: AddUserToApplicationRequest): Promise; /** * Remove user from given application. Admin permission will be required to perform this operation. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-removeUserFromApplication * @param options Request options. */ removeUserFromApplication(options: RemoveUserFromApplicationRequest): Promise; /** * Modify user password. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-changeUserPassword * @param options Request options. */ changeUserPassword(options: ChangeUserPasswordRequest): Promise; } declare class UserSearchGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findAssignableUsers * @param options Request options. */ findAssignableUsers(options?: FindAssignableUsersRequest): Promise; /** * Returns a list of active users that match the search string and have all specified permissions for the project or issue. * This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsersWithAllPermissions * @param options Request options. */ findUsersWithAllPermissions(options: FindUsersWithAllPermissionsRequest): Promise; /** * Returns a list of users that match the search string. This resource cannot be accessed anonymously. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsers * @param options Request options. */ findUsers(options: FindUsersRequest): Promise; /** * Returns a list of active users that match the search string. This resource cannot be accessed anonymously and requires the Browse Users global permission. Given an issue key this resource will provide a list of users that match the search string and have the browse issue permission for the issue provided. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#user-findUsersWithBrowsePermission * @param options Request options. */ findUsersWithBrowsePermission(options: FindUsersWithBrowsePermissionRequest): Promise; } declare class RoleGroup { private implementation; private getGlobalErrorStrategy; Project: RoleProjectGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); } declare class RoleProjectGroup { private implementation; private getGlobalErrorStrategy; Actor: RoleProjectActorGroup; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Get all the ProjectRoles available in JIRA. Currently this list is global. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRoles * @param options Request options. */ getRoles(options?: GetGlobalProjectRolesRequest): Promise; /** * Creates a new ProjectRole to be available in Jira. The created role does not have any default actors assigned. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-createProjectRole * @param options Request options. */ createRole(options: CreateGlobalProjectRoleRequest): Promise; /** * Get a specific ProjectRole available in JIRA. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRolesById * @param options Request options. */ getRole(options: GetGlobalProjectRoleRequest): Promise; /** * Partially updates a roles name or description. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-partialUpdateProjectRole * @param options Request options. */ updateRolePartially(options: UpdateGlobalProjectRolePartiallyRequest): Promise; /** * Fully updates a roles. Both name and description must be given. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.0/#role-getProjectRolesById * @param options Request options. */ updateRoleFully(options: UpdateGlobalProjectRoleFullyRequest): Promise; /** * Deletes a role. May return 403 in the future. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-deleteProjectRole * @param options Request options. */ deleteRole(options: DeleteGlobalProjectRoleRequest): Promise; } declare class RoleProjectActorGroup { private implementation; private getGlobalErrorStrategy; constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy); /** * Gets default actors for the given role. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-getProjectRoleActorsForRole * @param options Request options. */ getActors(options: GetGlobalProjectRoleActorsRequest): Promise; /** * Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-addProjectRoleActorsToRole * @param options Request options. */ addActors(options: AddGlobalProjectRoleActorsRequest): Promise; /** * Removes default actor from the given role. * Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/8.20.2/#role-deleteProjectRoleActorsFromRole * @param options Request options. */ deleteActors(options: DeleteGlobalProjectRoleActorsRequest): Promise; } export {}; //# sourceMappingURL=index.d.ts.map