Skip to main content

Module client

Module client 

Source
Expand description

Atlassian Cloud REST API client.

Provides HTTP access to JIRA Cloud REST API v3 for reading and writing issues. Uses Basic Auth (email + API token).

Structs§

AgileBoard
A JIRA agile board.
AgileBoardList
Result from listing agile boards.
AgileSprint
A JIRA agile sprint.
AgileSprintList
Result from listing agile sprints.
AtlassianClient
HTTP client for Atlassian Cloud REST APIs.
ConfluenceSearchResult
A Confluence search result.
ConfluenceSearchResults
Result from a Confluence CQL search.
ConfluenceUserSearchResult
A Confluence user in search results.
ConfluenceUserSearchResults
Result from searching Confluence users.
EditMeta
Metadata returned by GET /rest/api/3/issue/{key}/editmeta.
EditMetaField
A single field descriptor from the editmeta response.
EditMetaSchema
Schema type information for an editable field.
JiraAttachment
A JIRA issue attachment.
JiraChangelogEntry
A JIRA issue changelog entry.
JiraChangelogItem
A single field change in a changelog entry.
JiraComment
A JIRA issue comment.
JiraCreatedIssue
Result from creating a JIRA issue via the REST API.
JiraCustomField
A JIRA custom field value keyed by both its stable ID and human name.
JiraDevBranch
A branch from Jira’s DevStatus API.
JiraDevCommit
A commit from Jira’s DevStatus API.
JiraDevPullRequest
A pull request from Jira’s DevStatus API.
JiraDevRepository
A repository from Jira’s DevStatus API.
JiraDevStatus
Development status information for a Jira issue.
JiraDevStatusCount
Summary counts for a category of development status.
JiraDevStatusSummary
High-level development status summary for a Jira issue.
JiraField
A JIRA field definition.
JiraFieldOption
An option value for a JIRA custom field.
JiraIssue
JIRA issue data returned from the REST API.
JiraIssueLink
A link on a JIRA issue.
JiraLinkType
A JIRA issue link type.
JiraProject
A JIRA project.
JiraProjectList
Result from listing JIRA projects.
JiraSearchResult
Result from a JIRA JQL search.
JiraTransition
A JIRA workflow transition.
JiraUser
Response from the JIRA /myself endpoint.
JiraWatcherList
Result from listing watchers on a JIRA issue.
JiraWorklog
A JIRA issue worklog entry.
JiraWorklogList
Result from listing JIRA worklogs.

Enums§

FieldSelection
Selector for which fields to request when fetching a JIRA issue.