jira.js
Guide
GitHub
Preparing search index...
server
createServerClient
Function createServerClient
createServerClient
(
clientConfig
:
Client
|
ServerClientConfig
,
)
:
{
applicationProperties
:
{
getAdvancedSettings
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getApplicationProperties
:
(
parameters
?:
{
key
?:
string
;
keyFilter
?:
string
;
permissionLevel
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
setPropertyViaRestfulTable
:
(
parameters
:
{
body
:
{
id
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
applicationRoles
:
{
getAll
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getApplicationRole
:
(
parameters
:
{
key
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
putBulk
:
(
parameters
:
{
body
?:
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
"If-Match"
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
updateApplicationRole
:
(
parameters
:
{
body
?:
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
;
"If-Match"
?:
string
;
key
:
string
;
versionHash
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
avatars
:
{
createAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
owningObjectId
:
string
;
type
:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteAvatar
:
(
parameters
:
{
id
:
number
;
owningObjectId
:
string
;
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllSystemAvatars
:
(
parameters
:
{
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAvatars
:
(
parameters
:
{
owningObjectId
:
string
;
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
storeTemporaryAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
owningObjectId
:
string
;
type
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
backlog
:
{
moveIssuesToBacklog
:
(
parameters
:
{
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
board
:
{
createBoard
:
(
parameters
:
{
filterId
?:
number
;
name
?:
string
;
type
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBoardProperty
:
(
parameters
:
{
boardId
:
number
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllBoards
:
(
parameters
?:
{
maxResults
?:
number
;
name
?:
string
;
projectKeyOrId
?:
string
;
startAt
?:
number
;
type
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllSprints
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
state
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllVersions
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
released
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
archived
?:
boolean
;
description
?:
string
;
id
:
number
;
name
:
string
;
overdue
?:
boolean
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
string
;
self
?:
string
;
userReleaseDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardConfiguration
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
columnConfig
?:
{
columns
?:
{
max
?:
(...)
|
(...)
;
min
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
statuses
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
constraintType
?:
string
;
[
key
:
string
]:
unknown
;
}
;
estimation
?:
{
field
?:
{
displayName
?:
string
;
fieldId
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
filter
?:
{
id
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
name
?:
string
;
ranking
?:
{
rankCustomFieldId
?:
number
;
[
key
:
string
]:
unknown
}
;
self
?:
string
;
subQuery
?:
{
query
?:
string
;
[
key
:
string
]:
unknown
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardProperty
:
(
parameters
:
{
boardId
:
number
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getBoardPropertyKeys
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getEpics
:
(
parameters
:
{
boardId
:
number
;
done
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
color
?:
{
key
?:
|
(...)
&
(...)
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBacklog
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoardEpic
:
(
parameters
:
{
boardId
:
number
;
epicId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoardSprint
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
sprintId
:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpicForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjects
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarUrls
?:
Record
<
string
,
string
>
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRefinedVelocity
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
value
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
setBoardProperty
:
(
parameters
:
{
boardId
:
number
;
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setRefinedVelocity
:
(
parameters
:
{
boardId
:
number
;
value
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
cluster
:
{
acknowledgeErrors
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
approveUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
cancelUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
changeNodeStateToOffline
:
(
parameters
:
{
nodeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteNode
:
(
parameters
:
{
nodeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllNodes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
alive
?:
boolean
;
cacheListenerPort
?:
number
;
ip
?:
string
;
lastStateChangeTimestamp
?:
number
;
nodeBuildNumber
?:
number
;
nodeId
?:
string
;
nodeVersion
?:
string
;
state
?:
|
string
&
{}
|
"ACTIVE"
|
"PASSIVE"
|
"ACTIVATING"
|
"PASSIVATING"
|
"OFFLINE"
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getState
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
build
?:
{
buildNumber
?:
number
;
version
?:
string
;
[
key
:
string
]:
unknown
;
}
;
state
?:
|
string
&
{}
|
"STABLE"
|
"READY_TO_UPGRADE"
|
"MIXED"
|
"READY_TO_RUN_UPGRADE_TASKS"
|
"RUNNING_UPGRADE_TASKS"
|
"UPGRADE_TASKS_FAILED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
setReadyToUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
configuration
:
{
getConfiguration
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
attachmentsEnabled
?:
boolean
;
issueLinkingEnabled
?:
boolean
;
subTasksEnabled
?:
boolean
;
timeTrackingConfiguration
?:
{
defaultUnit
?:
"day"
|
"hour"
|
"minute"
|
"week"
|
string
&
{}
;
timeFormat
?:
"days"
|
"hours"
|
string
&
{}
|
"pretty"
;
workingDaysPerWeek
?:
number
;
workingHoursPerDay
?:
number
;
[
key
:
string
]:
unknown
;
}
;
timeTrackingEnabled
?:
boolean
;
unassignedIssuesAllowed
?:
boolean
;
votingEnabled
?:
boolean
;
watchingEnabled
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
dashboards
:
{
deleteDashboardItemProperty
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getDashboard
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
view
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDashboardItemProperty
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getDashboardItemPropertyKeys
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
list
:
(
parameters
?:
{
filter
?:
string
;
maxResults
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
dashboards
?:
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
view
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
next
?:
string
;
prev
?:
string
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
setDashboardItemProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
emailTemplates
:
{
applyEmailTemplates
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
downloadEmailTemplates
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
>
;
getEmailTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
emailTypes
?:
{
active
?:
boolean
;
batchedNotification
?:
boolean
;
eventName
?:
string
;
html
?:
boolean
;
id
?:
number
;
templateName
?:
string
;
text
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
userEmailAddress
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
revertEmailTemplatesToDefault
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
uploadEmailTemplates
:
(
parameters
:
{
body
:
Blob
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
epic
:
{
getEpic
:
(
parameters
:
{
epicIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForEpic
:
(
parameters
:
{
epicIdOrKey
:
string
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpic
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToEpic
:
(
parameters
:
{
epicIdOrKey
:
string
;
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateEpic
:
(
parameters
:
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
epicIdOrKey
:
string
;
name
?:
string
;
summary
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
rankEpics
:
(
parameters
:
{
epicIdOrKey
:
string
;
rankAfterEpic
?:
string
;
rankBeforeEpic
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeIssuesFromEpic
:
(
parameters
:
{
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
filters
:
{
addSharePermission
:
(
parameters
:
{
edit
?:
boolean
;
groupname
?:
string
;
id
:
string
;
projectId
?:
string
;
projectRoleId
?:
string
;
type
?:
string
;
userKey
?:
string
;
view
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
createFilter
:
(
parameters
:
{
description
?:
string
;
editable
?:
boolean
;
expand
?:
string
|
string
[]
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteFilter
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSharePermission
:
(
parameters
:
{
id
:
string
;
permissionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
editFilter
:
(
parameters
:
{
body
?:
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
}
;
id
?:
number
;
project
?:
{
archived
?:
...
;
avatarUrls
?:
...
;
description
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
role
?:
{
actors
?:
...
;
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
user
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDefaultShareScope
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFavouriteFilters
:
(
parameters
?:
{
expand
?:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
}
;
id
?:
number
;
project
?:
{
archived
?:
...
;
avatarUrls
?:
...
;
description
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
role
?:
{
actors
?:
...
;
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
user
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getFilter
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFilterColumns
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
columnConfig
?:
|
string
&
{}
|
"NONE"
|
"SYSTEM"
|
"EXPLICIT"
|
"FILTER"
|
"USER"
;
columnLayoutItems
?:
{
columnHeadingKey
?:
string
;
id
?:
string
;
navigableField
?:
{
columnCssClass
?:
...
;
columnHeadingKey
?:
...
;
defaultSortOrder
?:
...
;
hiddenFieldId
?:
...
;
id
?:
...
;
name
?:
...
;
nameKey
?:
...
;
valueLoader
?:
...
;
[
key
:
...
]:
...
;
}
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getSharePermission
:
(
parameters
:
{
id
:
string
;
permissionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSharePermissions
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
resetColumns
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setColumns
:
(
parameters
:
{
columns
?:
string
[]
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setDefaultShareScope
:
(
parameters
:
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
groupAndUserPicker
:
{
findUsersAndGroups
:
(
parameters
?:
{
fieldId
?:
string
;
issueTypeId
?:
string
;
maxResults
?:
string
;
projectId
?:
string
;
query
?:
string
;
showAvatar
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
groups
?:
{
groups
?:
{
html
?:
(...)
|
(...)
;
labels
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
header
?:
string
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
users
?:
{
header
?:
string
;
total
?:
number
;
users
?:
{
avatarUrl
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
html
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
groups
:
{
addUserToGroup
:
(
parameters
:
{
groupname
:
string
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
name
?:
string
;
self
?:
string
;
users
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
createGroup
:
(
parameters
:
{
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
name
?:
string
;
self
?:
string
;
users
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
findGroups
:
(
parameters
?:
{
exclude
?:
string
;
maxResults
?:
string
;
query
?:
string
;
userName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
groups
?:
{
html
?:
string
;
labels
?:
{
text
?:
...
;
title
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
}
[]
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
header
?:
string
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUsersFromGroup
:
(
parameters
:
{
groupname
:
string
;
includeInactiveUsers
?:
string
;
maxResults
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeGroup
:
(
parameters
:
{
groupname
:
string
;
swapGroup
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeUserFromGroup
:
(
parameters
:
{
groupname
:
string
;
username
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
indexing
:
{
createIndexSnapshot
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
futureAbsolutePath
?:
string
;
[
key
:
string
]:
unknown
}
>
;
getIndexSummary
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
externalPlatformIndexReplay
?:
Record
<
string
,
{
lastConsumedOperation
?:
{
id
?:
(...)
|
(...)
;
journalWriteTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastOperationInQueue
?:
{
id
?:
(...)
|
(...)
;
journalWriteTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
queueSize
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
issueIndex
?:
{
countInArchive
?:
number
;
countInDatabase
?:
number
;
countInIndex
?:
number
;
indexReadable
?:
boolean
;
lastUpdatedInDatabase
?:
Date
;
lastUpdatedInIndex
?:
Date
;
[
key
:
string
]:
unknown
;
}
;
nodeId
?:
string
;
replicationQueues
?:
Record
<
string
,
{
lastConsumedOperation
?:
{
id
?:
(...)
|
(...)
;
replicationTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastOperationInQueue
?:
{
id
?:
(...)
|
(...)
;
replicationTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
queueSize
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
reportTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProgressBulk
:
(
parameters
?:
{
requestId
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
getReindexInfo
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReindexProgress
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReindexRequestProgress
:
(
parameters
:
{
requestId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completionTime
?:
Date
;
id
?:
number
;
requestTime
?:
Date
;
startTime
?:
Date
;
status
?:
|
string
&
{}
|
"RUNNING"
|
"COMPLETE"
|
"FAILED"
|
"PENDING"
|
"ACTIVE"
;
type
?:
string
&
{}
|
"IMMEDIATE"
|
"DELAYED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
isIndexSnapshotRunning
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
running
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
listIndexSnapshot
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
absolutePath
?:
string
;
timestamp
?:
number
;
[
key
:
string
]:
unknown
}
[]
,
>
;
processRequests
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
[]
>
;
reindex
:
(
parameters
:
{
indexChangeHistory
?:
boolean
;
indexComments
?:
boolean
;
indexWorklogs
?:
boolean
;
type
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
reindexIssues
:
(
parameters
:
{
indexChangeHistory
?:
boolean
;
indexComments
?:
boolean
;
indexWorklogs
?:
boolean
;
issueId
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueAttachments
:
{
expandForHumans
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
Record
<
string
,
any
>
;
id
?:
number
;
mediaType
?:
string
;
name
?:
string
;
totalEntryCount
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
expandForMachines
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
{
abbreviatedName
?:
string
;
entryIndex
?:
number
;
mediaType
?:
string
;
name
?:
string
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
totalEntryCount
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAttachment
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
content
?:
string
;
created
?:
string
;
filename
?:
string
;
id
?:
string
;
mimeType
?:
string
;
properties
?:
Record
<
string
,
any
>
;
self
?:
string
;
size
?:
number
;
thumbnail
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAttachmentMeta
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
uploadLimit
?:
number
;
[
key
:
string
]:
unknown
}
,
>
;
removeAttachment
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueComments
:
{
deleteCommentProperty
:
(
parameters
:
{
commentId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getCommentProperty
:
(
parameters
:
{
commentId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getCommentPropertyKeys
:
(
parameters
:
{
commentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setCommentProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
commentId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueCustomFieldOptions
:
{
getCustomFieldOption
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
childrenIds
?:
number
[]
;
disabled
?:
boolean
;
id
?:
number
;
self
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueFields
:
{
bulkDeleteCustomFields
:
(
parameters
:
{
ids
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
deletedCustomFields
?:
string
[]
;
message
?:
string
;
notDeletedCustomFields
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
createCustomField
:
(
parameters
:
{
description
?:
string
;
id
?:
string
;
issueTypeIds
?:
string
[]
;
name
?:
string
;
projectIds
?:
number
[]
;
searcherKey
?:
string
;
self
?:
string
;
type
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCustomFieldOptions
:
(
parameters
:
{
customFieldId
:
string
;
issueTypeIds
?:
string
;
maxResults
?:
string
;
page
?:
string
;
projectIds
?:
string
;
query
?:
string
;
sortByOptionName
?:
string
;
useAllContexts
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
options
?:
{
childrenIds
?:
number
[]
;
disabled
?:
boolean
;
id
?:
number
;
self
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCustomFields
:
(
parameters
?:
{
lastValueUpdate
?:
string
;
maxResults
?:
string
;
projectIds
?:
string
;
screenIds
?:
string
;
search
?:
string
;
sortColumn
?:
string
;
sortOrder
?:
string
;
startAt
?:
string
;
types
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
id
?:
string
;
isAllProjects
?:
boolean
;
isLocked
?:
boolean
;
isManaged
?:
boolean
;
issuesWithValue
?:
number
;
issueTypeIds
?:
string
[]
;
isTrusted
?:
boolean
;
lastValueUpdate
?:
Date
;
name
?:
string
;
numericId
?:
number
;
projectIds
?:
number
[]
;
projectsCount
?:
number
;
screensCount
?:
number
;
searcherKey
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFields
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
issueLinks
:
{
deleteIssueLink
:
(
parameters
:
{
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssueLink
:
(
parameters
:
{
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
;
priority
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
status
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
outwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
;
priority
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
status
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
self
?:
string
;
type
?:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
linkIssues
:
(
parameters
:
{
comment
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
inwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
outwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueLinkTypes
:
{
createIssueLinkType
:
(
parameters
:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueLinkTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
moveIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
;
newPosition
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
resetOrder
:
(
parameters
:
{
direction
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
updateIssueLinkType
:
(
parameters
:
{
id
?:
string
;
inward
?:
string
;
issueLinkTypeId
:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueNotificationSchemes
:
{
getNotificationScheme
:
(
parameters
:
{
expand
?:
string
;
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
notificationSchemeEvents
?:
{
event
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
notifications
?:
{
id
?:
...
;
notificationType
?:
...
;
parameter
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getNotificationSchemes
:
(
parameters
?:
{
expand
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issuePriorities
:
{
getPriorities
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getPrioritiesPaginated
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPriority
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueResolutions
:
{
getPaginatedResolutions
:
(
parameters
?:
{
maxResults
?:
number
;
query
?:
string
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getResolution
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getResolutions
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
issues
:
{
addAttachment
:
(
parameters
:
{
attachments
:
AttachmentInput
|
AttachmentInput
[]
;
issueIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
content
?:
string
;
created
?:
Date
;
filename
?:
string
;
id
?:
string
;
mimeType
?:
string
;
self
?:
string
;
size
?:
number
;
thumbnail
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
addComment
:
(
parameters
:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
expand
?:
string
;
id
?:
string
;
issueIdOrKey
:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
addVote
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addWatcher
:
(
parameters
:
{
body
?:
string
;
issueIdOrKey
:
string
;
userName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
reduceBy
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
archiveIssue
:
(
parameters
:
{
issueIdOrKey
:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
archiveIssues
:
(
parameters
:
{
body
?:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
assign
:
(
parameters
:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
canMoveSubTask
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
boolean
>
;
createIssue
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
updateHistory
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
createIssues
:
(
parameters
:
{
issueUpdates
?:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
cause
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
(...)
,
(...)
>
;
generator
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
properties
?:
{
key
?:
(...)
|
(...)
;
value
?:
unknown
;
[
key
:
string
]:
unknown
;
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
(...)
,
(...)
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
,
>
;
[
key
:
string
]:
unknown
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errors
?:
{
elementErrors
?:
{
errorMessages
?:
(...)
|
(...)
;
errors
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
failedElementNumber
?:
number
;
status
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
issues
?:
{
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
createOrUpdateRemoteIssueLink
:
(
parameters
:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
issueIdOrKey
:
string
;
object
?:
{
icon
?:
{
link
?:
string
;
title
?:
string
;
url16x16
?:
string
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
resolved
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
createReciprocalRemoteIssueLink
:
(
parameters
:
{
source
?:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
object
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
(...)
|
(...)
;
resolved
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
[
key
:
string
]:
unknown
;
}
;
target
?:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
object
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
(...)
|
(...)
;
resolved
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
source
?:
{
[
key
:
string
]:
unknown
}
;
target
?:
{
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteComment
:
(
parameters
:
{
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssue
:
(
parameters
:
{
deleteSubtasks
?:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssueProperty
:
(
parameters
:
{
issueIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteIssueLinkByGlobalId
:
(
parameters
:
{
globalId
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteIssueLinkById
:
(
parameters
:
{
issueIdOrKey
:
string
;
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
id
:
string
;
increaseBy
?:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
doTransition
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
editIssue
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
notifyUsers
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
estimateIssueForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
;
value
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAgileIssue
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
issueIdOrKey
:
string
;
updateHistory
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComment
:
(
parameters
:
{
expand
?:
string
;
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComments
:
(
parameters
:
{
expand
?:
string
;
issueIdOrKey
:
string
;
maxResults
?:
string
;
orderBy
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
comments
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCreateIssueMetaFields
:
(
parameters
:
{
issueTypeId
:
string
;
maxResults
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
allowedValues
?:
Record
<
string
,
any
>
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
string
,
any
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
string
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCreateIssueMetaProjectIssueTypes
:
(
parameters
:
{
maxResults
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarId
?:
number
;
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getEditIssueMeta
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fields
?:
Record
<
string
,
{
allowedValues
?:
Record
<
(...)
,
(...)
>
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
string
,
any
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
string
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
(...)
|
(...)
;
customId
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
system
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssue
:
(
parameters
:
{
expand
?:
string
;
fields
?:
string
;
issueIdOrKey
:
string
;
properties
?:
string
;
updateHistory
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueEstimationForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuePickerResource
:
(
parameters
?:
{
currentIssueKey
?:
string
;
currentJQL
?:
string
;
currentProjectId
?:
string
;
query
?:
string
;
showSubTaskParent
?:
string
;
showSubTasks
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
sections
?:
{
id
?:
string
;
issues
?:
{
img
?:
...
;
key
?:
...
;
keyHtml
?:
...
;
summary
?:
...
;
summaryText
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
label
?:
string
;
msg
?:
string
;
sub
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueProperty
:
(
parameters
:
{
issueIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getIssuePropertyKeys
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueWatchers
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isWatching
?:
boolean
;
self
?:
string
;
watchCount
?:
number
;
watchers
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueWorklog
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
worklogs
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPinnedComments
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
comment
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
pinnedBy
?:
string
;
pinnedDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getRemoteIssueLinkById
:
(
parameters
:
{
issueIdOrKey
:
string
;
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
getRemoteIssueLinks
:
(
parameters
:
{
globalId
?:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
getSubTasks
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getTransitions
:
(
parameters
:
{
issueIdOrKey
:
string
;
transitionId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVotes
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
hasVoted
?:
boolean
;
self
?:
string
;
voters
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
votes
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorklog
:
(
parameters
:
{
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveSubTasks
:
(
parameters
:
{
current
?:
number
;
issueIdOrKey
:
string
;
original
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
notify
:
(
parameters
:
{
htmlBody
?:
string
;
issueIdOrKey
:
string
;
restrict
?:
{
groups
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
permissions
?:
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
(...)
&
(...)
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
subject
?:
string
;
textBody
?:
string
;
to
?:
{
assignee
?:
boolean
;
groups
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
reporter
?:
boolean
;
users
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
voters
?:
boolean
;
watchers
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
rankIssues
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
{
errors
?:
string
[]
;
issueId
?:
number
;
issueKey
?:
string
;
status
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeVote
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeWatcher
:
(
parameters
:
{
issueIdOrKey
:
string
;
username
?:
string
;
userName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
restoreIssue
:
(
parameters
:
{
issueIdOrKey
:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIssueProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
issueIdOrKey
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setPinComment
:
(
parameters
:
{
body
:
boolean
;
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateComment
:
(
parameters
:
{
body
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
;
id
:
string
;
issueIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateRemoteIssueLink
:
(
parameters
:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
issueIdOrKey
:
string
;
linkId
:
string
;
object
?:
{
icon
?:
{
link
?:
string
;
title
?:
string
;
url16x16
?:
string
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
resolved
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
body
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSearch
:
{
getError
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
errorStringI18n
?:
string
;
[
key
:
string
]:
unknown
}
>
;
search
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
searchUsingSearchRequest
:
(
parameters
:
{
expand
?:
string
[]
;
fields
?:
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSecurityLevel
:
{
getIssueSecurityLevel
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSecuritySchemes
:
{
getIssueSecurityScheme
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueSecuritySchemes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueSecuritySchemes
?:
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueTypes
:
{
createIssueType
:
(
parameters
:
{
description
?:
string
;
name
?:
string
;
type
?:
"standard"
|
string
&
{}
|
"subtask"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
createIssueTypeAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
id
:
string
;
needsCropping
?:
boolean
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueType
:
(
parameters
:
{
alternativeIssueTypeId
?:
string
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssueTypeProperty
:
(
parameters
:
{
issueTypeId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAlternativeIssueTypes
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueAllTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueTypeProperty
:
(
parameters
:
{
issueTypeId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getIssueTypePropertyKeys
:
(
parameters
:
{
issueTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPaginatedIssueTypes
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
"X-Requested-With"
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setIssueTypeProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
issueTypeId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryIssueTypeAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
updateIssueType
:
(
parameters
:
{
avatarId
?:
number
;
description
?:
string
;
id
:
string
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueTypeSchemes
:
{
addProjectAssociationsToScheme
:
(
parameters
:
{
idsOrKeys
?:
string
[]
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createIssueTypeScheme
:
(
parameters
:
{
defaultIssueTypeId
?:
string
;
description
?:
string
;
issueTypeIds
?:
string
[]
;
issueTypeIDs
?:
string
[]
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueTypeScheme
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllIssueTypeSchemes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
schemes
?:
{
defaultIssueType
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAssociatedProjects
:
(
parameters
:
{
expand
?:
string
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueTypeScheme
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeAllProjectAssociations
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeProjectAssociation
:
(
parameters
:
{
projIdOrKey
:
string
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setProjectAssociationsForScheme
:
(
parameters
:
{
idsOrKeys
?:
string
[]
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateIssueTypeScheme
:
(
parameters
:
{
defaultIssueTypeId
?:
string
;
description
?:
string
;
issueTypeIds
?:
string
[]
;
issueTypeIDs
?:
string
[]
;
name
?:
string
;
schemeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueWorklogs
:
{
getIdsOfWorklogsDeletedSince
:
(
parameters
?:
{
since
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLastPage
?:
boolean
;
lastPage
?:
boolean
;
nextPage
?:
string
;
self
?:
string
;
since
?:
number
;
until
?:
number
;
values
?:
{
updatedTime
?:
number
;
worklogId
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIdsOfWorklogsModifiedSince
:
(
parameters
?:
{
since
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLastPage
?:
boolean
;
lastPage
?:
boolean
;
nextPage
?:
string
;
self
?:
string
;
since
?:
number
;
until
?:
number
;
values
?:
{
updatedTime
?:
number
;
worklogId
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorklogsForIds
:
(
parameters
:
{
ids
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
jiraSettings
:
{
getIssueNavigatorDefaultColumns
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
setBaseURL
:
(
parameters
:
{
body
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIssueNavigatorDefaultColumnsForm
:
(
parameters
:
{
columns
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
jql
:
{
getAutoComplete
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
jqlReservedWords
?:
string
[]
;
visibleFieldNames
?:
{
auto
?:
string
;
cfid
?:
string
;
displayName
:
string
;
operators
:
string
[]
;
orderable
?:
string
;
searchable
?:
string
;
types
:
string
[]
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
visibleFunctionNames
?:
{
displayName
:
string
;
isList
?:
string
;
types
:
string
[]
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFieldAutoCompleteForQueryString
:
(
parameters
?:
{
fieldName
?:
string
;
fieldValue
?:
string
;
predicateName
?:
string
;
predicateValue
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
results
?:
{
displayName
:
string
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
licenseValidator
:
{
validate
:
(
parameters
:
{
body
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errors
?:
Record
<
string
,
string
>
;
licenseString
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
monitoring
:
{
areMetricsExposed
:
(
options
?:
RequestOptions
)
=>
Promise
<
boolean
>
;
getAvailableMetrics
:
(
options
?:
RequestOptions
)
=>
Promise
<
string
[]
>
;
isAppMonitoringEnabled
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
isIpdMonitoringEnabled
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
setAppMonitoringEnabled
:
(
parameters
:
{
enabled
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIpdMonitoringEnabled
:
(
parameters
:
{
enabled
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
start
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
stop
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
myPreferences
:
{
getPreference
:
(
parameters
?:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
>
;
removePreference
:
(
parameters
:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setPreference
:
(
parameters
:
{
body
?:
string
;
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
myself
:
{
changeMyPassword
:
(
parameters
:
{
currentPassword
?:
string
;
password
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getCurrentUser
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateCurrentUser
:
(
parameters
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
password
:
{
getPasswordPolicy
:
(
parameters
?:
{
hasOldPassword
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
policyCheckCreateUser
:
(
parameters
:
{
displayName
?:
string
;
emailAddress
?:
string
;
password
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
policyCheckUpdateUser
:
(
parameters
:
{
newPassword
?:
string
;
oldPassword
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
}
;
permissions
:
{
getAllPermissions
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissions
?:
Record
<
string
,
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
&
{}
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissions
:
(
parameters
?:
{
issueId
?:
string
;
issueKey
?:
string
;
projectId
?:
string
;
projectKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissions
?:
Record
<
string
,
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
&
{}
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
permissionSchemes
:
{
createPermissionGrant
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
(...)
|
(...)
;
customId
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
system
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
schemeId
:
number
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
(...)
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createPermissionScheme
:
(
parameters
:
{
body
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
...
;
field
?:
...
;
group
?:
...
;
parameter
?:
...
;
projectRole
?:
...
;
type
?:
...
;
user
?:
...
;
[
key
:
...
]:
...
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deletePermissionScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deletePermissionSchemeEntity
:
(
parameters
:
{
permissionId
:
number
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemeGrant
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
permissionId
:
number
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
(...)
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemeGrants
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemes
:
(
parameters
?:
{
expand
?:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissionSchemes
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
...
;
id
?:
...
;
permission
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSchemeAttribute
:
(
parameters
:
{
attributeKey
:
string
;
permissionSchemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
>
;
setSchemeAttribute
:
(
parameters
:
{
body
?:
string
;
key
:
string
;
permissionSchemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updatePermissionScheme
:
(
parameters
:
{
body
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
...
;
field
?:
...
;
group
?:
...
;
parameter
?:
...
;
projectRole
?:
...
;
type
?:
...
;
user
?:
...
;
[
key
:
...
]:
...
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
prioritySchemes
:
{
createPriorityScheme
:
(
parameters
:
{
defaultOptionId
?:
string
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deletePriorityScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPriorityScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPrioritySchemes
:
(
parameters
?:
{
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
maxResults
?:
number
;
schemes
?:
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
updatePriorityScheme
:
(
parameters
:
{
defaultOptionId
?:
string
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectCategories
:
{
createProjectCategory
:
(
parameters
:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectCategories
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectCategoryById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeProjectCategory
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateProjectCategory
:
(
parameters
:
{
body
:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectComponents
:
{
createComponent
:
(
parameters
:
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteComponent
:
(
parameters
:
{
id
:
string
;
moveIssuesTo
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getComponent
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComponentRelatedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
getPaginatedComponents
:
(
parameters
?:
{
maxResults
?:
string
;
projectIds
?:
string
;
query
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateComponent
:
(
parameters
:
{
body
?:
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectKeyAndNameValidation
:
{
validateProjectKey
:
(
parameters
?:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectRoles
:
{
addProjectRoleActorsToRole
:
(
parameters
:
{
group
?:
string
[]
;
id
:
number
;
user
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
createProjectRole
:
(
parameters
:
{
description
?:
string
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteProjectRole
:
(
parameters
:
{
id
:
number
;
swap
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectRoleActorsFromRole
:
(
parameters
:
{
group
?:
string
;
id
:
number
;
user
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
fullyUpdateProjectRole
:
(
parameters
:
{
description
?:
string
;
id
:
number
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectRoles
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectRoleActorsForRole
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRolesById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
partialUpdateProjectRole
:
(
parameters
:
{
description
?:
string
;
id
:
number
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projects
:
{
addActorUsers
:
(
parameters
:
{
group
?:
string
[]
;
id
:
number
;
projectIdOrKey
:
string
;
user
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
archiveProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
assignPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
id
?:
number
;
projectKeyOrId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
assignPriorityScheme
:
(
parameters
:
{
id
?:
number
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createProject
:
(
parameters
:
{
assigneeType
?:
string
&
{}
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
avatarId
?:
number
;
categoryId
?:
number
;
description
?:
string
;
issueSecurityScheme
?:
number
;
key
?:
string
;
lead
?:
string
;
name
?:
string
;
notificationScheme
?:
number
;
permissionScheme
?:
number
;
projectTemplateKey
?:
string
;
projectTypeKey
?:
string
;
url
?:
string
;
workflowSchemeId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
createProjectAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
projectIdOrKey
:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteActor
:
(
parameters
:
{
group
?:
string
;
id
:
number
;
projectIdOrKey
:
string
;
user
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectAvatar
:
(
parameters
:
{
id
:
number
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectProperty
:
(
parameters
:
{
projectIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAccessibleProjectTypeByKey
:
(
parameters
:
{
projectTypeKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectAvatars
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjects
:
(
parameters
?:
{
browseArchive
?:
boolean
;
expand
?:
string
;
includeArchived
?:
boolean
;
recent
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllProjectTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllStatuses
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
statuses
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAssignedPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAssignedPriorityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProject
:
(
parameters
:
{
expand
?:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectComponents
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectIssueSecurityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectNotificationScheme
:
(
parameters
:
{
expand
?:
string
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
notificationSchemeEvents
?:
{
event
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
notifications
?:
{
id
?:
...
;
notificationType
?:
...
;
parameter
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectProperty
:
(
parameters
:
{
projectIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getProjectPropertyKeys
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRole
:
(
parameters
:
{
id
:
number
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRoles
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
Record
<
string
,
string
>
>
;
getProjectTypeByKey
:
(
parameters
:
{
projectTypeKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectVersions
:
(
parameters
:
{
expand
?:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectVersionsPaginated
:
(
parameters
:
{
expand
?:
string
;
maxResults
?:
number
;
orderBy
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSecurityLevelsForProject
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkflowSchemeForProject
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
restoreProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
searchForProjects
:
(
parameters
?:
{
allowEmptyQuery
?:
boolean
;
maxResults
?:
number
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
header
?:
string
;
projects
?:
{
avatar
?:
string
;
html
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
setActors
:
(
parameters
:
{
body
:
{
categorisedActors
?:
Record
<
string
,
string
[]
>
;
id
?:
number
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
projectIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setProjectProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
projectIdOrKey
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryProjectAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
projectIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
unassignPriorityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateProject
:
(
parameters
:
{
assigneeType
?:
string
&
{}
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
avatarId
?:
number
;
categoryId
?:
number
;
description
?:
string
;
expand
?:
string
;
issueSecurityScheme
?:
number
;
key
?:
string
;
lead
?:
string
;
name
?:
string
;
notificationScheme
?:
number
;
permissionScheme
?:
number
;
projectIdOrKey
:
string
;
projectTemplateKey
?:
string
;
projectTypeKey
?:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateProjectAvatar
:
(
parameters
:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
projectIdOrKey
:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateProjectType
:
(
parameters
:
{
newProjectTypeKey
:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectVersions
:
{
createOrUpdateRemoteVersionLink
:
(
parameters
:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
versionId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createOrUpdateRemoteVersionLinkByGlobalId
:
(
parameters
:
{
globalId
:
string
;
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
versionId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createVersion
:
(
parameters
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
unknown
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
unknown
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteRemoteVersionLink
:
(
parameters
:
{
globalId
:
string
;
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteVersionLinksByVersionId
:
(
parameters
:
{
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVersionAndSwap
:
(
parameters
:
{
customFieldReplacementList
?:
{
customFieldId
?:
number
;
moveTo
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
id
:
string
;
moveAffectedIssuesTo
?:
number
;
moveFixIssuesTo
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPaginatedVersions
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLink
:
(
parameters
:
{
globalId
:
string
;
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLinks
:
(
parameters
?:
{
globalId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLinksByVersionId
:
(
parameters
:
{
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersion
:
(
parameters
:
{
expand
?:
string
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersionRelatedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
customFieldNames
?:
{
customFieldId
?:
number
;
fieldName
?:
string
;
issueCountWithVersionInCustomField
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
issueCountWithCustomFieldsShowingVersion
?:
number
;
issuesAffectedCount
?:
number
;
issuesFixedCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersionUnresolvedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issuesUnresolvedCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
merge
:
(
parameters
:
{
id
:
string
;
moveIssuesTo
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveVersion
:
(
parameters
:
{
after
?:
string
;
id
:
string
;
position
?:
string
&
{}
|
"Earlier"
|
"Later"
|
"First"
|
"Last"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateVersion
:
(
parameters
:
{
body
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
unknown
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
unknown
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
readOnlyMode
:
{
getReadOnlyMode
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
endTime
?:
string
;
message
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateReadOnlyMode
:
(
parameters
:
{
enabled
?:
boolean
;
endTime
?:
string
;
message
?:
string
;
timeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
screens
:
{
addField
:
(
parameters
:
{
fieldId
?:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
addFieldToDefaultScreen
:
(
parameters
:
{
fieldId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addTab
:
(
parameters
:
{
id
?:
number
;
name
?:
string
;
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
>
;
deleteTab
:
(
parameters
:
{
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllFields
:
(
parameters
:
{
projectKey
?:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllScreens
:
(
parameters
?:
{
expand
?:
string
;
maxResults
?:
string
;
search
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllTabs
:
(
parameters
:
{
projectKey
?:
string
;
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
[]
>
;
getFieldsToAdd
:
(
parameters
:
{
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
moveField
:
(
parameters
:
{
after
?:
string
;
id
:
string
;
position
?:
string
&
{}
|
"Earlier"
|
"Later"
|
"First"
|
"Last"
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveTab
:
(
parameters
:
{
pos
:
number
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeField
:
(
parameters
:
{
id
:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
renameTab
:
(
parameters
:
{
id
?:
number
;
name
?:
string
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
>
;
updateShowWhenEmptyIndicator
:
(
parameters
:
{
id
:
string
;
newValue
:
boolean
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
searchLimits
:
{
getMaxAggregationBuckets
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
>
;
getMaxResultWindow
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
>
;
}
;
serverInfo
:
{
getServerInfo
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
baseUrl
:
string
;
buildDate
?:
string
;
buildNumber
?:
number
;
databaseBuildNumber
?:
number
;
deploymentType
:
string
;
scmInfo
?:
string
;
serverTime
?:
string
;
serverTitle
?:
string
;
version
:
string
;
versionNumbers
:
number
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
session
:
{
currentUser
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
items
?:
Record
<
string
,
any
>
[]
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
items
?:
Record
<
string
,
any
>
[]
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
login
:
(
parameters
:
{
password
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
loginInfo
?:
{
failedLoginCount
?:
number
;
lastFailedLoginTime
?:
Date
;
loginCount
?:
number
;
previousLoginTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
;
session
?:
{
name
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
logout
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
sprint
:
{
createSprint
:
(
parameters
:
{
autoStartStop
?:
boolean
;
endDate
?:
string
;
goal
?:
string
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
startDate
?:
string
;
synced
?:
boolean
;
userProfileTimeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSprintProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssuesForSprint
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
sprintId
:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSprintProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getSprintPropertyKeys
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToSprint
:
(
parameters
:
{
issues
?:
string
[]
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateSprint
:
(
parameters
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
sprintId
:
number
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
setSprintProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
sprintId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
swapSprint
:
(
parameters
:
{
sprintId
:
number
;
sprintToSwapWith
?:
number
;
swap
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
unmapAllSprints
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
unmapSprints
:
(
parameters
:
{
sprintIds
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateSprint
:
(
parameters
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
sprintId
:
number
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
terminology
:
{
getAllTerminologyEntries
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
isDefault
?:
boolean
;
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
originalNamePlural
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getTerminologyEntry
:
(
parameters
:
{
originalName
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isDefault
?:
boolean
;
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
originalNamePlural
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setTerminologyEntries
:
(
parameters
:
{
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
}
;
upgrade
:
{
getUpgradeResult
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
duration
?:
number
;
message
?:
string
;
outcome
?:
string
;
startTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
runUpgradesNow
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
users
:
{
addUserToApplication
:
(
parameters
:
{
applicationKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
changeUserPassword
:
(
parameters
:
{
currentPassword
?:
string
;
key
?:
string
;
password
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createUser
:
(
parameters
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createUserAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
url
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
defaultColumns
:
(
parameters
?:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
deleteSession
:
(
parameters
:
{
username
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteUserAvatar
:
(
parameters
:
{
id
:
number
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteUserProperty
:
(
parameters
:
{
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
findAssignableUsers
:
(
parameters
?:
{
actionDescriptorId
?:
number
;
issueKey
?:
string
;
maxResults
?:
number
;
project
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findBulkAssignableUsers
:
(
parameters
?:
{
maxResults
?:
number
;
projectKeys
?:
string
|
string
[]
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsers
:
(
parameters
?:
{
includeActive
?:
boolean
;
includeInactive
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsersForPicker
:
(
parameters
?:
{
exclude
?:
string
[]
;
maxResults
?:
number
;
query
?:
string
;
showAvatar
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
header
?:
string
;
total
?:
number
;
users
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
html
?:
string
;
key
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsersWithBrowsePermission
:
(
parameters
?:
{
issueKey
?:
string
;
maxResults
?:
number
;
projectKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getA11yPersonalSettings
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
key
?:
string
;
[
key
:
string
]:
unknown
}
[]
,
>
;
getAllUserAvatars
:
(
parameters
?:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDuplicatedUsersCount
:
(
parameters
?:
{
flush
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDuplicatedUsersMapping
:
(
parameters
?:
{
flush
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUser
:
(
parameters
?:
{
includeDeleted
?:
boolean
;
key
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUserAnonymizationProgress
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getUserList
:
(
parameters
?:
{
cursor
?:
number
;
maxResults
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextCursor
?:
string
;
nextPage
?:
string
;
self
?:
string
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUserProperty
:
(
parameters
:
{
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getUserPropertyKeys
:
(
parameters
?:
{
userKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeUser
:
(
parameters
:
{
key
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeUserFromApplication
:
(
parameters
:
{
applicationKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
resetUserColumns
:
(
parameters
:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
scheduleUserAnonymization
:
(
parameters
:
{
newOwnerKey
?:
string
;
userKey
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
scheduleUserAnonymizationRerun
:
(
parameters
:
{
newOwnerKey
?:
string
;
oldUserKey
?:
string
;
oldUserName
?:
string
;
userKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setColumnsUrlEncoded
:
(
parameters
:
{
columns
?:
string
[]
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setUserProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryUserAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
unlockAnonymization
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
updateUser
:
(
parameters
:
{
body
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateUserAvatar
:
(
parameters
:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
validateUserAnonymization
:
(
parameters
?:
{
expand
?:
string
;
userKey
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedEntities
?:
Record
<
string
,
{
description
?:
string
;
numberOfOccurrences
?:
number
;
type
?:
|
(...)
&
(...)
|
"REMOVE"
|
"ANONYMIZE"
|
"TRANSFER_OWNERSHIP"
|
"MANUAL"
;
uri
?:
string
;
uriDisplayName
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
businessLogicValidationFailed
?:
boolean
;
deleted
?:
boolean
;
displayName
?:
string
;
email
?:
string
;
errors
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
expand
?:
string
;
operations
?:
string
[]
;
success
?:
boolean
;
userKey
?:
string
;
userName
?:
string
;
warnings
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
validateUserAnonymizationRerun
:
(
parameters
?:
{
expand
?:
string
;
oldUserKey
?:
string
;
oldUserName
?:
string
;
userKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedEntities
?:
Record
<
string
,
{
description
?:
string
;
numberOfOccurrences
?:
number
;
type
?:
|
(...)
&
(...)
|
"REMOVE"
|
"ANONYMIZE"
|
"TRANSFER_OWNERSHIP"
|
"MANUAL"
;
uri
?:
string
;
uriDisplayName
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
businessLogicValidationFailed
?:
boolean
;
deleted
?:
boolean
;
displayName
?:
string
;
email
?:
string
;
errors
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
expand
?:
string
;
operations
?:
string
[]
;
success
?:
boolean
;
userKey
?:
string
;
userName
?:
string
;
warnings
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
webhooks
:
{
createWebhook
:
(
parameters
:
{
configuration
?:
Record
<
string
,
any
>
;
events
?:
string
[]
;
excludeBody
?:
boolean
;
filters
?:
Record
<
string
,
any
>
;
name
:
string
;
sslVerificationRequired
?:
boolean
;
url
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteWebhook
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getLatestWebhookInvocation
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
getWebhook
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWebhooks
:
(
parameters
?:
{
event
?:
string
;
limit
?:
number
;
start
?:
number
;
statistics
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
(...)
|
(...)
;
failures
?:
(...)
|
(...)
;
successes
?:
(...)
|
(...)
;
window
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getWebhookStatistics
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
number
;
start
?:
number
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWebhookStatisticsSummary
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
Record
<
string
,
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
(...)
|
(...)
;
start
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
,
>
;
getWebhookTransitions
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
updateWebhook
:
(
parameters
:
{
configuration
?:
Record
<
string
,
any
>
;
events
?:
string
[]
;
excludeBody
?:
boolean
;
filters
?:
Record
<
string
,
any
>
;
name
:
string
;
sslVerificationRequired
?:
boolean
;
url
:
string
;
webhookId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
websudo
:
{
release
:
(
parameters
:
{
body
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
workflows
:
{
getAllWorkflows
:
(
parameters
?:
{
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
default
?:
boolean
;
description
?:
string
;
isDefault
?:
boolean
;
lastModifiedDate
?:
string
;
lastModifiedUser
?:
string
;
name
?:
string
;
steps
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
workflowSchemes
:
{
createDraftForParent
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
createScheme
:
(
parameters
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteDraftDefault
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftWorkflowMapping
:
(
parameters
:
{
id
:
number
;
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteScheme
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorkflowMapping
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteWorkflowSchemeIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
;
updateDraftIfNeeded
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getById
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDefault
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftDefault
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftWorkflow
:
(
parameters
:
{
id
:
number
;
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkflow
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
|
{
defaultMapping
?:
boolean
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
|
{
defaultMapping
?:
boolean
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getWorkflowSchemeIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
;
returnDraftIfExists
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setDraftIssueType
:
(
parameters
:
{
body
:
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
issueType
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
setIssueType
:
(
parameters
:
{
body
:
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
issueType
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraft
:
(
parameters
:
{
body
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraftDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraftWorkflowMapping
:
(
parameters
:
{
defaultMapping
?:
boolean
;
id
:
number
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateWorkflowMapping
:
(
parameters
:
{
defaultMapping
?:
boolean
;
id
:
number
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateWorkflowScheme
:
(
parameters
:
{
body
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
workflowStatusCategories
:
{
getStatusCategories
:
(
parameters
?:
{
request
?:
string
;
uriInfo
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getStatusCategory
:
(
parameters
:
{
idOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
workflowStatuses
:
{
getPaginatedStatuses
:
(
parameters
?:
{
issueTypeIds
?:
string
[]
;
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getStatus
:
(
parameters
:
{
idOrName
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getStatuses
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
}
Parameters
clientConfig
:
Client
|
ServerClientConfig
Returns
{
applicationProperties
:
{
getAdvancedSettings
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getApplicationProperties
:
(
parameters
?:
{
key
?:
string
;
keyFilter
?:
string
;
permissionLevel
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
setPropertyViaRestfulTable
:
(
parameters
:
{
body
:
{
id
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
allowedValues
?:
string
[]
;
defaultValue
?:
string
;
desc
?:
string
;
example
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
applicationRoles
:
{
getAll
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getApplicationRole
:
(
parameters
:
{
key
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
putBulk
:
(
parameters
:
{
body
?:
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
"If-Match"
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
updateApplicationRole
:
(
parameters
:
{
body
?:
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
;
"If-Match"
?:
string
;
key
:
string
;
versionHash
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultGroups
?:
string
[]
;
defined
?:
boolean
;
groups
?:
string
[]
;
hasUnlimitedSeats
?:
boolean
;
key
?:
string
;
name
?:
string
;
numberOfSeats
?:
number
;
platform
?:
boolean
;
remainingSeats
?:
number
;
selectedByDefault
?:
boolean
;
userCount
?:
number
;
userCountDescription
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
avatars
:
{
createAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
owningObjectId
:
string
;
type
:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteAvatar
:
(
parameters
:
{
id
:
number
;
owningObjectId
:
string
;
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllSystemAvatars
:
(
parameters
:
{
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAvatars
:
(
parameters
:
{
owningObjectId
:
string
;
type
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
storeTemporaryAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
owningObjectId
:
string
;
type
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
backlog
:
{
moveIssuesToBacklog
:
(
parameters
:
{
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
board
:
{
createBoard
:
(
parameters
:
{
filterId
?:
number
;
name
?:
string
;
type
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBoardProperty
:
(
parameters
:
{
boardId
:
number
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllBoards
:
(
parameters
?:
{
maxResults
?:
number
;
name
?:
string
;
projectKeyOrId
?:
string
;
startAt
?:
number
;
type
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllSprints
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
state
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllVersions
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
released
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
archived
?:
boolean
;
description
?:
string
;
id
:
number
;
name
:
string
;
overdue
?:
boolean
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
string
;
self
?:
string
;
userReleaseDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardConfiguration
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
columnConfig
?:
{
columns
?:
{
max
?:
(...)
|
(...)
;
min
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
statuses
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
constraintType
?:
string
;
[
key
:
string
]:
unknown
;
}
;
estimation
?:
{
field
?:
{
displayName
?:
string
;
fieldId
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
filter
?:
{
id
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
name
?:
string
;
ranking
?:
{
rankCustomFieldId
?:
number
;
[
key
:
string
]:
unknown
}
;
self
?:
string
;
subQuery
?:
{
query
?:
string
;
[
key
:
string
]:
unknown
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardProperty
:
(
parameters
:
{
boardId
:
number
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getBoardPropertyKeys
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getEpics
:
(
parameters
:
{
boardId
:
number
;
done
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
color
?:
{
key
?:
|
(...)
&
(...)
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBacklog
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoardEpic
:
(
parameters
:
{
boardId
:
number
;
epicId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoardSprint
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
sprintId
:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpicForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjects
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarUrls
?:
Record
<
string
,
string
>
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRefinedVelocity
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
value
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
setBoardProperty
:
(
parameters
:
{
boardId
:
number
;
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setRefinedVelocity
:
(
parameters
:
{
boardId
:
number
;
value
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
cluster
:
{
acknowledgeErrors
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
approveUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
cancelUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
changeNodeStateToOffline
:
(
parameters
:
{
nodeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteNode
:
(
parameters
:
{
nodeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllNodes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
alive
?:
boolean
;
cacheListenerPort
?:
number
;
ip
?:
string
;
lastStateChangeTimestamp
?:
number
;
nodeBuildNumber
?:
number
;
nodeId
?:
string
;
nodeVersion
?:
string
;
state
?:
|
string
&
{}
|
"ACTIVE"
|
"PASSIVE"
|
"ACTIVATING"
|
"PASSIVATING"
|
"OFFLINE"
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getState
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
build
?:
{
buildNumber
?:
number
;
version
?:
string
;
[
key
:
string
]:
unknown
;
}
;
state
?:
|
string
&
{}
|
"STABLE"
|
"READY_TO_UPGRADE"
|
"MIXED"
|
"READY_TO_RUN_UPGRADE_TASKS"
|
"RUNNING_UPGRADE_TASKS"
|
"UPGRADE_TASKS_FAILED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
setReadyToUpgrade
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
configuration
:
{
getConfiguration
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
attachmentsEnabled
?:
boolean
;
issueLinkingEnabled
?:
boolean
;
subTasksEnabled
?:
boolean
;
timeTrackingConfiguration
?:
{
defaultUnit
?:
"day"
|
"hour"
|
"minute"
|
"week"
|
string
&
{}
;
timeFormat
?:
"days"
|
"hours"
|
string
&
{}
|
"pretty"
;
workingDaysPerWeek
?:
number
;
workingHoursPerDay
?:
number
;
[
key
:
string
]:
unknown
;
}
;
timeTrackingEnabled
?:
boolean
;
unassignedIssuesAllowed
?:
boolean
;
votingEnabled
?:
boolean
;
watchingEnabled
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
dashboards
:
{
deleteDashboardItemProperty
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getDashboard
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
view
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDashboardItemProperty
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getDashboardItemPropertyKeys
:
(
parameters
:
{
dashboardId
:
string
;
itemId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
list
:
(
parameters
?:
{
filter
?:
string
;
maxResults
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
dashboards
?:
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
view
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
next
?:
string
;
prev
?:
string
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
setDashboardItemProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
dashboardId
:
string
;
itemId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
emailTemplates
:
{
applyEmailTemplates
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
downloadEmailTemplates
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
ArrayBuffer
|
ArrayBufferView
<
ArrayBufferLike
>
>
;
getEmailTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
emailTypes
?:
{
active
?:
boolean
;
batchedNotification
?:
boolean
;
eventName
?:
string
;
html
?:
boolean
;
id
?:
number
;
templateName
?:
string
;
text
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
userEmailAddress
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
revertEmailTemplatesToDefault
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
uploadEmailTemplates
:
(
parameters
:
{
body
:
Blob
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
epic
:
{
getEpic
:
(
parameters
:
{
epicIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForEpic
:
(
parameters
:
{
epicIdOrKey
:
string
;
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpic
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToEpic
:
(
parameters
:
{
epicIdOrKey
:
string
;
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateEpic
:
(
parameters
:
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
epicIdOrKey
:
string
;
name
?:
string
;
summary
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
|
string
&
{}
|
"color_1"
|
"color_2"
|
"color_3"
|
"color_4"
|
"color_5"
|
"color_6"
|
"color_7"
|
"color_8"
|
"color_9"
|
"color_10"
|
"color_11"
|
"color_12"
|
"color_13"
|
"color_14"
;
[
key
:
string
]:
unknown
;
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
rankEpics
:
(
parameters
:
{
epicIdOrKey
:
string
;
rankAfterEpic
?:
string
;
rankBeforeEpic
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeIssuesFromEpic
:
(
parameters
:
{
issues
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
filters
:
{
addSharePermission
:
(
parameters
:
{
edit
?:
boolean
;
groupname
?:
string
;
id
:
string
;
projectId
?:
string
;
projectRoleId
?:
string
;
type
?:
string
;
userKey
?:
string
;
view
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
createFilter
:
(
parameters
:
{
description
?:
string
;
editable
?:
boolean
;
expand
?:
string
|
string
[]
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
...
;
maxResults
?:
...
;
pagingCallback
?:
...
;
size
?:
...
;
[
key
:
...
]:
...
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteFilter
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSharePermission
:
(
parameters
:
{
id
:
string
;
permissionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
editFilter
:
(
parameters
:
{
body
?:
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
}
;
id
?:
number
;
project
?:
{
archived
?:
...
;
avatarUrls
?:
...
;
description
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
role
?:
{
actors
?:
...
;
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
user
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDefaultShareScope
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFavouriteFilters
:
(
parameters
?:
{
expand
?:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
}
;
id
?:
number
;
project
?:
{
archived
?:
...
;
avatarUrls
?:
...
;
description
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
role
?:
{
actors
?:
...
;
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
user
?:
{
active
?:
...
;
applicationRoles
?:
...
;
avatarUrls
?:
...
;
deleted
?:
...
;
displayName
?:
...
;
emailAddress
?:
...
;
expand
?:
...
;
groups
?:
...
;
key
?:
...
;
lastLoginTime
?:
...
;
locale
?:
...
;
name
?:
...
;
self
?:
...
;
timeZone
?:
...
;
[
key
:
...
]:
...
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getFilter
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
editable
?:
boolean
;
favourite
?:
boolean
;
id
?:
string
;
jql
?:
string
;
name
?:
string
;
owner
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchUrl
?:
string
;
self
?:
string
;
sharedUsers
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
sharePermissions
?:
{
edit
?:
boolean
;
group
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
project
?:
{
archived
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
(...)
|
(...)
|
(...)
;
applicationRoles
?:
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
deleted
?:
(...)
|
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
expand
?:
(...)
|
(...)
;
groups
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
lastLoginTime
?:
(...)
|
(...)
;
locale
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
viewUrl
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFilterColumns
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
columnConfig
?:
|
string
&
{}
|
"NONE"
|
"SYSTEM"
|
"EXPLICIT"
|
"FILTER"
|
"USER"
;
columnLayoutItems
?:
{
columnHeadingKey
?:
string
;
id
?:
string
;
navigableField
?:
{
columnCssClass
?:
...
;
columnHeadingKey
?:
...
;
defaultSortOrder
?:
...
;
hiddenFieldId
?:
...
;
id
?:
...
;
name
?:
...
;
nameKey
?:
...
;
valueLoader
?:
...
;
[
key
:
...
]:
...
;
}
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getSharePermission
:
(
parameters
:
{
id
:
string
;
permissionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSharePermissions
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
edit
?:
boolean
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
id
?:
number
;
project
?:
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
role
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
view
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
resetColumns
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setColumns
:
(
parameters
:
{
columns
?:
string
[]
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setDefaultShareScope
:
(
parameters
:
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
scope
?:
string
&
{}
|
"GLOBAL"
|
"AUTHENTICATED"
|
"PRIVATE"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
groupAndUserPicker
:
{
findUsersAndGroups
:
(
parameters
?:
{
fieldId
?:
string
;
issueTypeId
?:
string
;
maxResults
?:
string
;
projectId
?:
string
;
query
?:
string
;
showAvatar
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
groups
?:
{
groups
?:
{
html
?:
(...)
|
(...)
;
labels
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
header
?:
string
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
users
?:
{
header
?:
string
;
total
?:
number
;
users
?:
{
avatarUrl
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
html
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
groups
:
{
addUserToGroup
:
(
parameters
:
{
groupname
:
string
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
name
?:
string
;
self
?:
string
;
users
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
createGroup
:
(
parameters
:
{
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
name
?:
string
;
self
?:
string
;
users
?:
{
backingListSize
?:
number
;
callback
?:
{
[
key
:
string
]:
unknown
}
;
items
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
findGroups
:
(
parameters
?:
{
exclude
?:
string
;
maxResults
?:
string
;
query
?:
string
;
userName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
groups
?:
{
html
?:
string
;
labels
?:
{
text
?:
...
;
title
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
}
[]
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
header
?:
string
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUsersFromGroup
:
(
parameters
:
{
groupname
:
string
;
includeInactiveUsers
?:
string
;
maxResults
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeGroup
:
(
parameters
:
{
groupname
:
string
;
swapGroup
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeUserFromGroup
:
(
parameters
:
{
groupname
:
string
;
username
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
indexing
:
{
createIndexSnapshot
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
futureAbsolutePath
?:
string
;
[
key
:
string
]:
unknown
}
>
;
getIndexSummary
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
externalPlatformIndexReplay
?:
Record
<
string
,
{
lastConsumedOperation
?:
{
id
?:
(...)
|
(...)
;
journalWriteTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastOperationInQueue
?:
{
id
?:
(...)
|
(...)
;
journalWriteTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
queueSize
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
issueIndex
?:
{
countInArchive
?:
number
;
countInDatabase
?:
number
;
countInIndex
?:
number
;
indexReadable
?:
boolean
;
lastUpdatedInDatabase
?:
Date
;
lastUpdatedInIndex
?:
Date
;
[
key
:
string
]:
unknown
;
}
;
nodeId
?:
string
;
replicationQueues
?:
Record
<
string
,
{
lastConsumedOperation
?:
{
id
?:
(...)
|
(...)
;
replicationTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastOperationInQueue
?:
{
id
?:
(...)
|
(...)
;
replicationTime
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
queueSize
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
reportTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProgressBulk
:
(
parameters
?:
{
requestId
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
getReindexInfo
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReindexProgress
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReindexRequestProgress
:
(
parameters
:
{
requestId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completionTime
?:
Date
;
id
?:
number
;
requestTime
?:
Date
;
startTime
?:
Date
;
status
?:
|
string
&
{}
|
"RUNNING"
|
"COMPLETE"
|
"FAILED"
|
"PENDING"
|
"ACTIVE"
;
type
?:
string
&
{}
|
"IMMEDIATE"
|
"DELAYED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
isIndexSnapshotRunning
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
running
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
listIndexSnapshot
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
absolutePath
?:
string
;
timestamp
?:
number
;
[
key
:
string
]:
unknown
}
[]
,
>
;
processRequests
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
[]
>
;
reindex
:
(
parameters
:
{
indexChangeHistory
?:
boolean
;
indexComments
?:
boolean
;
indexWorklogs
?:
boolean
;
type
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
reindexIssues
:
(
parameters
:
{
indexChangeHistory
?:
boolean
;
indexComments
?:
boolean
;
indexWorklogs
?:
boolean
;
issueId
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
currentProgress
?:
number
;
currentSubTask
?:
string
;
finishTime
?:
Date
;
progressUrl
?:
string
;
startTime
?:
Date
;
submittedTime
?:
Date
;
success
?:
boolean
;
type
?:
|
string
&
{}
|
"FOREGROUND"
|
"BACKGROUND"
|
"BACKGROUND_PREFFERED"
|
"BACKGROUND_PREFERRED"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueAttachments
:
{
expandForHumans
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
Record
<
string
,
any
>
;
id
?:
number
;
mediaType
?:
string
;
name
?:
string
;
totalEntryCount
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
expandForMachines
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
{
abbreviatedName
?:
string
;
entryIndex
?:
number
;
mediaType
?:
string
;
name
?:
string
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
totalEntryCount
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAttachment
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
content
?:
string
;
created
?:
string
;
filename
?:
string
;
id
?:
string
;
mimeType
?:
string
;
properties
?:
Record
<
string
,
any
>
;
self
?:
string
;
size
?:
number
;
thumbnail
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAttachmentMeta
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
uploadLimit
?:
number
;
[
key
:
string
]:
unknown
}
,
>
;
removeAttachment
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueComments
:
{
deleteCommentProperty
:
(
parameters
:
{
commentId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getCommentProperty
:
(
parameters
:
{
commentId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getCommentPropertyKeys
:
(
parameters
:
{
commentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setCommentProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
commentId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueCustomFieldOptions
:
{
getCustomFieldOption
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
childrenIds
?:
number
[]
;
disabled
?:
boolean
;
id
?:
number
;
self
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueFields
:
{
bulkDeleteCustomFields
:
(
parameters
:
{
ids
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
deletedCustomFields
?:
string
[]
;
message
?:
string
;
notDeletedCustomFields
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
createCustomField
:
(
parameters
:
{
description
?:
string
;
id
?:
string
;
issueTypeIds
?:
string
[]
;
name
?:
string
;
projectIds
?:
number
[]
;
searcherKey
?:
string
;
self
?:
string
;
type
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCustomFieldOptions
:
(
parameters
:
{
customFieldId
:
string
;
issueTypeIds
?:
string
;
maxResults
?:
string
;
page
?:
string
;
projectIds
?:
string
;
query
?:
string
;
sortByOptionName
?:
string
;
useAllContexts
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
options
?:
{
childrenIds
?:
number
[]
;
disabled
?:
boolean
;
id
?:
number
;
self
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCustomFields
:
(
parameters
?:
{
lastValueUpdate
?:
string
;
maxResults
?:
string
;
projectIds
?:
string
;
screenIds
?:
string
;
search
?:
string
;
sortColumn
?:
string
;
sortOrder
?:
string
;
startAt
?:
string
;
types
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
id
?:
string
;
isAllProjects
?:
boolean
;
isLocked
?:
boolean
;
isManaged
?:
boolean
;
issuesWithValue
?:
number
;
issueTypeIds
?:
string
[]
;
isTrusted
?:
boolean
;
lastValueUpdate
?:
Date
;
name
?:
string
;
numericId
?:
number
;
projectIds
?:
number
[]
;
projectsCount
?:
number
;
screensCount
?:
number
;
searcherKey
?:
string
;
self
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFields
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
issueLinks
:
{
deleteIssueLink
:
(
parameters
:
{
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssueLink
:
(
parameters
:
{
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
;
priority
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
status
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
outwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
;
priority
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
status
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
self
?:
string
;
type
?:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
linkIssues
:
(
parameters
:
{
comment
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
inwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
outwardIssue
?:
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
issueLinkTypes
:
{
createIssueLinkType
:
(
parameters
:
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueLinkTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
moveIssueLinkType
:
(
parameters
:
{
issueLinkTypeId
:
string
;
newPosition
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
resetOrder
:
(
parameters
:
{
direction
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
updateIssueLinkType
:
(
parameters
:
{
id
?:
string
;
inward
?:
string
;
issueLinkTypeId
:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
inward
?:
string
;
name
?:
string
;
outward
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueNotificationSchemes
:
{
getNotificationScheme
:
(
parameters
:
{
expand
?:
string
;
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
notificationSchemeEvents
?:
{
event
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
notifications
?:
{
id
?:
...
;
notificationType
?:
...
;
parameter
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getNotificationSchemes
:
(
parameters
?:
{
expand
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issuePriorities
:
{
getPriorities
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getPrioritiesPaginated
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPriority
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueResolutions
:
{
getPaginatedResolutions
:
(
parameters
?:
{
maxResults
?:
number
;
query
?:
string
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getResolution
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getResolutions
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
issues
:
{
addAttachment
:
(
parameters
:
{
attachments
:
AttachmentInput
|
AttachmentInput
[]
;
issueIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
content
?:
string
;
created
?:
Date
;
filename
?:
string
;
id
?:
string
;
mimeType
?:
string
;
self
?:
string
;
size
?:
number
;
thumbnail
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
addComment
:
(
parameters
:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
expand
?:
string
;
id
?:
string
;
issueIdOrKey
:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
addVote
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addWatcher
:
(
parameters
:
{
body
?:
string
;
issueIdOrKey
:
string
;
userName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
reduceBy
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
archiveIssue
:
(
parameters
:
{
issueIdOrKey
:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
archiveIssues
:
(
parameters
:
{
body
?:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
assign
:
(
parameters
:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
canMoveSubTask
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
boolean
>
;
createIssue
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
updateHistory
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
createIssues
:
(
parameters
:
{
issueUpdates
?:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
cause
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
(...)
,
(...)
>
;
generator
?:
{
avatarUrl
?:
...
;
displayName
?:
...
;
displayNameKey
?:
...
;
id
?:
...
;
type
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
properties
?:
{
key
?:
(...)
|
(...)
;
value
?:
unknown
;
[
key
:
string
]:
unknown
;
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
(...)
,
(...)
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
statusCategory
?:
...
;
statusColor
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
,
>
;
[
key
:
string
]:
unknown
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errors
?:
{
elementErrors
?:
{
errorMessages
?:
(...)
|
(...)
;
errors
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
failedElementNumber
?:
number
;
status
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
issues
?:
{
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
createOrUpdateRemoteIssueLink
:
(
parameters
:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
issueIdOrKey
:
string
;
object
?:
{
icon
?:
{
link
?:
string
;
title
?:
string
;
url16x16
?:
string
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
resolved
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
createReciprocalRemoteIssueLink
:
(
parameters
:
{
source
?:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
object
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
(...)
|
(...)
;
resolved
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
[
key
:
string
]:
unknown
;
}
;
target
?:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
object
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
(...)
|
(...)
;
resolved
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
source
?:
{
[
key
:
string
]:
unknown
}
;
target
?:
{
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteComment
:
(
parameters
:
{
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssue
:
(
parameters
:
{
deleteSubtasks
?:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssueProperty
:
(
parameters
:
{
issueIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteIssueLinkByGlobalId
:
(
parameters
:
{
globalId
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteIssueLinkById
:
(
parameters
:
{
issueIdOrKey
:
string
;
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
id
:
string
;
increaseBy
?:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
doTransition
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
editIssue
:
(
parameters
:
{
fields
?:
Record
<
string
,
any
>
;
historyMetadata
?:
{
activityDescription
?:
string
;
activityDescriptionKey
?:
string
;
actor
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
cause
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
descriptionKey
?:
string
;
emailDescription
?:
string
;
emailDescriptionKey
?:
string
;
extraData
?:
Record
<
string
,
string
>
;
generator
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
displayNameKey
?:
string
;
id
?:
string
;
type
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
issueIdOrKey
:
string
;
notifyUsers
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
transition
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
(...)
,
(...)
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
(...)
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
update
?:
Record
<
string
,
{
operation
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
estimateIssueForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
;
value
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAgileIssue
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
issueIdOrKey
:
string
;
updateHistory
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComment
:
(
parameters
:
{
expand
?:
string
;
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComments
:
(
parameters
:
{
expand
?:
string
;
issueIdOrKey
:
string
;
maxResults
?:
string
;
orderBy
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
comments
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCreateIssueMetaFields
:
(
parameters
:
{
issueTypeId
:
string
;
maxResults
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
allowedValues
?:
Record
<
string
,
any
>
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
string
,
any
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
string
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getCreateIssueMetaProjectIssueTypes
:
(
parameters
:
{
maxResults
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarId
?:
number
;
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getEditIssueMeta
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fields
?:
Record
<
string
,
{
allowedValues
?:
Record
<
(...)
,
(...)
>
[]
;
autoCompleteUrl
?:
string
;
defaultValue
?:
Record
<
string
,
any
>
;
fieldId
?:
string
;
hasDefaultValue
?:
boolean
;
name
?:
string
;
operations
?:
string
[]
;
required
?:
boolean
;
schema
?:
{
custom
?:
(...)
|
(...)
;
customId
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
system
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssue
:
(
parameters
:
{
expand
?:
string
;
fields
?:
string
;
issueIdOrKey
:
string
;
properties
?:
string
;
updateHistory
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
changelog
?:
{
histories
?:
{
author
?:
(...)
|
(...)
;
created
?:
(...)
|
(...)
;
historyMetadata
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
string
,
{
allowedValues
?:
(...)
|
(...)
;
autoCompleteUrl
?:
(...)
|
(...)
;
defaultValue
?:
(...)
|
(...)
;
fieldId
?:
(...)
|
(...)
;
hasDefaultValue
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
operations
?:
(...)
|
(...)
;
required
?:
(...)
|
(...)
|
(...)
;
schema
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
string
[]
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueEstimationForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuePickerResource
:
(
parameters
?:
{
currentIssueKey
?:
string
;
currentJQL
?:
string
;
currentProjectId
?:
string
;
query
?:
string
;
showSubTaskParent
?:
string
;
showSubTasks
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
sections
?:
{
id
?:
string
;
issues
?:
{
img
?:
...
;
key
?:
...
;
keyHtml
?:
...
;
summary
?:
...
;
summaryText
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
label
?:
string
;
msg
?:
string
;
sub
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueProperty
:
(
parameters
:
{
issueIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getIssuePropertyKeys
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueWatchers
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isWatching
?:
boolean
;
self
?:
string
;
watchCount
?:
number
;
watchers
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueWorklog
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
worklogs
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPinnedComments
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
comment
?:
{
author
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
emailAddress
?:
(...)
|
(...)
;
key
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
timeZone
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
(...)
|
(...)
|
(...)
|
(...)
;
value
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
pinnedBy
?:
string
;
pinnedDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getRemoteIssueLinkById
:
(
parameters
:
{
issueIdOrKey
:
string
;
linkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
>
;
getRemoteIssueLinks
:
(
parameters
:
{
globalId
?:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
getSubTasks
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fields
?:
{
issuetype
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
priority
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getTransitions
:
(
parameters
:
{
issueIdOrKey
:
string
;
transitionId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
transitions
?:
{
description
?:
string
;
fields
?:
Record
<
string
,
{
allowedValues
?:
...
;
autoCompleteUrl
?:
...
;
defaultValue
?:
...
;
fieldId
?:
...
;
hasDefaultValue
?:
...
;
name
?:
...
;
operations
?:
...
;
required
?:
...
;
schema
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
id
?:
string
;
name
?:
string
;
opsbarSequence
?:
number
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
statusColor
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVotes
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
hasVoted
?:
boolean
;
self
?:
string
;
voters
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
votes
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorklog
:
(
parameters
:
{
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveSubTasks
:
(
parameters
:
{
current
?:
number
;
issueIdOrKey
:
string
;
original
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
notify
:
(
parameters
:
{
htmlBody
?:
string
;
issueIdOrKey
:
string
;
restrict
?:
{
groups
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
permissions
?:
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
(...)
&
(...)
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
subject
?:
string
;
textBody
?:
string
;
to
?:
{
assignee
?:
boolean
;
groups
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
reporter
?:
boolean
;
users
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
voters
?:
boolean
;
watchers
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
rankIssues
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
entries
?:
{
errors
?:
string
[]
;
issueId
?:
number
;
issueKey
?:
string
;
status
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeVote
:
(
parameters
:
{
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeWatcher
:
(
parameters
:
{
issueIdOrKey
:
string
;
username
?:
string
;
userName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
restoreIssue
:
(
parameters
:
{
issueIdOrKey
:
string
;
notifyUsers
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIssueProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
issueIdOrKey
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setPinComment
:
(
parameters
:
{
body
:
boolean
;
id
:
string
;
issueIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateComment
:
(
parameters
:
{
body
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
;
id
:
string
;
issueIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
body
?:
string
;
created
?:
string
;
id
?:
string
;
properties
?:
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
[]
;
renderedBody
?:
string
;
self
?:
string
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateRemoteIssueLink
:
(
parameters
:
{
application
?:
{
name
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
;
globalId
?:
string
;
issueIdOrKey
:
string
;
linkId
:
string
;
object
?:
{
icon
?:
{
link
?:
string
;
title
?:
string
;
url16x16
?:
string
;
[
key
:
string
]:
unknown
;
}
;
status
?:
{
icon
?:
{
link
?:
(...)
|
(...)
;
title
?:
(...)
|
(...)
;
url16x16
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
resolved
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
summary
?:
string
;
title
?:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
relationship
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateWorklog
:
(
parameters
:
{
adjustEstimate
?:
string
;
body
?:
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
issueIdOrKey
:
string
;
newEstimate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSearch
:
{
getError
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
errorStringI18n
?:
string
;
[
key
:
string
]:
unknown
}
>
;
search
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
searchUsingSearchRequest
:
(
parameters
:
{
expand
?:
string
[]
;
fields
?:
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSecurityLevel
:
{
getIssueSecurityLevel
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueSecuritySchemes
:
{
getIssueSecurityScheme
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueSecuritySchemes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueSecuritySchemes
?:
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueTypes
:
{
createIssueType
:
(
parameters
:
{
description
?:
string
;
name
?:
string
;
type
?:
"standard"
|
string
&
{}
|
"subtask"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
createIssueTypeAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
id
:
string
;
needsCropping
?:
boolean
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueType
:
(
parameters
:
{
alternativeIssueTypeId
?:
string
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIssueTypeProperty
:
(
parameters
:
{
issueTypeId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAlternativeIssueTypes
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueAllTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueType
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssueTypeProperty
:
(
parameters
:
{
issueTypeId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getIssueTypePropertyKeys
:
(
parameters
:
{
issueTypeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPaginatedIssueTypes
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
"X-Requested-With"
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
setIssueTypeProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
issueTypeId
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryIssueTypeAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
updateIssueType
:
(
parameters
:
{
avatarId
?:
number
;
description
?:
string
;
id
:
string
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueTypeSchemes
:
{
addProjectAssociationsToScheme
:
(
parameters
:
{
idsOrKeys
?:
string
[]
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createIssueTypeScheme
:
(
parameters
:
{
defaultIssueTypeId
?:
string
;
description
?:
string
;
issueTypeIds
?:
string
[]
;
issueTypeIDs
?:
string
[]
;
name
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteIssueTypeScheme
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllIssueTypeSchemes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
schemes
?:
{
defaultIssueType
?:
{
avatarId
?:
(...)
|
(...)
;
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
subtask
?:
(...)
|
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
...
;
description
?:
...
;
iconUrl
?:
...
;
id
?:
...
;
name
?:
...
;
self
?:
...
;
subtask
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAssociatedProjects
:
(
parameters
:
{
expand
?:
string
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getIssueTypeScheme
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeAllProjectAssociations
:
(
parameters
:
{
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeProjectAssociation
:
(
parameters
:
{
projIdOrKey
:
string
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setProjectAssociationsForScheme
:
(
parameters
:
{
idsOrKeys
?:
string
[]
;
schemeId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateIssueTypeScheme
:
(
parameters
:
{
defaultIssueTypeId
?:
string
;
description
?:
string
;
issueTypeIds
?:
string
[]
;
issueTypeIDs
?:
string
[]
;
name
?:
string
;
schemeId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultIssueType
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
issueTypes
?:
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issueWorklogs
:
{
getIdsOfWorklogsDeletedSince
:
(
parameters
?:
{
since
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLastPage
?:
boolean
;
lastPage
?:
boolean
;
nextPage
?:
string
;
self
?:
string
;
since
?:
number
;
until
?:
number
;
values
?:
{
updatedTime
?:
number
;
worklogId
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIdsOfWorklogsModifiedSince
:
(
parameters
?:
{
since
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLastPage
?:
boolean
;
lastPage
?:
boolean
;
nextPage
?:
string
;
self
?:
string
;
since
?:
number
;
until
?:
number
;
values
?:
{
updatedTime
?:
number
;
worklogId
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorklogsForIds
:
(
parameters
:
{
ids
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
author
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
comment
?:
string
;
created
?:
string
;
id
?:
string
;
issueId
?:
string
;
self
?:
string
;
started
?:
string
;
timeSpent
?:
string
;
timeSpentSeconds
?:
number
;
updateAuthor
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updated
?:
string
;
visibility
?:
{
type
?:
"role"
|
"group"
|
string
&
{}
;
value
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
jiraSettings
:
{
getIssueNavigatorDefaultColumns
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
setBaseURL
:
(
parameters
:
{
body
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIssueNavigatorDefaultColumnsForm
:
(
parameters
:
{
columns
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
jql
:
{
getAutoComplete
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
jqlReservedWords
?:
string
[]
;
visibleFieldNames
?:
{
auto
?:
string
;
cfid
?:
string
;
displayName
:
string
;
operators
:
string
[]
;
orderable
?:
string
;
searchable
?:
string
;
types
:
string
[]
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
visibleFunctionNames
?:
{
displayName
:
string
;
isList
?:
string
;
types
:
string
[]
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFieldAutoCompleteForQueryString
:
(
parameters
?:
{
fieldName
?:
string
;
fieldValue
?:
string
;
predicateName
?:
string
;
predicateValue
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
results
?:
{
displayName
:
string
;
value
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
licenseValidator
:
{
validate
:
(
parameters
:
{
body
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errors
?:
Record
<
string
,
string
>
;
licenseString
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
monitoring
:
{
areMetricsExposed
:
(
options
?:
RequestOptions
)
=>
Promise
<
boolean
>
;
getAvailableMetrics
:
(
options
?:
RequestOptions
)
=>
Promise
<
string
[]
>
;
isAppMonitoringEnabled
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
isIpdMonitoringEnabled
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
[
key
:
string
]:
unknown
}
>
;
setAppMonitoringEnabled
:
(
parameters
:
{
enabled
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setIpdMonitoringEnabled
:
(
parameters
:
{
enabled
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
start
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
stop
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
myPreferences
:
{
getPreference
:
(
parameters
?:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
>
;
removePreference
:
(
parameters
:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setPreference
:
(
parameters
:
{
body
?:
string
;
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
myself
:
{
changeMyPassword
:
(
parameters
:
{
currentPassword
?:
string
;
password
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getCurrentUser
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateCurrentUser
:
(
parameters
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
password
:
{
getPasswordPolicy
:
(
parameters
?:
{
hasOldPassword
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
policyCheckCreateUser
:
(
parameters
:
{
displayName
?:
string
;
emailAddress
?:
string
;
password
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
policyCheckUpdateUser
:
(
parameters
:
{
newPassword
?:
string
;
oldPassword
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
string
[]
>
;
}
;
permissions
:
{
getAllPermissions
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissions
?:
Record
<
string
,
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
&
{}
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissions
:
(
parameters
?:
{
issueId
?:
string
;
issueKey
?:
string
;
projectId
?:
string
;
projectKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissions
?:
Record
<
string
,
{
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
type
?:
string
&
{}
|
"PROJECT"
|
"GLOBAL"
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
permissionSchemes
:
{
createPermissionGrant
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
string
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
(...)
|
(...)
;
customId
?:
(...)
|
(...)
;
items
?:
(...)
|
(...)
;
system
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
{
avatarUrl
?:
...
;
name
?:
...
;
[
key
:
...
]:
...
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
schemeId
:
number
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
(...)
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createPermissionScheme
:
(
parameters
:
{
body
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
...
;
field
?:
...
;
group
?:
...
;
parameter
?:
...
;
projectRole
?:
...
;
type
?:
...
;
user
?:
...
;
[
key
:
...
]:
...
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deletePermissionScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deletePermissionSchemeEntity
:
(
parameters
:
{
permissionId
:
number
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemeGrant
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
permissionId
:
number
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
holder
?:
{
expand
?:
string
;
field
?:
{
clauseNames
?:
(...)
[]
;
custom
?:
boolean
;
id
?:
string
;
name
?:
string
;
navigable
?:
boolean
;
orderable
?:
boolean
;
schema
?:
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
;
searchable
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
group
?:
{
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
;
parameter
?:
string
;
projectRole
?:
{
actors
?:
(...)
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
type
?:
string
;
user
?:
{
active
?:
boolean
;
avatarUrls
?:
Record
<
(...)
,
(...)
>
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemeGrants
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPermissionSchemes
:
(
parameters
?:
{
expand
?:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
permissionSchemes
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
...
;
id
?:
...
;
permission
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSchemeAttribute
:
(
parameters
:
{
attributeKey
:
string
;
permissionSchemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
>
;
setSchemeAttribute
:
(
parameters
:
{
body
?:
string
;
key
:
string
;
permissionSchemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updatePermissionScheme
:
(
parameters
:
{
body
?:
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
...
;
field
?:
...
;
group
?:
...
;
parameter
?:
...
;
projectRole
?:
...
;
type
?:
...
;
user
?:
...
;
[
key
:
...
]:
...
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
expand
?:
string
|
string
[]
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
prioritySchemes
:
{
createPriorityScheme
:
(
parameters
:
{
defaultOptionId
?:
string
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deletePriorityScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPriorityScheme
:
(
parameters
:
{
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPrioritySchemes
:
(
parameters
?:
{
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
maxResults
?:
number
;
schemes
?:
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
updatePriorityScheme
:
(
parameters
:
{
defaultOptionId
?:
string
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
schemeId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectCategories
:
{
createProjectCategory
:
(
parameters
:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectCategories
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectCategoryById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeProjectCategory
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateProjectCategory
:
(
parameters
:
{
body
:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectComponents
:
{
createComponent
:
(
parameters
:
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteComponent
:
(
parameters
:
{
id
:
string
;
moveIssuesTo
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getComponent
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getComponentRelatedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
getPaginatedComponents
:
(
parameters
?:
{
maxResults
?:
string
;
projectIds
?:
string
;
query
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateComponent
:
(
parameters
:
{
body
?:
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectKeyAndNameValidation
:
{
validateProjectKey
:
(
parameters
?:
{
key
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectRoles
:
{
addProjectRoleActorsToRole
:
(
parameters
:
{
group
?:
string
[]
;
id
:
number
;
user
?:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
createProjectRole
:
(
parameters
:
{
description
?:
string
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteProjectRole
:
(
parameters
:
{
id
:
number
;
swap
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectRoleActorsFromRole
:
(
parameters
:
{
group
?:
string
;
id
:
number
;
user
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
fullyUpdateProjectRole
:
(
parameters
:
{
description
?:
string
;
id
:
number
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectRoles
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectRoleActorsForRole
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRolesById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
partialUpdateProjectRole
:
(
parameters
:
{
description
?:
string
;
id
:
number
;
name
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projects
:
{
addActorUsers
:
(
parameters
:
{
group
?:
string
[]
;
id
:
number
;
projectIdOrKey
:
string
;
user
?:
string
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
archiveProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
assignPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
id
?:
number
;
projectKeyOrId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
assignPriorityScheme
:
(
parameters
:
{
id
?:
number
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createProject
:
(
parameters
:
{
assigneeType
?:
string
&
{}
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
avatarId
?:
number
;
categoryId
?:
number
;
description
?:
string
;
issueSecurityScheme
?:
number
;
key
?:
string
;
lead
?:
string
;
name
?:
string
;
notificationScheme
?:
number
;
permissionScheme
?:
number
;
projectTemplateKey
?:
string
;
projectTypeKey
?:
string
;
url
?:
string
;
workflowSchemeId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
,
>
;
createProjectAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
projectIdOrKey
:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteActor
:
(
parameters
:
{
group
?:
string
;
id
:
number
;
projectIdOrKey
:
string
;
user
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectAvatar
:
(
parameters
:
{
id
:
number
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteProjectProperty
:
(
parameters
:
{
projectIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAccessibleProjectTypeByKey
:
(
parameters
:
{
projectTypeKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjectAvatars
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllProjects
:
(
parameters
?:
{
browseArchive
?:
boolean
;
expand
?:
string
;
includeArchived
?:
boolean
;
recent
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllProjectTypes
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllStatuses
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
self
?:
string
;
statuses
?:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
...
;
id
?:
...
;
key
?:
...
;
name
?:
...
;
self
?:
...
;
[
key
:
...
]:
...
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAssignedPermissionScheme
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
permissions
?:
{
holder
?:
{
expand
?:
(...)
|
(...)
;
field
?:
(...)
|
(...)
;
group
?:
(...)
|
(...)
;
parameter
?:
(...)
|
(...)
;
projectRole
?:
(...)
|
(...)
;
type
?:
(...)
|
(...)
;
user
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
number
;
permission
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAssignedPriorityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProject
:
(
parameters
:
{
expand
?:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectComponents
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
assigneeType
?:
|
string
&
{}
|
"PROJECT_DEFAULT"
|
"COMPONENT_LEAD"
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
deleted
?:
boolean
;
description
?:
string
;
id
?:
string
;
lead
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
pagingCallback
?:
(...)
|
(...)
;
size
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
leadUserName
?:
string
;
name
?:
string
;
project
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectIssueSecurityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultSecurityLevelId
?:
number
;
description
?:
string
;
id
?:
number
;
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectNotificationScheme
:
(
parameters
:
{
expand
?:
string
;
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
notificationSchemeEvents
?:
{
event
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
notifications
?:
{
id
?:
...
;
notificationType
?:
...
;
parameter
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectProperty
:
(
parameters
:
{
projectIdOrKey
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getProjectPropertyKeys
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRole
:
(
parameters
:
{
id
:
number
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectRoles
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
Record
<
string
,
string
>
>
;
getProjectTypeByKey
:
(
parameters
:
{
projectTypeKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
string
;
descriptionI18nKey
?:
string
;
formattedKey
?:
string
;
icon
?:
string
;
key
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectVersions
:
(
parameters
:
{
expand
?:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getProjectVersionsPaginated
:
(
parameters
:
{
expand
?:
string
;
maxResults
?:
number
;
orderBy
?:
string
;
projectIdOrKey
:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextPage
?:
string
;
self
?:
string
;
startAt
?:
number
;
total
?:
number
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSecurityLevelsForProject
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
levels
?:
{
description
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkflowSchemeForProject
:
(
parameters
:
{
projectKeyOrId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
restoreProject
:
(
parameters
:
{
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
searchForProjects
:
(
parameters
?:
{
allowEmptyQuery
?:
boolean
;
maxResults
?:
number
;
query
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
header
?:
string
;
projects
?:
{
avatar
?:
string
;
html
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
setActors
:
(
parameters
:
{
body
:
{
categorisedActors
?:
Record
<
string
,
string
[]
>
;
id
?:
number
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
projectIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actors
?:
{
avatarUrl
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setProjectProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
projectIdOrKey
:
string
;
propertyKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryProjectAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
projectIdOrKey
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
unassignPriorityScheme
:
(
parameters
:
{
projectKeyOrId
:
string
;
schemeId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultOptionId
?:
string
;
defaultScheme
?:
boolean
;
description
?:
string
;
id
?:
number
;
name
?:
string
;
optionIds
?:
string
[]
;
projectKeys
?:
string
[]
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateProject
:
(
parameters
:
{
assigneeType
?:
string
&
{}
|
"PROJECT_LEAD"
|
"UNASSIGNED"
;
avatarId
?:
number
;
categoryId
?:
number
;
description
?:
string
;
expand
?:
string
;
issueSecurityScheme
?:
number
;
key
?:
string
;
lead
?:
string
;
name
?:
string
;
notificationScheme
?:
number
;
permissionScheme
?:
number
;
projectIdOrKey
:
string
;
projectTemplateKey
?:
string
;
projectTypeKey
?:
string
;
url
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateProjectAvatar
:
(
parameters
:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
projectIdOrKey
:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateProjectType
:
(
parameters
:
{
newProjectTypeKey
:
string
;
projectIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
avatarUrls
?:
Record
<
string
,
string
>
;
description
?:
string
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
projectVersions
:
{
createOrUpdateRemoteVersionLink
:
(
parameters
:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
versionId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createOrUpdateRemoteVersionLinkByGlobalId
:
(
parameters
:
{
globalId
:
string
;
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
versionId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createVersion
:
(
parameters
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
unknown
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
unknown
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteRemoteVersionLink
:
(
parameters
:
{
globalId
:
string
;
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteVersionLinksByVersionId
:
(
parameters
:
{
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVersionAndSwap
:
(
parameters
:
{
customFieldReplacementList
?:
{
customFieldId
?:
number
;
moveTo
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
id
:
string
;
moveAffectedIssuesTo
?:
number
;
moveFixIssuesTo
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getPaginatedVersions
:
(
parameters
?:
{
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLink
:
(
parameters
:
{
globalId
:
string
;
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLinks
:
(
parameters
?:
{
globalId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getRemoteVersionLinksByVersionId
:
(
parameters
:
{
versionId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
links
?:
{
link
?:
unknown
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersion
:
(
parameters
:
{
expand
?:
string
;
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersionRelatedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
customFieldNames
?:
{
customFieldId
?:
number
;
fieldName
?:
string
;
issueCountWithVersionInCustomField
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
issueCountWithCustomFieldsShowingVersion
?:
number
;
issuesAffectedCount
?:
number
;
issuesFixedCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getVersionUnresolvedIssues
:
(
parameters
:
{
id
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issuesUnresolvedCount
?:
number
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
merge
:
(
parameters
:
{
id
:
string
;
moveIssuesTo
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveVersion
:
(
parameters
:
{
after
?:
string
;
id
:
string
;
position
?:
string
&
{}
|
"Earlier"
|
"Later"
|
"First"
|
"Last"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
Date
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
Date
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateVersion
:
(
parameters
:
{
body
:
{
archived
?:
boolean
;
description
?:
string
;
expand
?:
string
;
id
?:
string
;
moveUnfixedIssuesTo
?:
string
;
name
?:
string
;
overdue
?:
boolean
;
project
?:
string
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
unknown
;
releaseDateSet
?:
boolean
;
self
?:
string
;
startDate
?:
unknown
;
startDateSet
?:
boolean
;
userReleaseDate
?:
string
;
userStartDate
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
readOnlyMode
:
{
getReadOnlyMode
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
endTime
?:
string
;
message
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateReadOnlyMode
:
(
parameters
:
{
enabled
?:
boolean
;
endTime
?:
string
;
message
?:
string
;
timeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
screens
:
{
addField
:
(
parameters
:
{
fieldId
?:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
addFieldToDefaultScreen
:
(
parameters
:
{
fieldId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
addTab
:
(
parameters
:
{
id
?:
number
;
name
?:
string
;
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
>
;
deleteTab
:
(
parameters
:
{
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllFields
:
(
parameters
:
{
projectKey
?:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllScreens
:
(
parameters
?:
{
expand
?:
string
;
maxResults
?:
string
;
search
?:
string
;
startAt
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
expand
?:
string
;
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getAllTabs
:
(
parameters
:
{
projectKey
?:
string
;
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
[]
>
;
getFieldsToAdd
:
(
parameters
:
{
screenId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
string
;
name
?:
string
;
showWhenEmpty
?:
boolean
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
moveField
:
(
parameters
:
{
after
?:
string
;
id
:
string
;
position
?:
string
&
{}
|
"Earlier"
|
"Later"
|
"First"
|
"Last"
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveTab
:
(
parameters
:
{
pos
:
number
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeField
:
(
parameters
:
{
id
:
string
;
screenId
:
number
;
tabId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
renameTab
:
(
parameters
:
{
id
?:
number
;
name
?:
string
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
id
?:
number
;
name
?:
string
;
[
key
:
string
]:
unknown
}
>
;
updateShowWhenEmptyIndicator
:
(
parameters
:
{
id
:
string
;
newValue
:
boolean
;
screenId
:
number
;
tabId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
searchLimits
:
{
getMaxAggregationBuckets
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
>
;
getMaxResultWindow
:
(
options
?:
RequestOptions
)
=>
Promise
<
number
>
;
}
;
serverInfo
:
{
getServerInfo
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
baseUrl
:
string
;
buildDate
?:
string
;
buildNumber
?:
number
;
databaseBuildNumber
?:
number
;
deploymentType
:
string
;
scmInfo
?:
string
;
serverTime
?:
string
;
serverTitle
?:
string
;
version
:
string
;
versionNumbers
:
number
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
session
:
{
currentUser
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
items
?:
Record
<
string
,
any
>
[]
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
items
?:
Record
<
string
,
any
>
[]
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
login
:
(
parameters
:
{
password
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
loginInfo
?:
{
failedLoginCount
?:
number
;
lastFailedLoginTime
?:
Date
;
loginCount
?:
number
;
previousLoginTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
;
session
?:
{
name
?:
string
;
value
?:
string
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
>
;
logout
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
sprint
:
{
createSprint
:
(
parameters
:
{
autoStartStop
?:
boolean
;
endDate
?:
string
;
goal
?:
string
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
startDate
?:
string
;
synced
?:
boolean
;
userProfileTimeZone
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSprintProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssuesForSprint
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
string
|
string
[]
;
jql
?:
string
;
maxResults
?:
number
;
sprintId
:
number
;
startAt
?:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
|
null
;
issues
?:
{
changelog
?:
{
histories
?:
(...)
|
(...)
;
maxResults
?:
(...)
|
(...)
;
startAt
?:
(...)
|
(...)
;
total
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
included
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
id
?:
string
;
key
?:
string
;
names
?:
Record
<
string
,
string
>
;
operations
?:
{
linkGroups
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
properties
?:
{
properties
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
renderedFields
?:
Record
<
string
,
any
>
|
null
;
schema
?:
Record
<
string
,
{
custom
?:
...
;
customId
?:
...
;
items
?:
...
;
system
?:
...
;
type
?:
...
;
[
key
:
...
]:
...
;
}
,
>
;
self
?:
string
;
transitionBeans
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
transitions
?:
{
description
?:
...
;
fields
?:
...
;
id
?:
...
;
name
?:
...
;
opsbarSequence
?:
...
;
to
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
maxResults
?:
number
;
maxResultWindow
?:
number
;
names
?:
Record
<
string
,
string
>
|
null
;
schema
?:
|
Record
<
string
,
{
custom
?:
string
;
customId
?:
number
;
items
?:
string
;
system
?:
string
;
type
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
|
null
;
startAt
?:
number
;
total
?:
number
;
warningMessages
?:
string
[]
|
null
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getSprintProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getSprintPropertyKeys
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToSprint
:
(
parameters
:
{
issues
?:
string
[]
;
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateSprint
:
(
parameters
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
sprintId
:
number
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
setSprintProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
sprintId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
swapSprint
:
(
parameters
:
{
sprintId
:
number
;
sprintToSwapWith
?:
number
;
swap
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
unmapAllSprints
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
unmapSprints
:
(
parameters
:
{
sprintIds
?:
number
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateSprint
:
(
parameters
:
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
sprintId
:
number
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
activatedDate
?:
string
;
autoStartStop
?:
boolean
;
completeDate
?:
string
;
endDate
?:
string
;
goal
?:
string
;
id
?:
number
;
incompleteIssuesDestinationId
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
string
;
state
?:
string
;
synced
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
terminology
:
{
getAllTerminologyEntries
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
isDefault
?:
boolean
;
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
originalNamePlural
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getTerminologyEntry
:
(
parameters
:
{
originalName
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isDefault
?:
boolean
;
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
originalNamePlural
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setTerminologyEntries
:
(
parameters
:
{
newName
?:
string
;
newNamePlural
?:
string
;
originalName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
}
;
upgrade
:
{
getUpgradeResult
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
duration
?:
number
;
message
?:
string
;
outcome
?:
string
;
startTime
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
runUpgradesNow
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
}
;
users
:
{
addUserToApplication
:
(
parameters
:
{
applicationKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
changeUserPassword
:
(
parameters
:
{
currentPassword
?:
string
;
key
?:
string
;
password
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
createUser
:
(
parameters
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
createUserAvatarFromTemporary
:
(
parameters
:
{
cropperOffsetX
?:
number
;
cropperOffsetY
?:
number
;
cropperWidth
?:
number
;
needsCropping
?:
boolean
;
url
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
defaultColumns
:
(
parameters
?:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
[
key
:
string
]:
unknown
}
[]
>
;
deleteSession
:
(
parameters
:
{
username
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteUserAvatar
:
(
parameters
:
{
id
:
number
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteUserProperty
:
(
parameters
:
{
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
findAssignableUsers
:
(
parameters
?:
{
actionDescriptorId
?:
number
;
issueKey
?:
string
;
maxResults
?:
number
;
project
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findBulkAssignableUsers
:
(
parameters
?:
{
maxResults
?:
number
;
projectKeys
?:
string
|
string
[]
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsers
:
(
parameters
?:
{
includeActive
?:
boolean
;
includeInactive
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsersForPicker
:
(
parameters
?:
{
exclude
?:
string
[]
;
maxResults
?:
number
;
query
?:
string
;
showAvatar
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
header
?:
string
;
total
?:
number
;
users
?:
{
avatarUrl
?:
string
;
displayName
?:
string
;
html
?:
string
;
key
?:
string
;
name
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
findUsersWithBrowsePermission
:
(
parameters
?:
{
issueKey
?:
string
;
maxResults
?:
number
;
projectKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getA11yPersonalSettings
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
enabled
?:
boolean
;
key
?:
string
;
[
key
:
string
]:
unknown
}
[]
,
>
;
getAllUserAvatars
:
(
parameters
?:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
custom
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
system
?:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDuplicatedUsersCount
:
(
parameters
?:
{
flush
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDuplicatedUsersMapping
:
(
parameters
?:
{
flush
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUser
:
(
parameters
?:
{
includeDeleted
?:
boolean
;
key
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUserAnonymizationProgress
:
(
parameters
?:
{
taskId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getUserList
:
(
parameters
?:
{
cursor
?:
number
;
maxResults
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
nextCursor
?:
string
;
nextPage
?:
string
;
self
?:
string
;
values
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getUserProperty
:
(
parameters
:
{
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
?:
string
;
value
?:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getUserPropertyKeys
:
(
parameters
?:
{
userKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
removeUser
:
(
parameters
:
{
key
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
removeUserFromApplication
:
(
parameters
:
{
applicationKey
?:
string
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
resetUserColumns
:
(
parameters
:
{
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
scheduleUserAnonymization
:
(
parameters
:
{
newOwnerKey
?:
string
;
userKey
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
scheduleUserAnonymizationRerun
:
(
parameters
:
{
newOwnerKey
?:
string
;
oldUserKey
?:
string
;
oldUserName
?:
string
;
userKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setColumnsUrlEncoded
:
(
parameters
:
{
columns
?:
string
[]
;
username
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setUserProperty
:
(
parameters
:
{
body
:
Record
<
string
,
any
>
;
propertyKey
:
string
;
userKey
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
storeTemporaryUserAvatarUsingMultiPart
:
(
parameters
:
{
avatar
:
AttachmentInput
|
AttachmentInput
[]
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
unlockAnonymization
:
(
options
?:
RequestOptions
)
=>
Promise
<
void
>
;
updateUser
:
(
parameters
:
{
body
:
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
applicationKeys
?:
string
[]
;
displayName
?:
string
;
emailAddress
?:
string
;
key
?:
string
;
name
?:
string
;
notification
?:
string
;
password
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateUserAvatar
:
(
parameters
:
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
username
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fileName
?:
string
;
id
?:
string
;
isDeletable
?:
boolean
;
isSelected
?:
boolean
;
isSystemAvatar
?:
boolean
;
owner
?:
string
;
selected
?:
boolean
;
urls
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
validateUserAnonymization
:
(
parameters
?:
{
expand
?:
string
;
userKey
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedEntities
?:
Record
<
string
,
{
description
?:
string
;
numberOfOccurrences
?:
number
;
type
?:
|
(...)
&
(...)
|
"REMOVE"
|
"ANONYMIZE"
|
"TRANSFER_OWNERSHIP"
|
"MANUAL"
;
uri
?:
string
;
uriDisplayName
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
businessLogicValidationFailed
?:
boolean
;
deleted
?:
boolean
;
displayName
?:
string
;
email
?:
string
;
errors
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
expand
?:
string
;
operations
?:
string
[]
;
success
?:
boolean
;
userKey
?:
string
;
userName
?:
string
;
warnings
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
validateUserAnonymizationRerun
:
(
parameters
?:
{
expand
?:
string
;
oldUserKey
?:
string
;
oldUserName
?:
string
;
userKey
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedEntities
?:
Record
<
string
,
{
description
?:
string
;
numberOfOccurrences
?:
number
;
type
?:
|
(...)
&
(...)
|
"REMOVE"
|
"ANONYMIZE"
|
"TRANSFER_OWNERSHIP"
|
"MANUAL"
;
uri
?:
string
;
uriDisplayName
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
businessLogicValidationFailed
?:
boolean
;
deleted
?:
boolean
;
displayName
?:
string
;
email
?:
string
;
errors
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
expand
?:
string
;
operations
?:
string
[]
;
success
?:
boolean
;
userKey
?:
string
;
userName
?:
string
;
warnings
?:
Record
<
string
,
{
errorMessages
?:
string
[]
;
errors
?:
Record
<
string
,
string
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
webhooks
:
{
createWebhook
:
(
parameters
:
{
configuration
?:
Record
<
string
,
any
>
;
events
?:
string
[]
;
excludeBody
?:
boolean
;
filters
?:
Record
<
string
,
any
>
;
name
:
string
;
sslVerificationRequired
?:
boolean
;
url
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteWebhook
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getLatestWebhookInvocation
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
getWebhook
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWebhooks
:
(
parameters
?:
{
event
?:
string
;
limit
?:
number
;
start
?:
number
;
statistics
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
(...)
|
(...)
;
failures
?:
(...)
|
(...)
;
successes
?:
(...)
|
(...)
;
window
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getWebhookStatistics
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
number
;
start
?:
number
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWebhookStatisticsSummary
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
Record
<
string
,
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
(...)
|
(...)
;
start
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
,
>
,
>
;
getWebhookTransitions
:
(
parameters
:
{
webhookId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
unknown
>
;
updateWebhook
:
(
parameters
:
{
configuration
?:
Record
<
string
,
any
>
;
events
?:
string
[]
;
excludeBody
?:
boolean
;
filters
?:
Record
<
string
,
any
>
;
name
:
string
;
sslVerificationRequired
?:
boolean
;
url
:
string
;
webhookId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
active
?:
boolean
;
configuration
?:
Record
<
string
,
any
>
;
createdDate
?:
number
;
events
?:
string
[]
;
id
:
number
;
name
:
string
;
scopeType
?:
string
;
sslVerificationRequired
?:
boolean
;
statistics
?:
{
counts
?:
{
errors
?:
number
;
failures
?:
number
;
successes
?:
number
;
window
?:
{
duration
?:
...
;
start
?:
...
;
[
key
:
...
]:
...
}
;
[
key
:
string
]:
unknown
;
}
;
lastError
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
;
updatedDate
?:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
websudo
:
{
release
:
(
parameters
:
{
body
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
workflows
:
{
getAllWorkflows
:
(
parameters
?:
{
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
default
?:
boolean
;
description
?:
string
;
isDefault
?:
boolean
;
lastModifiedDate
?:
string
;
lastModifiedUser
?:
string
;
name
?:
string
;
steps
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
workflowSchemes
:
{
createDraftForParent
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
createScheme
:
(
parameters
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
string
]:
unknown
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
string
]:
unknown
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteDraftDefault
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteDraftWorkflowMapping
:
(
parameters
:
{
id
:
number
;
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteScheme
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorkflowMapping
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteWorkflowSchemeIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
;
updateDraftIfNeeded
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getById
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDefault
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftById
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftDefault
:
(
parameters
:
{
id
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDraftWorkflow
:
(
parameters
:
{
id
:
number
;
workflowName
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkflow
:
(
parameters
:
{
id
:
number
;
returnDraftIfExists
?:
boolean
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
|
{
defaultMapping
?:
boolean
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
|
{
defaultMapping
?:
boolean
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getWorkflowSchemeIssueType
:
(
parameters
:
{
id
:
number
;
issueType
:
string
;
returnDraftIfExists
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
setDraftIssueType
:
(
parameters
:
{
body
:
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
issueType
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
setIssueType
:
(
parameters
:
{
body
:
{
issueType
?:
string
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
issueType
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraft
:
(
parameters
:
{
body
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraftDefault
:
(
parameters
:
{
id
:
number
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateDraftWorkflowMapping
:
(
parameters
:
{
defaultMapping
?:
boolean
;
id
:
number
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateWorkflowMapping
:
(
parameters
:
{
defaultMapping
?:
boolean
;
id
:
number
;
issueTypes
?:
string
[]
;
updateDraftIfNeeded
?:
boolean
;
workflow
?:
string
;
workflowName
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
updateWorkflowScheme
:
(
parameters
:
{
body
:
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
;
id
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
defaultWorkflow
?:
string
;
description
?:
string
;
draft
?:
boolean
;
id
?:
number
;
issueTypeMappings
?:
Record
<
string
,
string
>
;
issueTypes
?:
Record
<
string
,
{
avatarId
?:
number
;
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
subtask
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
lastModified
?:
string
;
lastModifiedUser
?:
{
active
?:
boolean
;
applicationRoles
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
avatarUrls
?:
Record
<
string
,
string
>
;
deleted
?:
boolean
;
displayName
?:
string
;
emailAddress
?:
string
;
expand
?:
string
;
groups
?:
{
callback
?:
{
[
key
:
...
]:
...
}
;
maxResults
?:
number
;
pagingCallback
?:
{
[
key
:
...
]:
...
}
;
size
?:
number
;
[
key
:
string
]:
unknown
;
}
;
key
?:
string
;
lastLoginTime
?:
string
;
locale
?:
string
;
name
?:
string
;
self
?:
string
;
timeZone
?:
string
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
originalDefaultWorkflow
?:
string
;
originalIssueTypeMappings
?:
Record
<
string
,
string
>
;
self
?:
string
;
updateDraftIfNeeded
?:
boolean
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
workflowStatusCategories
:
{
getStatusCategories
:
(
parameters
?:
{
request
?:
string
;
uriInfo
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
getStatusCategory
:
(
parameters
:
{
idOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
workflowStatuses
:
{
getPaginatedStatuses
:
(
parameters
?:
{
issueTypeIds
?:
string
[]
;
maxResults
?:
number
;
projectIds
?:
number
[]
;
query
?:
string
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
?:
number
;
values
:
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getStatus
:
(
parameters
:
{
idOrName
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getStatuses
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
description
?:
string
;
iconUrl
?:
string
;
id
?:
string
;
name
?:
string
;
self
?:
string
;
statusCategory
?:
{
colorName
?:
string
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
;
statusColor
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
,
>
;
}
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Guide
GitHub
jira.js
Loading...