Jira.js - Jira Cloud API library
Preparing search index...
Version2
Version2Client
Class Version2Client
Hierarchy (
View Summary
)
BaseClient
Version2Client
Index
Constructors
constructor
Properties
announcement
Banner
app
Data
Policies
application
Roles
app
Migration
app
Properties
audit
Records
avatars
classification
Levels
config
dashboards
dynamic
Modules
filters
filter
Sharing
group
And
User
Picker
groups
issue
Attachments
issue
Comment
Properties
issue
Comments
issue
Custom
Field
Configuration
Apps
issue
Custom
Field
Contexts
issue
Custom
Field
Options
issue
Custom
Field
Options
Apps
issue
Custom
Field
Values
Apps
issue
Field
Configurations
issue
Fields
issue
Links
issue
Link
Types
issue
Navigator
Settings
issue
Notification
Schemes
issue
Priorities
issue
Properties
issue
Remote
Links
issue
Resolutions
issues
issue
Search
issue
Security
Level
issue
Security
Schemes
issue
Type
Properties
issue
Types
issue
Type
Schemes
issue
Type
Screen
Schemes
issue
Votes
issue
Watchers
issue
Worklog
Properties
issue
Worklogs
jira
Expressions
jira
Settings
jql
jql
Functions
Apps
labels
license
Metrics
myself
permissions
permission
Schemes
plans
priority
Schemes
project
Avatars
project
Categories
project
Classification
Levels
project
Components
project
Email
project
Features
project
Key
And
Name
Validation
project
Permission
Schemes
project
Properties
project
Role
Actors
project
Roles
projects
project
Types
project
Versions
screens
screen
Schemes
screen
Tab
Fields
screen
Tabs
server
Info
service
Registry
status
tasks
teams
In
Plan
time
Tracking
ui
Modifications
Apps
user
Properties
users
user
Search
webhooks
workflows
workflow
Scheme
Drafts
workflow
Scheme
Project
Associations
workflow
Schemes
workflow
Status
Categories
workflow
Statuses
workflow
Transition
Properties
workflow
Transition
Rules
Methods
encode
handle
Failed
Response
handle
Success
Response
param
Serializer
remove
Undefined
Properties
send
Request
send
Request
Full
Response
Constructors
constructor
new
Version2Client
(
config
:
Config
)
:
Version2
.
Version2Client
Parameters
config
:
Config
Returns
Version2
.
Version2Client
Properties
announcement
Banner
announcementBanner
:
Version2
.
AnnouncementBanner
= ...
app
Data
Policies
appDataPolicies
:
Version2
.
AppDataPolicies
= ...
application
Roles
applicationRoles
:
Version2
.
ApplicationRoles
= ...
app
Migration
appMigration
:
Version2
.
AppMigration
= ...
app
Properties
appProperties
:
Version2
.
AppProperties
= ...
audit
Records
auditRecords
:
Version2
.
AuditRecords
= ...
avatars
avatars
:
Version2
.
Avatars
= ...
classification
Levels
classificationLevels
:
Version2
.
ClassificationLevels
= ...
Protected
Readonly
config
config
:
Config
dashboards
dashboards
:
Version2
.
Dashboards
= ...
dynamic
Modules
dynamicModules
:
Version2
.
DynamicModules
= ...
filters
filters
:
Version2
.
Filters
= ...
filter
Sharing
filterSharing
:
Version2
.
FilterSharing
= ...
group
And
User
Picker
groupAndUserPicker
:
Version2
.
GroupAndUserPicker
= ...
groups
groups
:
Version2
.
Groups
= ...
issue
Attachments
issueAttachments
:
Version2
.
IssueAttachments
= ...
issue
Comment
Properties
issueCommentProperties
:
Version2
.
IssueCommentProperties
= ...
issue
Comments
issueComments
:
Version2
.
IssueComments
= ...
issue
Custom
Field
Configuration
Apps
issueCustomFieldConfigurationApps
:
Version2
.
IssueCustomFieldConfigurationApps
= ...
issue
Custom
Field
Contexts
issueCustomFieldContexts
:
Version2
.
IssueCustomFieldContexts
= ...
issue
Custom
Field
Options
issueCustomFieldOptions
:
Version2
.
IssueCustomFieldOptions
= ...
issue
Custom
Field
Options
Apps
issueCustomFieldOptionsApps
:
Version2
.
IssueCustomFieldOptionsApps
= ...
issue
Custom
Field
Values
Apps
issueCustomFieldValuesApps
:
Version2
.
IssueCustomFieldValuesApps
= ...
issue
Field
Configurations
issueFieldConfigurations
:
Version2
.
IssueFieldConfigurations
= ...
issue
Fields
issueFields
:
Version2
.
IssueFields
= ...
issue
Links
issueLinks
:
Version2
.
IssueLinks
= ...
issue
Link
Types
issueLinkTypes
:
Version2
.
IssueLinkTypes
= ...
issue
Navigator
Settings
issueNavigatorSettings
:
Version2
.
IssueNavigatorSettings
= ...
issue
Notification
Schemes
issueNotificationSchemes
:
Version2
.
IssueNotificationSchemes
= ...
issue
Priorities
issuePriorities
:
Version2
.
IssuePriorities
= ...
issue
Properties
issueProperties
:
Version2
.
IssueProperties
= ...
issue
Remote
Links
issueRemoteLinks
:
Version2
.
IssueRemoteLinks
= ...
issue
Resolutions
issueResolutions
:
Version2
.
IssueResolutions
= ...
issues
issues
:
Version2
.
Issues
= ...
issue
Search
issueSearch
:
Version2
.
IssueSearch
= ...
issue
Security
Level
issueSecurityLevel
:
Version2
.
IssueSecurityLevel
= ...
issue
Security
Schemes
issueSecuritySchemes
:
Version2
.
IssueSecuritySchemes
= ...
issue
Type
Properties
issueTypeProperties
:
Version2
.
IssueTypeProperties
= ...
issue
Types
issueTypes
:
Version2
.
IssueTypes
= ...
issue
Type
Schemes
issueTypeSchemes
:
Version2
.
IssueTypeSchemes
= ...
issue
Type
Screen
Schemes
issueTypeScreenSchemes
:
Version2
.
IssueTypeScreenSchemes
= ...
issue
Votes
issueVotes
:
Version2
.
IssueVotes
= ...
issue
Watchers
issueWatchers
:
Version2
.
IssueWatchers
= ...
issue
Worklog
Properties
issueWorklogProperties
:
Version2
.
IssueWorklogProperties
= ...
issue
Worklogs
issueWorklogs
:
Version2
.
IssueWorklogs
= ...
jira
Expressions
jiraExpressions
:
Version2
.
JiraExpressions
= ...
jira
Settings
jiraSettings
:
Version2
.
JiraSettings
= ...
jql
jql
:
Version2
.
JQL
= ...
jql
Functions
Apps
jqlFunctionsApps
:
Version2
.
JqlFunctionsApps
= ...
labels
labels
:
Version2
.
Labels
= ...
license
Metrics
licenseMetrics
:
Version2
.
LicenseMetrics
= ...
myself
myself
:
Version2
.
Myself
= ...
permissions
permissions
:
Version2
.
Permissions
= ...
permission
Schemes
permissionSchemes
:
Version2
.
PermissionSchemes
= ...
plans
plans
:
Version2
.
Plans
= ...
priority
Schemes
prioritySchemes
:
Version2
.
PrioritySchemes
= ...
project
Avatars
projectAvatars
:
Version2
.
ProjectAvatars
= ...
project
Categories
projectCategories
:
Version2
.
ProjectCategories
= ...
project
Classification
Levels
projectClassificationLevels
:
Version2
.
ProjectClassificationLevels
= ...
project
Components
projectComponents
:
Version2
.
ProjectComponents
= ...
project
Email
projectEmail
:
Version2
.
ProjectEmail
= ...
project
Features
projectFeatures
:
Version2
.
ProjectFeatures
= ...
project
Key
And
Name
Validation
projectKeyAndNameValidation
:
Version2
.
ProjectKeyAndNameValidation
= ...
project
Permission
Schemes
projectPermissionSchemes
:
Version2
.
ProjectPermissionSchemes
= ...
project
Properties
projectProperties
:
Version2
.
ProjectProperties
= ...
project
Role
Actors
projectRoleActors
:
Version2
.
ProjectRoleActors
= ...
project
Roles
projectRoles
:
Version2
.
ProjectRoles
= ...
projects
projects
:
Version2
.
Projects
= ...
project
Types
projectTypes
:
Version2
.
ProjectTypes
= ...
project
Versions
projectVersions
:
Version2
.
ProjectVersions
= ...
screens
screens
:
Version2
.
Screens
= ...
screen
Schemes
screenSchemes
:
Version2
.
ScreenSchemes
= ...
screen
Tab
Fields
screenTabFields
:
Version2
.
ScreenTabFields
= ...
screen
Tabs
screenTabs
:
Version2
.
ScreenTabs
= ...
server
Info
serverInfo
:
Version2
.
ServerInfo
= ...
service
Registry
serviceRegistry
:
Version2
.
ServiceRegistry
= ...
status
status
:
Version2
.
Status
= ...
tasks
tasks
:
Version2
.
Tasks
= ...
teams
In
Plan
teamsInPlan
:
Version2
.
TeamsInPlan
= ...
time
Tracking
timeTracking
:
Version2
.
TimeTracking
= ...
ui
Modifications
Apps
uiModificationsApps
:
Version2
.
UIModificationsApps
= ...
user
Properties
userProperties
:
Version2
.
UserProperties
= ...
users
users
:
Version2
.
Users
= ...
user
Search
userSearch
:
Version2
.
UserSearch
= ...
webhooks
webhooks
:
Version2
.
Webhooks
= ...
workflows
workflows
:
Version2
.
Workflows
= ...
workflow
Scheme
Drafts
workflowSchemeDrafts
:
Version2
.
WorkflowSchemeDrafts
= ...
workflow
Scheme
Project
Associations
workflowSchemeProjectAssociations
:
Version2
.
WorkflowSchemeProjectAssociations
= ...
workflow
Schemes
workflowSchemes
:
Version2
.
WorkflowSchemes
= ...
workflow
Status
Categories
workflowStatusCategories
:
Version2
.
WorkflowStatusCategories
= ...
workflow
Statuses
workflowStatuses
:
Version2
.
WorkflowStatuses
= ...
workflow
Transition
Properties
workflowTransitionProperties
:
Version2
.
WorkflowTransitionProperties
= ...
workflow
Transition
Rules
workflowTransitionRules
:
Version2
.
WorkflowTransitionRules
= ...
Methods
Protected
encode
encode
(
value
:
string
)
:
string
Parameters
value
:
string
Returns
string
handle
Failed
Response
handleFailedResponse
<
T
>
(
e
:
unknown
,
callback
?:
Callback
<
T
>
)
:
void
Type Parameters
T
Parameters
e
:
unknown
Optional
callback
:
Callback
<
T
>
Returns
void
handle
Success
Response
handleSuccessResponse
<
T
>
(
response
:
any
,
callback
?:
Callback
<
T
>
)
:
void
|
T
Type Parameters
T
Parameters
response
:
any
Optional
callback
:
Callback
<
T
>
Returns
void
|
T
Protected
param
Serializer
paramSerializer
(
parameters
:
Record
<
string
,
any
>
)
:
string
Parameters
parameters
:
Record
<
string
,
any
>
Returns
string
Protected
remove
Undefined
Properties
removeUndefinedProperties
(
obj
:
Record
<
string
,
any
>
)
:
Record
<
string
,
any
>
Parameters
obj
:
Record
<
string
,
any
>
Returns
Record
<
string
,
any
>
send
Request
sendRequest
<
T
>
(
requestConfig
:
RequestConfig
,
callback
:
never
,
telemetryData
?:
any
,
)
:
Promise
<
T
>
Type Parameters
T
Parameters
requestConfig
:
RequestConfig
callback
:
never
Optional
telemetryData
:
any
Returns
Promise
<
T
>
sendRequest
<
T
>
(
requestConfig
:
RequestConfig
,
callback
:
Callback
<
T
>
,
telemetryData
?:
any
,
)
:
Promise
<
void
>
Type Parameters
T
Parameters
requestConfig
:
RequestConfig
callback
:
Callback
<
T
>
Optional
telemetryData
:
any
Returns
Promise
<
void
>
send
Request
Full
Response
sendRequestFullResponse
<
T
>
(
requestConfig
:
RequestConfig
,
)
:
Promise
<
AxiosResponse
<
T
,
any
>
>
Type Parameters
T
Parameters
requestConfig
:
RequestConfig
Returns
Promise
<
AxiosResponse
<
T
,
any
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
announcement
Banner
app
Data
Policies
application
Roles
app
Migration
app
Properties
audit
Records
avatars
classification
Levels
config
dashboards
dynamic
Modules
filters
filter
Sharing
group
And
User
Picker
groups
issue
Attachments
issue
Comment
Properties
issue
Comments
issue
Custom
Field
Configuration
Apps
issue
Custom
Field
Contexts
issue
Custom
Field
Options
issue
Custom
Field
Options
Apps
issue
Custom
Field
Values
Apps
issue
Field
Configurations
issue
Fields
issue
Links
issue
Link
Types
issue
Navigator
Settings
issue
Notification
Schemes
issue
Priorities
issue
Properties
issue
Remote
Links
issue
Resolutions
issues
issue
Search
issue
Security
Level
issue
Security
Schemes
issue
Type
Properties
issue
Types
issue
Type
Schemes
issue
Type
Screen
Schemes
issue
Votes
issue
Watchers
issue
Worklog
Properties
issue
Worklogs
jira
Expressions
jira
Settings
jql
jql
Functions
Apps
labels
license
Metrics
myself
permissions
permission
Schemes
plans
priority
Schemes
project
Avatars
project
Categories
project
Classification
Levels
project
Components
project
Email
project
Features
project
Key
And
Name
Validation
project
Permission
Schemes
project
Properties
project
Role
Actors
project
Roles
projects
project
Types
project
Versions
screens
screen
Schemes
screen
Tab
Fields
screen
Tabs
server
Info
service
Registry
status
tasks
teams
In
Plan
time
Tracking
ui
Modifications
Apps
user
Properties
users
user
Search
webhooks
workflows
workflow
Scheme
Drafts
workflow
Scheme
Project
Associations
workflow
Schemes
workflow
Status
Categories
workflow
Statuses
workflow
Transition
Properties
workflow
Transition
Rules
Methods
encode
handle
Failed
Response
handle
Success
Response
param
Serializer
remove
Undefined
Properties
send
Request
send
Request
Full
Response
Jira.js - Jira Cloud API library
Loading...