jira_api_v2/apis/
issue_votes_api.rs

1/*
2 * The Jira Cloud platform REST API
3 *
4 * Jira Cloud platform REST API documentation
5 *
6 * The version of the OpenAPI document: 1001.0.0-SNAPSHOT
7 * Contact: ecosystem@atlassian.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13use serde::{Deserialize, Serialize};
14use crate::{apis::ResponseContent, models};
15use super::{Error, configuration};
16
17
18/// struct for typed errors of method [`add_vote`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum AddVoteError {
22    Status401(),
23    Status404(),
24    UnknownValue(serde_json::Value),
25}
26
27/// struct for typed errors of method [`get_votes`]
28#[derive(Debug, Clone, Serialize, Deserialize)]
29#[serde(untagged)]
30pub enum GetVotesError {
31    Status401(),
32    Status404(),
33    UnknownValue(serde_json::Value),
34}
35
36/// struct for typed errors of method [`remove_vote`]
37#[derive(Debug, Clone, Serialize, Deserialize)]
38#[serde(untagged)]
39pub enum RemoveVoteError {
40    Status401(),
41    Status404(),
42    UnknownValue(serde_json::Value),
43}
44
45
46/// Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira.  This operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.  **[Permissions](#permissions) required:**   *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
47pub async fn add_vote(configuration: &configuration::Configuration, issue_id_or_key: &str) -> Result<serde_json::Value, Error<AddVoteError>> {
48    // add a prefix to parameters to efficiently prevent name collisions
49    let p_issue_id_or_key = issue_id_or_key;
50
51    let uri_str = format!("{}/rest/api/2/issue/{issueIdOrKey}/votes", configuration.base_path, issueIdOrKey=crate::apis::urlencode(p_issue_id_or_key));
52    let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
53
54    if let Some(ref user_agent) = configuration.user_agent {
55        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
56    }
57    if let Some(ref token) = configuration.oauth_access_token {
58        req_builder = req_builder.bearer_auth(token.to_owned());
59    };
60    if let Some(ref auth_conf) = configuration.basic_auth {
61        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
62    };
63
64    let req = req_builder.build()?;
65    let resp = configuration.client.execute(req).await?;
66
67    let status = resp.status();
68
69    if !status.is_client_error() && !status.is_server_error() {
70        let content = resp.text().await?;
71        serde_json::from_str(&content).map_err(Error::from)
72    } else {
73        let content = resp.text().await?;
74        let entity: Option<AddVoteError> = serde_json::from_str(&content).ok();
75        Err(Error::ResponseError(ResponseContent { status, content, entity }))
76    }
77}
78
79/// Returns details about the votes on an issue.  This operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.  This operation can be accessed anonymously.  **[Permissions](#permissions) required:**   *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.  Note that users with the necessary permissions for this operation but without the *View voters and watchers* project permissions are not returned details in the `voters` field.
80pub async fn get_votes(configuration: &configuration::Configuration, issue_id_or_key: &str) -> Result<models::Votes, Error<GetVotesError>> {
81    // add a prefix to parameters to efficiently prevent name collisions
82    let p_issue_id_or_key = issue_id_or_key;
83
84    let uri_str = format!("{}/rest/api/2/issue/{issueIdOrKey}/votes", configuration.base_path, issueIdOrKey=crate::apis::urlencode(p_issue_id_or_key));
85    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
86
87    if let Some(ref user_agent) = configuration.user_agent {
88        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
89    }
90    if let Some(ref token) = configuration.oauth_access_token {
91        req_builder = req_builder.bearer_auth(token.to_owned());
92    };
93    if let Some(ref auth_conf) = configuration.basic_auth {
94        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
95    };
96
97    let req = req_builder.build()?;
98    let resp = configuration.client.execute(req).await?;
99
100    let status = resp.status();
101
102    if !status.is_client_error() && !status.is_server_error() {
103        let content = resp.text().await?;
104        serde_json::from_str(&content).map_err(Error::from)
105    } else {
106        let content = resp.text().await?;
107        let entity: Option<GetVotesError> = serde_json::from_str(&content).ok();
108        Err(Error::ResponseError(ResponseContent { status, content, entity }))
109    }
110}
111
112/// Deletes a user's vote from an issue. This is the equivalent of the user clicking *Unvote* on an issue in Jira.  This operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.  **[Permissions](#permissions) required:**   *  *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
113pub async fn remove_vote(configuration: &configuration::Configuration, issue_id_or_key: &str) -> Result<(), Error<RemoveVoteError>> {
114    // add a prefix to parameters to efficiently prevent name collisions
115    let p_issue_id_or_key = issue_id_or_key;
116
117    let uri_str = format!("{}/rest/api/2/issue/{issueIdOrKey}/votes", configuration.base_path, issueIdOrKey=crate::apis::urlencode(p_issue_id_or_key));
118    let mut req_builder = configuration.client.request(reqwest::Method::DELETE, &uri_str);
119
120    if let Some(ref user_agent) = configuration.user_agent {
121        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
122    }
123    if let Some(ref token) = configuration.oauth_access_token {
124        req_builder = req_builder.bearer_auth(token.to_owned());
125    };
126    if let Some(ref auth_conf) = configuration.basic_auth {
127        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
128    };
129
130    let req = req_builder.build()?;
131    let resp = configuration.client.execute(req).await?;
132
133    let status = resp.status();
134
135    if !status.is_client_error() && !status.is_server_error() {
136        Ok(())
137    } else {
138        let content = resp.text().await?;
139        let entity: Option<RemoveVoteError> = serde_json::from_str(&content).ok();
140        Err(Error::ResponseError(ResponseContent { status, content, entity }))
141    }
142}
143
jira_api_v2/apis/issue_votes_api.rs

jira_api_v2/apis/
issue_votes_api.rs
