Struct JiraAPIClient

pub struct JiraAPIClient {
    pub url: Url,
    /* private fields */
}

Reusable client for interfacing with Jira

Fields

url: Url

Implementations

impl JiraAPIClient

pub fn new(cfg: &JiraClientConfig) -> Result<JiraAPIClient, JiraClientError>

Instantiate a reusable API client.

use jira_issue_api::models::*;
use jira_issue_api::{Credential, JiraClientConfig, JiraAPIClient};

let anon = Credential::Anonymous;

// let credential = Credential::PersonalAccessToken("xxxxxxx".to_string())

// let api_token = Credential::ApiToken {
//     login: "user@example.com".to_string(),
//     token: "xxxxxxx".to_string(),
// };

let jira_cfg = JiraClientConfig {
    credential: anon,
    max_query_results: 50u32,
    url: "https://domain.atlassian.net".to_string(),
    timeout: 10u64,
    tls_accept_invalid_certs: false,
};

let client = JiraAPIClient::new(&jira_cfg).unwrap();

pub async fn query_issues( &self, query: &str, fields: Option<Vec<String>>, expand_options: Option<Vec<String>>, ) -> Result<PostIssueQueryResponseBody, JiraClientError>

pub async fn post_worklog( &self, issue_key: &IssueKey, body: PostWorklogBody, ) -> Result<Response, JiraClientError>

pub async fn post_comment( &self, issue_key: &IssueKey, body: PostCommentBody, ) -> Result<Response, JiraClientError>

pub async fn get_issue( &self, issue_key: &IssueKey, expand_options: Option<&str>, ) -> Result<Issue, JiraClientError>

pub async fn get_transitions( &self, issue_key: &IssueKey, expand_options: Option<&str>, ) -> Result<GetTransitionsBody, JiraClientError>

pub async fn post_transition( &self, issue_key: &IssueKey, transition: &PostTransitionBody, ) -> Result<Response, JiraClientError>

pub async fn get_assignable_users( &self, params: &GetAssignableUserParams, ) -> Result<Vec<User>, JiraClientError>

pub async fn post_assign_user( &self, issue_key: &IssueKey, user: &User, ) -> Result<Response, JiraClientError>

pub async fn get_user(&self, user: &str) -> Result<User, JiraClientError>

cloud: user.account_id data-center: user.name

pub async fn get_fields(&self) -> Result<Vec<Field>, JiraClientError>

pub async fn get_filter(&self, id: &str) -> Result<Filter, JiraClientError>

Trait Implementations

impl Clone for JiraAPIClient

fn clone(&self) -> JiraAPIClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JiraAPIClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.