jira_api_v2/apis/
app_properties_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 [`addon_properties_resource_period_delete_addon_property_delete`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum AddonPropertiesResourcePeriodDeleteAddonPropertyDeleteError {
22    Status400(models::OperationMessage),
23    Status401(models::OperationMessage),
24    Status404(models::OperationMessage),
25    UnknownValue(serde_json::Value),
26}
27
28/// struct for typed errors of method [`addon_properties_resource_period_get_addon_properties_get`]
29#[derive(Debug, Clone, Serialize, Deserialize)]
30#[serde(untagged)]
31pub enum AddonPropertiesResourcePeriodGetAddonPropertiesGetError {
32    Status401(models::OperationMessage),
33    UnknownValue(serde_json::Value),
34}
35
36/// struct for typed errors of method [`addon_properties_resource_period_get_addon_property_get`]
37#[derive(Debug, Clone, Serialize, Deserialize)]
38#[serde(untagged)]
39pub enum AddonPropertiesResourcePeriodGetAddonPropertyGetError {
40    Status400(models::OperationMessage),
41    Status401(models::OperationMessage),
42    Status404(models::OperationMessage),
43    UnknownValue(serde_json::Value),
44}
45
46/// struct for typed errors of method [`addon_properties_resource_period_put_addon_property_put`]
47#[derive(Debug, Clone, Serialize, Deserialize)]
48#[serde(untagged)]
49pub enum AddonPropertiesResourcePeriodPutAddonPropertyPutError {
50    Status400(models::OperationMessage),
51    Status401(models::OperationMessage),
52    UnknownValue(serde_json::Value),
53}
54
55
56/// Deletes an app's property.  **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
57pub async fn addon_properties_resource_period_delete_addon_property_delete(configuration: &configuration::Configuration, addon_key: &str, property_key: &str) -> Result<(), Error<AddonPropertiesResourcePeriodDeleteAddonPropertyDeleteError>> {
58    // add a prefix to parameters to efficiently prevent name collisions
59    let p_addon_key = addon_key;
60    let p_property_key = property_key;
61
62    let uri_str = format!("{}/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}", configuration.base_path, addonKey=crate::apis::urlencode(p_addon_key), propertyKey=crate::apis::urlencode(p_property_key));
63    let mut req_builder = configuration.client.request(reqwest::Method::DELETE, &uri_str);
64
65    if let Some(ref user_agent) = configuration.user_agent {
66        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
67    }
68
69    let req = req_builder.build()?;
70    let resp = configuration.client.execute(req).await?;
71
72    let status = resp.status();
73
74    if !status.is_client_error() && !status.is_server_error() {
75        Ok(())
76    } else {
77        let content = resp.text().await?;
78        let entity: Option<AddonPropertiesResourcePeriodDeleteAddonPropertyDeleteError> = serde_json::from_str(&content).ok();
79        Err(Error::ResponseError(ResponseContent { status, content, entity }))
80    }
81}
82
83/// Gets all the properties of an app.  **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
84pub async fn addon_properties_resource_period_get_addon_properties_get(configuration: &configuration::Configuration, addon_key: &str) -> Result<models::PropertyKeys, Error<AddonPropertiesResourcePeriodGetAddonPropertiesGetError>> {
85    // add a prefix to parameters to efficiently prevent name collisions
86    let p_addon_key = addon_key;
87
88    let uri_str = format!("{}/rest/atlassian-connect/1/addons/{addonKey}/properties", configuration.base_path, addonKey=crate::apis::urlencode(p_addon_key));
89    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
90
91    if let Some(ref user_agent) = configuration.user_agent {
92        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
93    }
94
95    let req = req_builder.build()?;
96    let resp = configuration.client.execute(req).await?;
97
98    let status = resp.status();
99
100    if !status.is_client_error() && !status.is_server_error() {
101        let content = resp.text().await?;
102        serde_json::from_str(&content).map_err(Error::from)
103    } else {
104        let content = resp.text().await?;
105        let entity: Option<AddonPropertiesResourcePeriodGetAddonPropertiesGetError> = serde_json::from_str(&content).ok();
106        Err(Error::ResponseError(ResponseContent { status, content, entity }))
107    }
108}
109
110/// Returns the key and value of an app's property.  **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
111pub async fn addon_properties_resource_period_get_addon_property_get(configuration: &configuration::Configuration, addon_key: &str, property_key: &str) -> Result<models::EntityProperty, Error<AddonPropertiesResourcePeriodGetAddonPropertyGetError>> {
112    // add a prefix to parameters to efficiently prevent name collisions
113    let p_addon_key = addon_key;
114    let p_property_key = property_key;
115
116    let uri_str = format!("{}/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}", configuration.base_path, addonKey=crate::apis::urlencode(p_addon_key), propertyKey=crate::apis::urlencode(p_property_key));
117    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
118
119    if let Some(ref user_agent) = configuration.user_agent {
120        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
121    }
122
123    let req = req_builder.build()?;
124    let resp = configuration.client.execute(req).await?;
125
126    let status = resp.status();
127
128    if !status.is_client_error() && !status.is_server_error() {
129        let content = resp.text().await?;
130        serde_json::from_str(&content).map_err(Error::from)
131    } else {
132        let content = resp.text().await?;
133        let entity: Option<AddonPropertiesResourcePeriodGetAddonPropertyGetError> = serde_json::from_str(&content).ok();
134        Err(Error::ResponseError(ResponseContent { status, content, entity }))
135    }
136}
137
138/// Sets the value of an app's property. Use this resource to store custom data for your app.  The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.  **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
139pub async fn addon_properties_resource_period_put_addon_property_put(configuration: &configuration::Configuration, addon_key: &str, property_key: &str, body: Option<serde_json::Value>) -> Result<models::OperationMessage, Error<AddonPropertiesResourcePeriodPutAddonPropertyPutError>> {
140    // add a prefix to parameters to efficiently prevent name collisions
141    let p_addon_key = addon_key;
142    let p_property_key = property_key;
143    let p_body = body;
144
145    let uri_str = format!("{}/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}", configuration.base_path, addonKey=crate::apis::urlencode(p_addon_key), propertyKey=crate::apis::urlencode(p_property_key));
146    let mut req_builder = configuration.client.request(reqwest::Method::PUT, &uri_str);
147
148    if let Some(ref user_agent) = configuration.user_agent {
149        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
150    }
151    req_builder = req_builder.json(&p_body);
152
153    let req = req_builder.build()?;
154    let resp = configuration.client.execute(req).await?;
155
156    let status = resp.status();
157
158    if !status.is_client_error() && !status.is_server_error() {
159        let content = resp.text().await?;
160        serde_json::from_str(&content).map_err(Error::from)
161    } else {
162        let content = resp.text().await?;
163        let entity: Option<AddonPropertiesResourcePeriodPutAddonPropertyPutError> = serde_json::from_str(&content).ok();
164        Err(Error::ResponseError(ResponseContent { status, content, entity }))
165    }
166}
167
jira_api_v2/apis/app_properties_api.rs

jira_api_v2/apis/
app_properties_api.rs
