jira.js
Guide
GitHub
Preparing search index...
agile
createAgileClient
Function createAgileClient
createAgileClient
(
clientConfig
:
ClientConfig
|
Client
,
)
:
{
backlog
:
{
moveIssuesToBacklog
:
(
parameters
:
{
issues
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveIssuesToBacklogForBoard
:
(
parameters
:
{
boardId
:
number
;
issues
:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
board
:
{
createBoard
:
(
parameters
:
{
filterId
?:
number
;
location
?:
{
projectKeyOrId
?:
string
;
type
?:
"user"
|
string
&
{}
|
"project"
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
type
?:
string
&
{}
|
"scrum"
|
"kanban"
|
"agility"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
admins
?:
{
groups
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
users
?:
{
accountId
?:
(...)
|
(...)
;
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllBoards
:
(
parameters
?:
{
accountIdLocation
?:
string
;
expand
?:
|
string
|
string
[]
|
string
&
{}
|
(
string
&
{}
|
"permissions"
|
"admins"
)
[]
;
filterId
?:
number
;
includePrivate
?:
boolean
;
maxResults
?:
number
;
name
?:
string
;
negateLocationFiltering
?:
boolean
;
orderBy
?:
"name"
|
string
&
{}
|
"-name"
|
"+name"
;
projectKeyOrId
?:
string
;
projectLocation
?:
string
;
projectTypeLocation
?:
string
[]
;
startAt
?:
number
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
admins
?:
{
groups
?:
(...)
[]
;
users
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllQuickFilters
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
boardId
?:
number
;
description
?:
string
;
id
?:
number
;
jql
?:
string
;
name
?:
string
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllSprints
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
state
?:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
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
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getApproximateIssueCountForBacklog
:
(
parameters
:
{
boardId
:
number
;
jql
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
count
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getApproximateIssueCountForBoard
:
(
parameters
:
{
boardId
:
number
;
jql
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
count
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
admins
?:
{
groups
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
users
?:
{
accountId
?:
(...)
|
(...)
;
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardByFilterId
:
(
parameters
:
{
filterId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardIssuesForEpic
:
(
parameters
:
{
boardId
:
number
;
epicId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardIssuesForSprint
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
sprintId
:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
:
string
;
value
:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getBoardPropertyKeys
:
(
parameters
:
{
boardId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getConfiguration
:
(
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
;
location
?:
{
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectKeyOrId
?:
string
;
self
?:
string
;
type
?:
"user"
|
string
&
{}
|
"project"
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
ranking
?:
{
rankCustomFieldId
?:
number
;
[
key
:
string
]:
unknown
}
;
self
?:
string
;
subQuery
?:
{
query
?:
string
;
[
key
:
string
]:
unknown
}
;
type
?:
string
;
[
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
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFeaturesForBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
features
?:
{
boardFeature
?:
|
string
&
{}
|
"ESTIMATION"
|
"SPRINTS"
|
"SIMPLE_ROADMAP"
|
"BACKLOG"
|
"CALENDAR"
|
"DEVTOOLS"
|
"REPORTS"
|
"PAGES"
|
"CODE"
|
"SECURITY"
|
"REQUESTS"
|
"INCIDENTS"
|
"RELEASES"
|
"DEPLOYMENTS"
|
"ISSUE_NAVIGATOR"
|
"ON_CALL_SCHEDULE"
|
"BOARD"
|
"GOALS"
|
"LIST_VIEW"
;
boardId
?:
number
;
featureId
?:
string
;
featureType
?:
string
&
{}
|
"ESTIMATION"
|
"BASIC"
;
imageUri
?:
string
;
learnMoreArticleId
?:
string
;
learnMoreLink
?:
string
;
localisedDescription
?:
string
;
localisedGroup
?:
string
;
localisedName
?:
string
;
permissibleEstimationTypes
?:
{
localisedDescription
?:
...
;
localisedName
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
state
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
"COMING_SOON"
;
toggleLocked
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBacklog
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpicForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjects
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
avatarUrls
?:
{
"16x16"
?:
(...)
|
(...)
;
"24x24"
?:
(...)
|
(...)
;
"32x32"
?:
(...)
|
(...)
;
"48x48"
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
|
string
&
{}
|
"software"
|
"service_desk"
|
"business"
|
"product_discovery"
|
"customer_service"
;
self
?:
string
;
simplified
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectsFull
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
avatarUrls
?:
{
"16x16"
?:
(...)
|
(...)
;
"24x24"
?:
(...)
|
(...)
;
"32x32"
?:
(...)
|
(...)
;
"48x48"
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
|
string
&
{}
|
"software"
|
"service_desk"
|
"business"
|
"product_discovery"
|
"customer_service"
;
self
?:
string
;
simplified
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getQuickFilter
:
(
parameters
:
{
boardId
:
number
;
quickFilterId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
boardId
?:
number
;
description
?:
string
;
id
?:
number
;
jql
?:
string
;
name
?:
string
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReportsForBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
reports
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
}
>
;
moveIssuesToBoard
:
(
parameters
:
{
boardId
:
number
;
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
;
propertyValue
:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
toggleFeatures
:
(
parameters
:
{
boardId
:
number
;
body
:
{
boardId
?:
number
;
enabling
?:
boolean
;
feature
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
features
?:
{
boardFeature
?:
|
string
&
{}
|
"ESTIMATION"
|
"SPRINTS"
|
"SIMPLE_ROADMAP"
|
"BACKLOG"
|
"CALENDAR"
|
"DEVTOOLS"
|
"REPORTS"
|
"PAGES"
|
"CODE"
|
"SECURITY"
|
"REQUESTS"
|
"INCIDENTS"
|
"RELEASES"
|
"DEPLOYMENTS"
|
"ISSUE_NAVIGATOR"
|
"ON_CALL_SCHEDULE"
|
"BOARD"
|
"GOALS"
|
"LIST_VIEW"
;
boardId
?:
number
;
featureId
?:
string
;
featureType
?:
string
&
{}
|
"ESTIMATION"
|
"BASIC"
;
imageUri
?:
string
;
learnMoreArticleId
?:
string
;
learnMoreLink
?:
string
;
localisedDescription
?:
string
;
localisedGroup
?:
string
;
localisedName
?:
string
;
permissibleEstimationTypes
?:
{
localisedDescription
?:
...
;
localisedName
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
state
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
"COMING_SOON"
;
toggleLocked
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
builds
:
{
deleteBuildByKey
:
(
parameters
:
{
buildNumber
:
number
;
pipelineId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBuildsByProperty
:
(
parameters
:
{
accountId
:
string
;
repoId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getBuildByKey
:
(
parameters
:
{
buildNumber
:
number
;
pipelineId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
buildNumber
:
number
;
description
?:
string
;
displayName
:
string
;
label
?:
string
;
lastUpdated
:
Date
;
pipelineId
:
string
;
references
?:
{
commit
?:
{
id
:
string
;
repositoryUri
:
string
;
[
key
:
string
]:
unknown
;
}
;
ref
?:
{
name
:
string
;
uri
:
string
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
;
testInfo
?:
{
numberFailed
:
number
;
numberPassed
:
number
;
numberSkipped
?:
number
;
totalNumber
:
number
;
[
key
:
string
]:
unknown
;
}
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitBuilds
:
(
parameters
:
{
builds
:
{
associations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
buildNumber
:
number
;
description
?:
string
;
displayName
:
string
;
label
?:
string
;
lastUpdated
:
string
|
Date
;
pipelineId
:
string
;
references
?:
{
commit
?:
{
id
:
...
;
repositoryUri
:
...
}
;
ref
?:
{
name
:
...
;
uri
:
...
}
;
}
[]
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
;
testInfo
?:
{
numberFailed
:
number
;
numberPassed
:
number
;
numberSkipped
?:
number
;
totalNumber
:
number
;
}
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedBuilds
?:
{
buildNumber
:
number
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
rejectedBuilds
?:
{
errors
:
{
errorTraceId
?:
(...)
|
(...)
;
message
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
key
:
{
buildNumber
:
number
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
deployments
:
{
deleteDeploymentByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteDeploymentsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getDeploymentByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"commit"
|
"repository"
;
values
:
((...)
|
(...))
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
commands
?:
{
command
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
deploymentSequenceNumber
:
number
;
description
:
string
;
displayName
:
string
;
duration
?:
number
;
environment
:
{
displayName
:
string
;
id
:
string
;
type
:
|
"unmapped"
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
[
key
:
string
]:
unknown
;
}
;
label
?:
string
;
lastUpdated
:
Date
;
pipeline
:
{
displayName
:
string
;
id
:
string
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
|
"rolled_back"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDeploymentGatingStatusByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
deploymentSequenceNumber
?:
number
;
details
?:
{
issueKey
:
string
;
issueLink
:
string
;
type
:
string
&
{}
|
"issue"
;
[
key
:
string
]:
unknown
;
}
[]
;
environmentId
?:
string
;
gatingStatus
?:
|
"invalid"
|
string
&
{}
|
"allowed"
|
"prevented"
|
"awaiting"
;
pipelineId
?:
string
;
updatedTimestamp
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitDeployments
:
(
parameters
:
{
deployments
:
{
associations
?:
(
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
commands
?:
{
command
?:
string
}
[]
;
deploymentSequenceNumber
:
number
;
description
:
string
;
displayName
:
string
;
duration
?:
number
;
environment
:
{
displayName
:
string
;
id
:
string
;
type
:
|
"unmapped"
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
}
;
label
?:
string
;
lastUpdated
:
string
|
Date
;
pipeline
:
{
displayName
:
string
;
id
:
string
;
url
:
string
}
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
|
"rolled_back"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedDeployments
?:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
rejectedDeployments
?:
{
errors
:
{
errorTraceId
?:
(...)
|
(...)
;
message
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
key
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownAssociations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"commit"
|
"repository"
;
values
:
((...)
|
(...))
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
developmentInformation
:
{
deleteByProperties
:
(
parameters
:
{
updateSequenceId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteEntity
:
(
parameters
:
{
entityId
:
string
;
entityType
:
string
&
{}
|
"commit"
|
"branch"
|
"pull_request"
;
repositoryId
:
string
;
updateSequenceId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRepository
:
(
parameters
:
{
repositoryId
:
string
;
updateSequenceId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
existsByProperties
:
(
parameters
?:
{
updateSequenceId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
hasDataMatchingProperties
?:
boolean
;
[
key
:
string
]:
unknown
}
,
>
;
getRepository
:
(
parameters
:
{
repositoryId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatar
?:
string
;
avatarDescription
?:
string
;
branches
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
createPullRequestUrl
?:
string
;
id
:
string
;
lastCommit
:
{
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
[]
;
flags
?:
(...)
[]
;
id
:
string
;
issueKeys
:
string
[]
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
;
name
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
commits
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
author
:
{
avatar
?:
string
;
email
?:
string
;
name
?:
string
;
url
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
{
changeType
:
...
;
linesAdded
:
...
;
linesRemoved
:
...
;
path
:
...
;
url
:
...
;
[
key
:
...
]:
...
;
}
[]
;
flags
?:
((...)
|
(...))
[]
;
id
:
string
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
forkOf
?:
string
;
id
:
string
;
name
:
string
;
pullRequests
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
author
:
{
avatar
?:
string
;
email
?:
string
;
name
?:
string
;
url
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
commentCount
:
number
;
destinationBranch
?:
string
;
destinationBranchUrl
?:
string
;
displayId
:
string
;
id
:
string
;
lastUpdate
:
string
;
reviewers
?:
{
accountId
?:
...
;
approvalStatus
?:
...
;
avatar
?:
...
;
email
?:
...
;
name
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
sourceBranch
:
string
;
sourceBranchUrl
?:
string
;
status
:
string
&
{}
|
"OPEN"
|
"UNKNOWN"
|
"MERGED"
|
"DECLINED"
;
title
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
storeDevelopmentInformation
:
(
parameters
:
{
operationType
?:
string
&
{}
|
"NORMAL"
|
"BACKFILL"
;
preventTransitions
?:
boolean
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
repositories
:
{
avatar
?:
string
;
avatarDescription
?:
string
;
branches
?:
{
associations
?:
(...)
[]
;
createPullRequestUrl
?:
string
;
id
:
string
;
lastCommit
:
{
author
:
{
avatar
?:
...
;
email
?:
...
;
name
?:
...
;
url
?:
...
;
username
?:
...
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
|
(...)
;
flags
?:
(...)
|
(...)
;
id
:
string
;
issueKeys
:
(...)
[]
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
;
name
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
commits
?:
{
associations
?:
(...)
[]
;
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
[]
;
flags
?:
(...)
[]
;
id
:
string
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
description
?:
string
;
forkOf
?:
string
;
id
:
string
;
name
:
string
;
pullRequests
?:
{
associations
?:
(...)
[]
;
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
}
;
commentCount
:
number
;
destinationBranch
?:
string
;
destinationBranchUrl
?:
string
;
displayId
:
string
;
id
:
string
;
lastUpdate
:
string
;
reviewers
?:
(...)
[]
;
sourceBranch
:
string
;
sourceBranchUrl
?:
string
;
status
:
(...)
&
(...)
|
"OPEN"
|
"UNKNOWN"
|
"MERGED"
|
"DECLINED"
;
title
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedDevinfoEntities
?:
Record
<
string
,
any
>
;
failedDevinfoEntities
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
devopsComponents
:
{
deleteComponentById
:
(
parameters
:
{
componentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteComponentsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getComponentById
:
(
parameters
:
{
componentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarUrl
:
string
;
componentType
:
|
string
&
{}
|
"Service"
|
"Application"
|
"Library"
|
"Capability"
|
"Cloud resource"
|
"Data pipeline"
|
"Machine learning model"
|
"UI element"
|
"Website"
|
"Other"
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
name
:
string
;
providerName
?:
string
;
schemaVersion
:
string
&
{}
|
"1.0"
;
tier
:
string
&
{}
|
"Tier 1"
|
"Tier 2"
|
"Tier 3"
|
"Tier 4"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitComponents
:
(
parameters
:
{
devopsComponents
:
{
avatarUrl
:
string
;
componentType
:
|
string
&
{}
|
"Service"
|
"Application"
|
"Library"
|
"Capability"
|
"Cloud resource"
|
"Data pipeline"
|
"Machine learning model"
|
"UI element"
|
"Website"
|
"Other"
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
name
:
string
;
providerName
?:
string
;
schemaVersion
:
string
&
{}
|
"1.0"
;
tier
:
string
&
{}
|
"Tier 1"
|
"Tier 2"
|
"Tier 3"
|
"Tier 4"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedComponents
?:
string
[]
;
failedComponents
?:
Record
<
string
,
any
>
;
unknownProjectKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
epic
:
{
getEpic
:
(
parameters
:
{
epicIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
string
;
[
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
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpic
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
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
;
[
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
>
;
}
;
featureFlags
:
{
deleteFeatureFlagById
:
(
parameters
:
{
featureFlagId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteFeatureFlagsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getFeatureFlagById
:
(
parameters
:
{
featureFlagId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
details
:
{
environment
:
{
name
:
string
;
type
?:
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
[
key
:
string
]:
unknown
;
}
;
lastUpdated
:
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
(...)
|
(...)
;
rules
?:
(...)
|
(...)
;
text
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
displayName
?:
string
;
id
:
string
;
key
:
string
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
summary
:
{
lastUpdated
:
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
number
;
rules
?:
number
;
text
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updateSequenceId
:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitFeatureFlags
:
(
parameters
:
{
flags
:
{
associations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
details
:
{
environment
:
{
name
:
string
;
type
?:
|
(...)
&
(...)
|
"development"
|
"testing"
|
"staging"
|
"production"
;
}
;
lastUpdated
:
string
|
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
...
;
rules
?:
...
;
text
?:
...
}
;
}
;
url
:
string
;
}
[]
;
displayName
?:
string
;
id
:
string
;
key
:
string
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
summary
:
{
lastUpdated
:
string
|
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
(...)
|
(...)
;
rules
?:
(...)
|
(...)
;
text
?:
(...)
|
(...)
;
}
;
}
;
url
?:
string
;
}
;
updateSequenceId
:
number
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedFeatureFlags
?:
string
[]
;
failedFeatureFlags
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issue
:
{
estimateIssueForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
;
value
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getIssue
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
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
,
any
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
string
[]
;
excluded
?:
string
[]
;
included
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
hasScreen
?:
boolean
;
id
?:
string
;
isAvailable
?:
boolean
;
isConditional
?:
boolean
;
isGlobal
?:
boolean
;
isInitial
?:
boolean
;
looped
?:
boolean
;
name
?:
string
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
scope
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
[
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
?:
number
;
[
key
:
string
]:
unknown
}
>
;
rankIssues
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
operations
:
{
deleteEntityByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIncidentById
:
(
parameters
:
{
incidentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteReviewById
:
(
parameters
:
{
reviewId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIncidentById
:
(
parameters
:
{
incidentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedComponents
:
string
[]
;
associations
?:
{
associationType
?:
|
string
&
{}
|
"issueIdOrKeys"
|
"serviceIdOrKeys"
|
"ati:cloud:compass:event-source"
;
values
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
createdDate
:
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
?:
{
level
:
"unknown"
|
string
&
{}
|
"P1"
|
"P2"
|
"P3"
|
"P4"
|
"P5"
;
[
key
:
string
]:
unknown
;
}
;
status
:
"unknown"
|
"open"
|
string
&
{}
|
"resolved"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReviewById
:
(
parameters
:
{
reviewId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
?:
|
string
&
{}
|
"issueIdOrKeys"
|
"serviceIdOrKeys"
|
"ati:cloud:compass:event-source"
;
values
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
createdDate
:
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
reviews
:
string
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
status
:
|
"unknown"
|
"completed"
|
string
&
{}
|
"in progress"
|
"outstanding actions"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkspaces
:
(
parameters
?:
{
workspaceId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
workspaceIds
:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
submitEntity
:
(
parameters
:
{
body
:
|
{
incidents
?:
{
affectedComponents
:
string
[]
;
associations
?:
(...)
[]
;
createdDate
:
string
|
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
schemaVersion
:
(...)
&
(...)
|
"1.0"
;
severity
?:
{
level
:
...
}
;
status
:
"unknown"
|
"open"
|
(...)
&
(...)
|
"resolved"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
|
{
reviews
?:
{
associations
?:
(...)
[]
;
createdDate
:
string
|
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
reviews
:
string
[]
;
schemaVersion
:
(...)
&
(...)
|
"1.0"
;
status
:
|
"unknown"
|
"completed"
|
(...)
&
(...)
|
"in progress"
|
"outstanding actions"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedIncidents
?:
string
[]
;
failedIncidents
?:
Record
<
string
,
any
>
;
unknownProjectKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitOperationsWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedWorkspaceIds
?:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
}
;
remoteLinks
:
{
deleteRemoteLinkById
:
(
parameters
:
{
remoteLinkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteLinksByProperty
:
(
parameters
:
{
params
?:
Record
<
string
,
any
>
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getRemoteLinkById
:
(
parameters
:
{
remoteLinkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actionIds
?:
string
[]
;
associations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
attributeMap
?:
Record
<
string
,
any
>
;
description
?:
string
;
displayName
:
string
;
id
:
string
;
lastUpdated
:
Date
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
status
?:
{
appearance
:
|
"default"
|
"new"
|
"removed"
|
"success"
|
string
&
{}
|
"prototype"
|
"inprogress"
|
"moved"
;
label
:
string
;
[
key
:
string
]:
unknown
;
}
;
type
:
|
"other"
|
"document"
|
"alert"
|
string
&
{}
|
"test"
|
"security"
|
"logFile"
|
"prototype"
|
"coverage"
|
"bugReport"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitRemoteLinks
:
(
parameters
:
{
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
remoteLinks
:
{
actionIds
?:
string
[]
;
associations
?:
(
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
attributeMap
?:
Record
<
string
,
any
>
;
description
?:
string
;
displayName
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
status
?:
{
appearance
:
|
"default"
|
"new"
|
"removed"
|
"success"
|
string
&
{}
|
"prototype"
|
"inprogress"
|
"moved"
;
label
:
string
;
}
;
type
:
|
"other"
|
"document"
|
"alert"
|
string
&
{}
|
"test"
|
"security"
|
"logFile"
|
"prototype"
|
"coverage"
|
"bugReport"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedRemoteLinks
?:
string
[]
;
rejectedRemoteLinks
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
securityInformation
:
{
deleteLinkedWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVulnerabilitiesByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVulnerabilityById
:
(
parameters
:
{
vulnerabilityId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getLinkedWorkspaceById
:
(
parameters
:
{
workspaceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
updatedAt
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
}
,
>
;
getLinkedWorkspaces
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
workspaceIds
:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
getVulnerabilityById
:
(
parameters
:
{
vulnerabilityId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
addAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
additionalInfo
?:
{
content
:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
associationsLastUpdated
?:
Date
;
associationsUpdateSequenceNumber
?:
number
;
containerId
:
string
;
description
:
string
;
displayName
:
string
;
id
:
string
;
identifiers
?:
{
displayName
:
string
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
introducedDate
:
Date
;
lastUpdated
:
Date
;
removeAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
:
{
level
:
|
"high"
|
"low"
|
"medium"
|
"unknown"
|
string
&
{}
|
"critical"
;
[
key
:
string
]:
unknown
;
}
;
status
:
"unknown"
|
"closed"
|
"open"
|
string
&
{}
|
"ignored"
;
type
:
"unknown"
|
string
&
{}
|
"sca"
|
"sast"
|
"dast"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitVulnerabilities
:
(
parameters
:
{
operationType
?:
string
&
{}
|
"NORMAL"
|
"BACKFILL"
|
"SCAN"
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
vulnerabilities
:
{
addAssociations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
additionalInfo
?:
{
content
:
string
;
url
?:
string
}
;
associationsLastUpdated
?:
string
|
Date
;
associationsUpdateSequenceNumber
?:
number
;
containerId
:
string
;
description
:
string
;
displayName
:
string
;
id
:
string
;
identifiers
?:
{
displayName
:
string
;
url
:
string
}
[]
;
introducedDate
:
string
|
Date
;
lastUpdated
:
string
|
Date
;
removeAssociations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
:
{
level
:
|
"high"
|
"low"
|
"medium"
|
"unknown"
|
string
&
{}
|
"critical"
;
}
;
status
:
"unknown"
|
"closed"
|
"open"
|
string
&
{}
|
"ignored"
;
type
:
"unknown"
|
string
&
{}
|
"sca"
|
"sast"
|
"dast"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedVulnerabilities
?:
string
[]
;
failedVulnerabilities
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
sprint
:
{
createSprint
:
(
parameters
:
{
endDate
?:
string
|
Date
;
goal
?:
string
;
name
:
string
;
originBoardId
?:
number
;
startDate
?:
string
|
Date
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssuesForSprint
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
sprintId
:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPropertiesKeys
:
(
parameters
:
{
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
:
string
;
value
:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToSprintAndRank
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
sprintId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateSprint
:
(
parameters
:
{
completeDate
?:
string
|
Date
;
createdDate
?:
string
|
Date
;
endDate
?:
string
|
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
sprintId
:
number
;
startDate
?:
string
|
Date
;
state
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
setProperty
:
(
parameters
:
{
propertyKey
:
string
;
propertyValue
:
Record
<
string
,
any
>
;
sprintId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
swapSprint
:
(
parameters
:
{
sprintId
:
number
;
sprintToSwapWith
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateSprint
:
(
parameters
:
{
completeDate
?:
string
|
Date
;
createdDate
?:
string
|
Date
;
endDate
?:
string
|
Date
;
goal
?:
string
;
id
?:
number
;
name
:
string
;
originBoardId
?:
number
;
sprintId
:
number
;
startDate
?:
string
|
Date
;
state
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
}
Parameters
clientConfig
:
ClientConfig
|
Client
Returns
{
backlog
:
{
moveIssuesToBacklog
:
(
parameters
:
{
issues
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
moveIssuesToBacklogForBoard
:
(
parameters
:
{
boardId
:
number
;
issues
:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
board
:
{
createBoard
:
(
parameters
:
{
filterId
?:
number
;
location
?:
{
projectKeyOrId
?:
string
;
type
?:
"user"
|
string
&
{}
|
"project"
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
type
?:
string
&
{}
|
"scrum"
|
"kanban"
|
"agility"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
admins
?:
{
groups
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
users
?:
{
accountId
?:
(...)
|
(...)
;
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getAllBoards
:
(
parameters
?:
{
accountIdLocation
?:
string
;
expand
?:
|
string
|
string
[]
|
string
&
{}
|
(
string
&
{}
|
"permissions"
|
"admins"
)
[]
;
filterId
?:
number
;
includePrivate
?:
boolean
;
maxResults
?:
number
;
name
?:
string
;
negateLocationFiltering
?:
boolean
;
orderBy
?:
"name"
|
string
&
{}
|
"-name"
|
"+name"
;
projectKeyOrId
?:
string
;
projectLocation
?:
string
;
projectTypeLocation
?:
string
[]
;
startAt
?:
number
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
admins
?:
{
groups
?:
(...)
[]
;
users
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllQuickFilters
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
boardId
?:
number
;
description
?:
string
;
id
?:
number
;
jql
?:
string
;
name
?:
string
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getAllSprints
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
state
?:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
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
;
projectId
?:
number
;
released
?:
boolean
;
releaseDate
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getApproximateIssueCountForBacklog
:
(
parameters
:
{
boardId
:
number
;
jql
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
count
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getApproximateIssueCountForBoard
:
(
parameters
:
{
boardId
:
number
;
jql
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
count
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
admins
?:
{
groups
?:
{
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
users
?:
{
accountId
?:
(...)
|
(...)
;
active
?:
(...)
|
(...)
|
(...)
;
avatarUrls
?:
(...)
|
(...)
;
displayName
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
;
canEdit
?:
boolean
;
favourite
?:
boolean
;
id
?:
number
;
isPrivate
?:
boolean
;
location
?:
{
avatarURI
?:
string
;
displayName
?:
string
;
name
?:
string
;
projectId
?:
number
;
projectKey
?:
string
;
projectName
?:
string
;
projectTypeKey
?:
string
;
userAccountId
?:
string
;
userId
?:
number
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
self
?:
string
;
type
?:
string
&
{}
|
"simple"
|
"scrum"
|
"kanban"
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardByFilterId
:
(
parameters
:
{
filterId
:
number
;
maxResults
?:
number
;
startAt
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
:
boolean
;
maxResults
:
number
;
startAt
:
number
;
total
:
number
;
values
:
{
id
?:
number
;
name
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardIssuesForEpic
:
(
parameters
:
{
boardId
:
number
;
epicId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardIssuesForSprint
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
sprintId
:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
:
string
;
value
:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getBoardPropertyKeys
:
(
parameters
:
{
boardId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getConfiguration
:
(
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
;
location
?:
{
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectKeyOrId
?:
string
;
self
?:
string
;
type
?:
"user"
|
string
&
{}
|
"project"
;
[
key
:
string
]:
unknown
;
}
;
name
?:
string
;
ranking
?:
{
rankCustomFieldId
?:
number
;
[
key
:
string
]:
unknown
}
;
self
?:
string
;
subQuery
?:
{
query
?:
string
;
[
key
:
string
]:
unknown
}
;
type
?:
string
;
[
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
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
}
;
done
?:
boolean
;
id
?:
number
;
key
?:
string
;
name
?:
string
;
self
?:
string
;
summary
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getFeaturesForBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
features
?:
{
boardFeature
?:
|
string
&
{}
|
"ESTIMATION"
|
"SPRINTS"
|
"SIMPLE_ROADMAP"
|
"BACKLOG"
|
"CALENDAR"
|
"DEVTOOLS"
|
"REPORTS"
|
"PAGES"
|
"CODE"
|
"SECURITY"
|
"REQUESTS"
|
"INCIDENTS"
|
"RELEASES"
|
"DEPLOYMENTS"
|
"ISSUE_NAVIGATOR"
|
"ON_CALL_SCHEDULE"
|
"BOARD"
|
"GOALS"
|
"LIST_VIEW"
;
boardId
?:
number
;
featureId
?:
string
;
featureType
?:
string
&
{}
|
"ESTIMATION"
|
"BASIC"
;
imageUri
?:
string
;
learnMoreArticleId
?:
string
;
learnMoreLink
?:
string
;
localisedDescription
?:
string
;
localisedGroup
?:
string
;
localisedName
?:
string
;
permissibleEstimationTypes
?:
{
localisedDescription
?:
...
;
localisedName
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
state
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
"COMING_SOON"
;
toggleLocked
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBacklog
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpicForBoard
:
(
parameters
:
{
boardId
:
number
;
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjects
:
(
parameters
:
{
boardId
:
number
;
maxResults
?:
number
;
startAt
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
avatarUrls
?:
{
"16x16"
?:
(...)
|
(...)
;
"24x24"
?:
(...)
|
(...)
;
"32x32"
?:
(...)
|
(...)
;
"48x48"
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
|
string
&
{}
|
"software"
|
"service_desk"
|
"business"
|
"product_discovery"
|
"customer_service"
;
self
?:
string
;
simplified
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProjectsFull
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
isLast
?:
boolean
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
values
?:
{
avatarUrls
?:
{
"16x16"
?:
(...)
|
(...)
;
"24x24"
?:
(...)
|
(...)
;
"32x32"
?:
(...)
|
(...)
;
"48x48"
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
id
?:
string
;
key
?:
string
;
name
?:
string
;
projectCategory
?:
{
description
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
projectTypeKey
?:
|
string
&
{}
|
"software"
|
"service_desk"
|
"business"
|
"product_discovery"
|
"customer_service"
;
self
?:
string
;
simplified
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getQuickFilter
:
(
parameters
:
{
boardId
:
number
;
quickFilterId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
boardId
?:
number
;
description
?:
string
;
id
?:
number
;
jql
?:
string
;
name
?:
string
;
position
?:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReportsForBoard
:
(
parameters
:
{
boardId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
reports
?:
Record
<
string
,
any
>
[]
;
[
key
:
string
]:
unknown
}
>
;
moveIssuesToBoard
:
(
parameters
:
{
boardId
:
number
;
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
setBoardProperty
:
(
parameters
:
{
boardId
:
string
;
propertyKey
:
string
;
propertyValue
:
Record
<
string
,
any
>
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
toggleFeatures
:
(
parameters
:
{
boardId
:
number
;
body
:
{
boardId
?:
number
;
enabling
?:
boolean
;
feature
?:
string
;
[
key
:
string
]:
unknown
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
features
?:
{
boardFeature
?:
|
string
&
{}
|
"ESTIMATION"
|
"SPRINTS"
|
"SIMPLE_ROADMAP"
|
"BACKLOG"
|
"CALENDAR"
|
"DEVTOOLS"
|
"REPORTS"
|
"PAGES"
|
"CODE"
|
"SECURITY"
|
"REQUESTS"
|
"INCIDENTS"
|
"RELEASES"
|
"DEPLOYMENTS"
|
"ISSUE_NAVIGATOR"
|
"ON_CALL_SCHEDULE"
|
"BOARD"
|
"GOALS"
|
"LIST_VIEW"
;
boardId
?:
number
;
featureId
?:
string
;
featureType
?:
string
&
{}
|
"ESTIMATION"
|
"BASIC"
;
imageUri
?:
string
;
learnMoreArticleId
?:
string
;
learnMoreLink
?:
string
;
localisedDescription
?:
string
;
localisedGroup
?:
string
;
localisedName
?:
string
;
permissibleEstimationTypes
?:
{
localisedDescription
?:
...
;
localisedName
?:
...
;
value
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
state
?:
string
&
{}
|
"ENABLED"
|
"DISABLED"
|
"COMING_SOON"
;
toggleLocked
?:
boolean
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
builds
:
{
deleteBuildByKey
:
(
parameters
:
{
buildNumber
:
number
;
pipelineId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteBuildsByProperty
:
(
parameters
:
{
accountId
:
string
;
repoId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getBuildByKey
:
(
parameters
:
{
buildNumber
:
number
;
pipelineId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
buildNumber
:
number
;
description
?:
string
;
displayName
:
string
;
label
?:
string
;
lastUpdated
:
Date
;
pipelineId
:
string
;
references
?:
{
commit
?:
{
id
:
string
;
repositoryUri
:
string
;
[
key
:
string
]:
unknown
;
}
;
ref
?:
{
name
:
string
;
uri
:
string
;
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
;
testInfo
?:
{
numberFailed
:
number
;
numberPassed
:
number
;
numberSkipped
?:
number
;
totalNumber
:
number
;
[
key
:
string
]:
unknown
;
}
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitBuilds
:
(
parameters
:
{
builds
:
{
associations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
buildNumber
:
number
;
description
?:
string
;
displayName
:
string
;
label
?:
string
;
lastUpdated
:
string
|
Date
;
pipelineId
:
string
;
references
?:
{
commit
?:
{
id
:
...
;
repositoryUri
:
...
}
;
ref
?:
{
name
:
...
;
uri
:
...
}
;
}
[]
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
;
testInfo
?:
{
numberFailed
:
number
;
numberPassed
:
number
;
numberSkipped
?:
number
;
totalNumber
:
number
;
}
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedBuilds
?:
{
buildNumber
:
number
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
rejectedBuilds
?:
{
errors
:
{
errorTraceId
?:
(...)
|
(...)
;
message
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
key
:
{
buildNumber
:
number
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
deployments
:
{
deleteDeploymentByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteDeploymentsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getDeploymentByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"commit"
|
"repository"
;
values
:
((...)
|
(...))
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
commands
?:
{
command
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
deploymentSequenceNumber
:
number
;
description
:
string
;
displayName
:
string
;
duration
?:
number
;
environment
:
{
displayName
:
string
;
id
:
string
;
type
:
|
"unmapped"
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
[
key
:
string
]:
unknown
;
}
;
label
?:
string
;
lastUpdated
:
Date
;
pipeline
:
{
displayName
:
string
;
id
:
string
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
|
"rolled_back"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getDeploymentGatingStatusByKey
:
(
parameters
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
deploymentSequenceNumber
?:
number
;
details
?:
{
issueKey
:
string
;
issueLink
:
string
;
type
:
string
&
{}
|
"issue"
;
[
key
:
string
]:
unknown
;
}
[]
;
environmentId
?:
string
;
gatingStatus
?:
|
"invalid"
|
string
&
{}
|
"allowed"
|
"prevented"
|
"awaiting"
;
pipelineId
?:
string
;
updatedTimestamp
?:
Date
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitDeployments
:
(
parameters
:
{
deployments
:
{
associations
?:
(
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
commands
?:
{
command
?:
string
}
[]
;
deploymentSequenceNumber
:
number
;
description
:
string
;
displayName
:
string
;
duration
?:
number
;
environment
:
{
displayName
:
string
;
id
:
string
;
type
:
|
"unmapped"
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
}
;
label
?:
string
;
lastUpdated
:
string
|
Date
;
pipeline
:
{
displayName
:
string
;
id
:
string
;
url
:
string
}
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
state
:
|
"failed"
|
"unknown"
|
"pending"
|
string
&
{}
|
"successful"
|
"in_progress"
|
"cancelled"
|
"rolled_back"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedDeployments
?:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
rejectedDeployments
?:
{
errors
:
{
errorTraceId
?:
(...)
|
(...)
;
message
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
key
:
{
deploymentSequenceNumber
:
number
;
environmentId
:
string
;
pipelineId
:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownAssociations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"commit"
|
"repository"
;
values
:
((...)
|
(...))
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
developmentInformation
:
{
deleteByProperties
:
(
parameters
:
{
updateSequenceId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteEntity
:
(
parameters
:
{
entityId
:
string
;
entityType
:
string
&
{}
|
"commit"
|
"branch"
|
"pull_request"
;
repositoryId
:
string
;
updateSequenceId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRepository
:
(
parameters
:
{
repositoryId
:
string
;
updateSequenceId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
existsByProperties
:
(
parameters
?:
{
updateSequenceId
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
hasDataMatchingProperties
?:
boolean
;
[
key
:
string
]:
unknown
}
,
>
;
getRepository
:
(
parameters
:
{
repositoryId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatar
?:
string
;
avatarDescription
?:
string
;
branches
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
createPullRequestUrl
?:
string
;
id
:
string
;
lastCommit
:
{
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
[]
;
flags
?:
(...)
[]
;
id
:
string
;
issueKeys
:
string
[]
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
;
name
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
commits
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
author
:
{
avatar
?:
string
;
email
?:
string
;
name
?:
string
;
url
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
{
changeType
:
...
;
linesAdded
:
...
;
linesRemoved
:
...
;
path
:
...
;
url
:
...
;
[
key
:
...
]:
...
;
}
[]
;
flags
?:
((...)
|
(...))
[]
;
id
:
string
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
description
?:
string
;
forkOf
?:
string
;
id
:
string
;
name
:
string
;
pullRequests
?:
{
associations
?:
{
associationType
:
...
;
values
:
...
;
[
key
:
...
]:
...
;
}
[]
;
author
:
{
avatar
?:
string
;
email
?:
string
;
name
?:
string
;
url
?:
string
;
username
?:
string
;
[
key
:
string
]:
unknown
;
}
;
commentCount
:
number
;
destinationBranch
?:
string
;
destinationBranchUrl
?:
string
;
displayId
:
string
;
id
:
string
;
lastUpdate
:
string
;
reviewers
?:
{
accountId
?:
...
;
approvalStatus
?:
...
;
avatar
?:
...
;
email
?:
...
;
name
?:
...
;
url
?:
...
;
[
key
:
...
]:
...
;
}
[]
;
sourceBranch
:
string
;
sourceBranchUrl
?:
string
;
status
:
string
&
{}
|
"OPEN"
|
"UNKNOWN"
|
"MERGED"
|
"DECLINED"
;
title
:
string
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
updateSequenceId
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
storeDevelopmentInformation
:
(
parameters
:
{
operationType
?:
string
&
{}
|
"NORMAL"
|
"BACKFILL"
;
preventTransitions
?:
boolean
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
repositories
:
{
avatar
?:
string
;
avatarDescription
?:
string
;
branches
?:
{
associations
?:
(...)
[]
;
createPullRequestUrl
?:
string
;
id
:
string
;
lastCommit
:
{
author
:
{
avatar
?:
...
;
email
?:
...
;
name
?:
...
;
url
?:
...
;
username
?:
...
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
|
(...)
;
flags
?:
(...)
|
(...)
;
id
:
string
;
issueKeys
:
(...)
[]
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
;
name
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
commits
?:
{
associations
?:
(...)
[]
;
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
}
;
authorTimestamp
:
string
;
displayId
:
string
;
fileCount
:
number
;
files
?:
(...)
[]
;
flags
?:
(...)
[]
;
id
:
string
;
message
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
description
?:
string
;
forkOf
?:
string
;
id
:
string
;
name
:
string
;
pullRequests
?:
{
associations
?:
(...)
[]
;
author
:
{
avatar
?:
(...)
|
(...)
;
email
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
url
?:
(...)
|
(...)
;
username
?:
(...)
|
(...)
;
}
;
commentCount
:
number
;
destinationBranch
?:
string
;
destinationBranchUrl
?:
string
;
displayId
:
string
;
id
:
string
;
lastUpdate
:
string
;
reviewers
?:
(...)
[]
;
sourceBranch
:
string
;
sourceBranchUrl
?:
string
;
status
:
(...)
&
(...)
|
"OPEN"
|
"UNKNOWN"
|
"MERGED"
|
"DECLINED"
;
title
:
string
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
updateSequenceId
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedDevinfoEntities
?:
Record
<
string
,
any
>
;
failedDevinfoEntities
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
devopsComponents
:
{
deleteComponentById
:
(
parameters
:
{
componentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteComponentsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getComponentById
:
(
parameters
:
{
componentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
avatarUrl
:
string
;
componentType
:
|
string
&
{}
|
"Service"
|
"Application"
|
"Library"
|
"Capability"
|
"Cloud resource"
|
"Data pipeline"
|
"Machine learning model"
|
"UI element"
|
"Website"
|
"Other"
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
name
:
string
;
providerName
?:
string
;
schemaVersion
:
string
&
{}
|
"1.0"
;
tier
:
string
&
{}
|
"Tier 1"
|
"Tier 2"
|
"Tier 3"
|
"Tier 4"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitComponents
:
(
parameters
:
{
devopsComponents
:
{
avatarUrl
:
string
;
componentType
:
|
string
&
{}
|
"Service"
|
"Application"
|
"Library"
|
"Capability"
|
"Cloud resource"
|
"Data pipeline"
|
"Machine learning model"
|
"UI element"
|
"Website"
|
"Other"
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
name
:
string
;
providerName
?:
string
;
schemaVersion
:
string
&
{}
|
"1.0"
;
tier
:
string
&
{}
|
"Tier 1"
|
"Tier 2"
|
"Tier 3"
|
"Tier 4"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedComponents
?:
string
[]
;
failedComponents
?:
Record
<
string
,
any
>
;
unknownProjectKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
epic
:
{
getEpic
:
(
parameters
:
{
epicIdOrKey
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
color
?:
{
key
?:
string
;
[
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
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getIssuesWithoutEpic
:
(
parameters
?:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
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
;
[
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
>
;
}
;
featureFlags
:
{
deleteFeatureFlagById
:
(
parameters
:
{
featureFlagId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteFeatureFlagsByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getFeatureFlagById
:
(
parameters
:
{
featureFlagId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
details
:
{
environment
:
{
name
:
string
;
type
?:
|
string
&
{}
|
"development"
|
"testing"
|
"staging"
|
"production"
;
[
key
:
string
]:
unknown
;
}
;
lastUpdated
:
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
(...)
|
(...)
;
rules
?:
(...)
|
(...)
;
text
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
displayName
?:
string
;
id
:
string
;
key
:
string
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
summary
:
{
lastUpdated
:
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
number
;
rules
?:
number
;
text
?:
string
;
[
key
:
string
]:
unknown
;
}
;
[
key
:
string
]:
unknown
;
}
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
updateSequenceId
:
number
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitFeatureFlags
:
(
parameters
:
{
flags
:
{
associations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
details
:
{
environment
:
{
name
:
string
;
type
?:
|
(...)
&
(...)
|
"development"
|
"testing"
|
"staging"
|
"production"
;
}
;
lastUpdated
:
string
|
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
...
;
rules
?:
...
;
text
?:
...
}
;
}
;
url
:
string
;
}
[]
;
displayName
?:
string
;
id
:
string
;
key
:
string
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
summary
:
{
lastUpdated
:
string
|
Date
;
status
:
{
defaultValue
?:
string
;
enabled
:
boolean
;
rollout
?:
{
percentage
?:
(...)
|
(...)
;
rules
?:
(...)
|
(...)
;
text
?:
(...)
|
(...)
;
}
;
}
;
url
?:
string
;
}
;
updateSequenceId
:
number
;
}
[]
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedFeatureFlags
?:
string
[]
;
failedFeatureFlags
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
unknownIssueKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
issue
:
{
estimateIssueForBoard
:
(
parameters
:
{
boardId
?:
number
;
issueIdOrKey
:
string
;
value
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
fieldId
?:
string
;
value
?:
number
;
[
key
:
string
]:
unknown
}
>
;
getIssue
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
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
,
any
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
string
[]
;
excluded
?:
string
[]
;
included
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
LinkGroup
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
hasScreen
?:
boolean
;
id
?:
string
;
isAvailable
?:
boolean
;
isConditional
?:
boolean
;
isGlobal
?:
boolean
;
isInitial
?:
boolean
;
looped
?:
boolean
;
name
?:
string
;
to
?:
{
description
?:
(...)
|
(...)
;
iconUrl
?:
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
scope
?:
(...)
|
(...)
;
self
?:
(...)
|
(...)
;
statusCategory
?:
(...)
|
(...)
;
[
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
?:
number
;
[
key
:
string
]:
unknown
}
>
;
rankIssues
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
operations
:
{
deleteEntityByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteIncidentById
:
(
parameters
:
{
incidentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteReviewById
:
(
parameters
:
{
reviewId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIncidentById
:
(
parameters
:
{
incidentId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
affectedComponents
:
string
[]
;
associations
?:
{
associationType
?:
|
string
&
{}
|
"issueIdOrKeys"
|
"serviceIdOrKeys"
|
"ati:cloud:compass:event-source"
;
values
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
createdDate
:
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
?:
{
level
:
"unknown"
|
string
&
{}
|
"P1"
|
"P2"
|
"P3"
|
"P4"
|
"P5"
;
[
key
:
string
]:
unknown
;
}
;
status
:
"unknown"
|
"open"
|
string
&
{}
|
"resolved"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getReviewById
:
(
parameters
:
{
reviewId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
associations
?:
{
associationType
?:
|
string
&
{}
|
"issueIdOrKeys"
|
"serviceIdOrKeys"
|
"ati:cloud:compass:event-source"
;
values
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
createdDate
:
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
Date
;
reviews
:
string
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
status
:
|
"unknown"
|
"completed"
|
string
&
{}
|
"in progress"
|
"outstanding actions"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
getWorkspaces
:
(
parameters
?:
{
workspaceId
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
workspaceIds
:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
submitEntity
:
(
parameters
:
{
body
:
|
{
incidents
?:
{
affectedComponents
:
string
[]
;
associations
?:
(...)
[]
;
createdDate
:
string
|
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
schemaVersion
:
(...)
&
(...)
|
"1.0"
;
severity
?:
{
level
:
...
}
;
status
:
"unknown"
|
"open"
|
(...)
&
(...)
|
"resolved"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
|
{
reviews
?:
{
associations
?:
(...)
[]
;
createdDate
:
string
|
Date
;
description
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
reviews
:
string
[]
;
schemaVersion
:
(...)
&
(...)
|
"1.0"
;
status
:
|
"unknown"
|
"completed"
|
(...)
&
(...)
|
"in progress"
|
"outstanding actions"
;
summary
:
string
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedIncidents
?:
string
[]
;
failedIncidents
?:
Record
<
string
,
any
>
;
unknownProjectKeys
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitOperationsWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedWorkspaceIds
?:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
}
;
remoteLinks
:
{
deleteRemoteLinkById
:
(
parameters
:
{
remoteLinkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteRemoteLinksByProperty
:
(
parameters
:
{
params
?:
Record
<
string
,
any
>
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getRemoteLinkById
:
(
parameters
:
{
remoteLinkId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
actionIds
?:
string
[]
;
associations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
attributeMap
?:
Record
<
string
,
any
>
;
description
?:
string
;
displayName
:
string
;
id
:
string
;
lastUpdated
:
Date
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
status
?:
{
appearance
:
|
"default"
|
"new"
|
"removed"
|
"success"
|
string
&
{}
|
"prototype"
|
"inprogress"
|
"moved"
;
label
:
string
;
[
key
:
string
]:
unknown
;
}
;
type
:
|
"other"
|
"document"
|
"alert"
|
string
&
{}
|
"test"
|
"security"
|
"logFile"
|
"prototype"
|
"coverage"
|
"bugReport"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitRemoteLinks
:
(
parameters
:
{
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
remoteLinks
:
{
actionIds
?:
string
[]
;
associations
?:
(
|
{
associationType
:
(...)
|
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
|
(...)
;
values
:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
attributeMap
?:
Record
<
string
,
any
>
;
description
?:
string
;
displayName
:
string
;
id
:
string
;
lastUpdated
:
string
|
Date
;
schemaVersion
?:
string
&
{}
|
"1.0"
;
status
?:
{
appearance
:
|
"default"
|
"new"
|
"removed"
|
"success"
|
string
&
{}
|
"prototype"
|
"inprogress"
|
"moved"
;
label
:
string
;
}
;
type
:
|
"other"
|
"document"
|
"alert"
|
string
&
{}
|
"test"
|
"security"
|
"logFile"
|
"prototype"
|
"coverage"
|
"bugReport"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedRemoteLinks
?:
string
[]
;
rejectedRemoteLinks
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
(
|
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
|
{
associationType
:
(...)
&
(...)
|
"serviceIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
)
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
securityInformation
:
{
deleteLinkedWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
|
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVulnerabilitiesByProperty
:
(
parameters
:
{
accountId
:
string
;
createdBy
?:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteVulnerabilityById
:
(
parameters
:
{
vulnerabilityId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getLinkedWorkspaceById
:
(
parameters
:
{
workspaceId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
updatedAt
:
Date
;
workspaceId
:
string
;
[
key
:
string
]:
unknown
}
,
>
;
getLinkedWorkspaces
:
(
options
?:
RequestOptions
,
)
=>
Promise
<
{
workspaceIds
:
string
[]
;
[
key
:
string
]:
unknown
}
>
;
getVulnerabilityById
:
(
parameters
:
{
vulnerabilityId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
addAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
additionalInfo
?:
{
content
:
string
;
url
?:
string
;
[
key
:
string
]:
unknown
;
}
;
associationsLastUpdated
?:
Date
;
associationsUpdateSequenceNumber
?:
number
;
containerId
:
string
;
description
:
string
;
displayName
:
string
;
id
:
string
;
identifiers
?:
{
displayName
:
string
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
introducedDate
:
Date
;
lastUpdated
:
Date
;
removeAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
:
{
level
:
|
"high"
|
"low"
|
"medium"
|
"unknown"
|
string
&
{}
|
"critical"
;
[
key
:
string
]:
unknown
;
}
;
status
:
"unknown"
|
"closed"
|
"open"
|
string
&
{}
|
"ignored"
;
type
:
"unknown"
|
string
&
{}
|
"sca"
|
"sast"
|
"dast"
;
updateSequenceNumber
:
number
;
url
:
string
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitVulnerabilities
:
(
parameters
:
{
operationType
?:
string
&
{}
|
"NORMAL"
|
"BACKFILL"
|
"SCAN"
;
properties
?:
Record
<
string
,
any
>
;
providerMetadata
?:
{
product
?:
string
}
;
vulnerabilities
:
{
addAssociations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
additionalInfo
?:
{
content
:
string
;
url
?:
string
}
;
associationsLastUpdated
?:
string
|
Date
;
associationsUpdateSequenceNumber
?:
number
;
containerId
:
string
;
description
:
string
;
displayName
:
string
;
id
:
string
;
identifiers
?:
{
displayName
:
string
;
url
:
string
}
[]
;
introducedDate
:
string
|
Date
;
lastUpdated
:
string
|
Date
;
removeAssociations
?:
{
associationType
:
(...)
&
(...)
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
schemaVersion
:
string
&
{}
|
"1.0"
;
severity
:
{
level
:
|
"high"
|
"low"
|
"medium"
|
"unknown"
|
string
&
{}
|
"critical"
;
}
;
status
:
"unknown"
|
"closed"
|
"open"
|
string
&
{}
|
"ignored"
;
type
:
"unknown"
|
string
&
{}
|
"sca"
|
"sast"
|
"dast"
;
updateSequenceNumber
:
number
;
url
:
string
;
}
[]
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
acceptedVulnerabilities
?:
string
[]
;
failedVulnerabilities
?:
Record
<
string
,
any
>
;
unknownAssociations
?:
{
associationType
:
string
&
{}
|
"issueKeys"
|
"issueIdOrKeys"
;
values
:
string
[]
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
submitWorkspaces
:
(
parameters
:
{
workspaceIds
:
string
[]
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
}
;
sprint
:
{
createSprint
:
(
parameters
:
{
endDate
?:
string
|
Date
;
goal
?:
string
;
name
:
string
;
originBoardId
?:
number
;
startDate
?:
string
|
Date
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
deleteProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
deleteSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
getIssuesForSprint
:
(
parameters
:
{
expand
?:
string
|
string
[]
;
fields
?:
Record
<
string
,
any
>
[]
;
jql
?:
string
;
maxResults
?:
number
;
nextPageToken
?:
string
;
reconcileIssues
?:
number
[]
;
sprintId
:
number
;
validateQuery
?:
boolean
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
expand
?:
string
;
isLast
:
boolean
;
issues
:
{
changelog
?:
{
histories
?:
(...)
[]
;
maxResults
?:
number
;
startAt
?:
number
;
total
?:
number
;
[
key
:
string
]:
unknown
;
}
;
editmeta
?:
{
fields
?:
Record
<
(...)
,
(...)
>
;
[
key
:
string
]:
unknown
}
;
expand
?:
string
;
fields
?:
Record
<
string
,
any
>
;
fieldsToInclude
?:
{
actuallyIncluded
?:
(...)
[]
;
excluded
?:
(...)
[]
;
included
?:
(...)
[]
;
[
key
:
string
]:
unknown
;
}
;
id
:
string
;
key
:
string
;
names
?:
Record
<
string
,
any
>
;
operations
?:
{
linkGroups
?:
(...)
[]
;
[
key
:
string
]:
unknown
}
;
properties
?:
Record
<
string
,
any
>
;
renderedFields
?:
Record
<
string
,
any
>
;
schema
?:
Record
<
string
,
any
>
;
self
:
string
;
transitions
?:
{
expand
?:
(...)
|
(...)
;
fields
?:
(...)
|
(...)
;
hasScreen
?:
(...)
|
(...)
|
(...)
;
id
?:
(...)
|
(...)
;
isAvailable
?:
(...)
|
(...)
|
(...)
;
isConditional
?:
(...)
|
(...)
|
(...)
;
isGlobal
?:
(...)
|
(...)
|
(...)
;
isInitial
?:
(...)
|
(...)
|
(...)
;
looped
?:
(...)
|
(...)
|
(...)
;
name
?:
(...)
|
(...)
;
to
?:
(...)
|
(...)
;
[
key
:
string
]:
unknown
;
}
[]
;
versionedRepresentations
?:
Record
<
string
,
any
>
;
[
key
:
string
]:
unknown
;
}
[]
;
names
?:
Record
<
string
,
any
>
;
nextPageToken
?:
string
;
schema
?:
Record
<
string
,
any
>
;
warningMessages
?:
string
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getPropertiesKeys
:
(
parameters
:
{
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
keys
?:
{
key
?:
string
;
self
?:
string
;
[
key
:
string
]:
unknown
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
getProperty
:
(
parameters
:
{
propertyKey
:
string
;
sprintId
:
string
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
key
:
string
;
value
:
unknown
;
[
key
:
string
]:
unknown
}
>
;
getSprint
:
(
parameters
:
{
sprintId
:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
moveIssuesToSprintAndRank
:
(
parameters
:
{
issues
?:
string
[]
;
rankAfterIssue
?:
string
;
rankBeforeIssue
?:
string
;
rankCustomFieldId
?:
number
;
sprintId
:
number
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
partiallyUpdateSprint
:
(
parameters
:
{
completeDate
?:
string
|
Date
;
createdDate
?:
string
|
Date
;
endDate
?:
string
|
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
sprintId
:
number
;
startDate
?:
string
|
Date
;
state
?:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
setProperty
:
(
parameters
:
{
propertyKey
:
string
;
propertyValue
:
Record
<
string
,
any
>
;
sprintId
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
swapSprint
:
(
parameters
:
{
sprintId
:
number
;
sprintToSwapWith
?:
number
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
void
>
;
updateSprint
:
(
parameters
:
{
completeDate
?:
string
|
Date
;
createdDate
?:
string
|
Date
;
endDate
?:
string
|
Date
;
goal
?:
string
;
id
?:
number
;
name
:
string
;
originBoardId
?:
number
;
sprintId
:
number
;
startDate
?:
string
|
Date
;
state
:
string
;
}
,
options
?:
RequestOptions
,
)
=>
Promise
<
{
completeDate
?:
Date
;
createdDate
?:
Date
;
endDate
?:
Date
;
goal
?:
string
;
id
?:
number
;
name
?:
string
;
originBoardId
?:
number
;
self
?:
string
;
startDate
?:
Date
;
state
:
"active"
|
"closed"
|
string
&
{}
|
"future"
;
[
key
:
string
]:
unknown
;
}
,
>
;
}
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Guide
GitHub
jira.js
Loading...