Struct JiraClient 

pub struct JiraClient { /* private fields */ }

Implementations

impl JiraClient

pub fn new( host: &str, email: &str, token: &str, auth_type: AuthType, api_version: u8, ) -> Result<Self, ApiError>

pub fn host(&self) -> &str

pub fn api_version(&self) -> u8

pub fn browse_base_url(&self) -> &str

pub fn browse_url(&self, issue_key: &str) -> String

pub async fn search( &self, jql: &str, max_results: usize, start_at: usize, ) -> Result<SearchResponse, ApiError>

Search issues using JQL.

pub async fn get_issue(&self, key: &str) -> Result<Issue, ApiError>

Fetch a single issue by key (e.g. PROJ-123), including all comments.

Jira embeds only the first page of comments in the issue response. When the embedded page is incomplete, additional requests are made to fetch the remaining comments.

pub async fn create_issue( &self, project_key: &str, issue_type: &str, summary: &str, description: Option<&str>, priority: Option<&str>, labels: Option<&[&str]>, assignee: Option<&str>, custom_fields: &[(String, Value)], ) -> Result<CreateIssueResponse, ApiError>

Create a new issue.

pub async fn add_comment( &self, key: &str, body: &str, ) -> Result<Comment, ApiError>

Add a comment to an issue.

pub async fn get_transitions( &self, key: &str, ) -> Result<Vec<Transition>, ApiError>

List available transitions for an issue.

pub async fn do_transition( &self, key: &str, transition_id: &str, ) -> Result<(), ApiError>

Execute a transition by transition ID.

pub async fn assign_issue( &self, key: &str, account_id: Option<&str>, ) -> Result<(), ApiError>

Assign an issue to a user, or unassign with None.

API v3 (Jira Cloud) identifies users by accountId. API v2 (Jira Data Center / Server) identifies users by name (username).

pub async fn get_myself(&self) -> Result<Myself, ApiError>

Get the currently authenticated user.

pub async fn update_issue( &self, key: &str, summary: Option<&str>, description: Option<&str>, priority: Option<&str>, custom_fields: &[(String, Value)], ) -> Result<(), ApiError>

Update issue fields (summary, description, priority, or any custom field).

pub async fn search_users(&self, query: &str) -> Result<Vec<User>, ApiError>

Search for users matching a query string.

API v2: uses username parameter. API v3: uses query parameter.

pub async fn get_link_types(&self) -> Result<Vec<IssueLinkType>, ApiError>

List available issue link types.

pub async fn link_issues( &self, from_key: &str, to_key: &str, link_type: &str, ) -> Result<(), ApiError>

Link two issues.

link_type is the name of the link type (e.g. “Blocks”, “Duplicate”). The direction follows the link type’s outward description: from_key outward-links to to_key.

pub async fn unlink_issues(&self, link_id: &str) -> Result<(), ApiError>

Remove an issue link by its ID.

pub async fn list_boards(&self) -> Result<Vec<Board>, ApiError>

List all boards, fetching all pages.

pub async fn list_sprints( &self, board_id: u64, state: Option<&str>, ) -> Result<Vec<Sprint>, ApiError>

List sprints for a board, optionally filtered by state.

state can be “active”, “closed”, “future”, or None for all.

pub async fn list_projects(&self) -> Result<Vec<Project>, ApiError>

List all accessible projects.

API v3 (Jira Cloud) uses the paginated project/search endpoint. API v2 (Jira Data Center / Server) uses the simpler project endpoint that returns all results in a single flat array.

pub async fn get_project(&self, key: &str) -> Result<Project, ApiError>

Fetch a single project by key.

pub async fn list_fields(&self) -> Result<Vec<Field>, ApiError>

List all available fields (system and custom).

pub async fn move_issue_to_sprint( &self, issue_key: &str, sprint_id: u64, ) -> Result<(), ApiError>

Move an issue to a sprint.

Uses the Agile REST API which is version-independent.

pub async fn get_sprint(&self, sprint_id: u64) -> Result<Sprint, ApiError>

Fetch a single sprint by numeric ID.

pub async fn resolve_sprint(&self, specifier: &str) -> Result<Sprint, ApiError>

Resolve a sprint specifier to a Sprint.

Accepts:

• A numeric string: fetches the sprint by ID to confirm it exists and get the name
• "active": returns the first active sprint found across all boards
• Any other string: matched case-insensitively as a substring of sprint names

pub async fn resolve_sprint_id(&self, specifier: &str) -> Result<u64, ApiError>

Resolve a sprint specifier to its numeric ID.

See [resolve_sprint] for accepted specifier formats.