1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
use crate::api::users::UserHandler;
use crate::models::GpgKey;
use crate::{FromResponse, Page};
#[derive(serde::Serialize)]
pub struct UserGpgKeysOpsBuilder<'octo, 'b> {
#[serde(skip)]
handler: &'b UserHandler<'octo>,
#[serde(skip_serializing_if = "Option::is_none")]
per_page: Option<u8>,
#[serde(skip_serializing_if = "Option::is_none")]
page: Option<u32>,
}
impl<'octo, 'b> UserGpgKeysOpsBuilder<'octo, 'b> {
pub(crate) fn new(handler: &'b UserHandler<'octo>) -> Self {
Self {
handler,
per_page: None,
page: None,
}
}
/// Results per page (max 100).
pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
self.per_page = Some(per_page.into());
self
}
/// Page number of the results to fetch.
pub fn page(mut self, page: impl Into<u32>) -> Self {
self.page = Some(page.into());
self
}
///## List GPG keys for the authenticated user
///works with the following token types:
///[GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)
///[Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
///
///The fine-grained token must have the following permission set:
///* "GPG keys" user permissions (read)
///
///```no_run
/// use octocrab::models::GpgKey;
/// use octocrab::{Page, Result};
/// async fn run() -> Result<Page<GpgKey>> {
/// octocrab::instance()
/// .users("current_user")
/// .gpg_keys()
/// .per_page(42).page(3u32)
/// .list()
/// .await
/// }
pub async fn list(&self) -> crate::Result<Page<crate::models::GpgKey>> {
let route = "/user/gpg_keys".to_string();
self.handler.crab.get(route, Some(&self)).await
}
///## View extended details for a single GPG key for the authenticated user
///
///OAuth app tokens and personal access tokens (classic) need the read:gpg_key scope to use this method.
///
///works with the following token types:
///[GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)
///[Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
///
///The fine-grained token must have the following permission set:
///* "GPG keys" user permissions (read)
///
///```no_run
/// use octocrab::models::GpgKey;
/// use octocrab::Result;
/// async fn run() -> Result<GpgKey> {
/// octocrab::instance()
/// .users("current_user")
/// .gpg_keys()
/// .get(42)
/// .await
/// }
pub async fn get(&self, gpg_key_id: u64) -> crate::Result<GpgKey> {
let route = format!("/user/gpg_keys/{gpg_key_id}");
self.handler.crab.get(route, None::<&()>).await
}
///## Create a GPG key for the authenticated user
///works with the following fine-grained token types:
///[GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)
///[Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
///
///The fine-grained token must have the following permission set:
///* "GPG keys" user permissions (write)
///
///```no_run
/// use octocrab::models::GpgKey;
/// use octocrab::Result;
/// async fn run() -> Result<GpgKey> {
/// octocrab::instance()
/// .users("current_user")
/// .gpg_keys()
/// .add("descriptive name".to_string(), "<A GPG key in ASCII-armored format>".to_string())
/// .await
/// }
pub async fn add(&self, name: String, armored_public_key: String) -> crate::Result<GpgKey> {
let route = "/user/gpg_keys".to_string();
let params = serde_json::json!({
"name": name,
"armored_public_key": armored_public_key,
});
let response = self.handler.crab._post(route, Some(¶ms)).await?;
if response.status() != http::StatusCode::CREATED {
return Err(crate::map_github_error(response).await.unwrap_err());
}
<GpgKey>::from_response(crate::map_github_error(response).await?).await
}
///## Delete a GPG key for the authenticated user
///works with the following fine-grained token types:
///[GitHub App user access tokens](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)
///[Fine-grained personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
///
///The fine-grained token must have the following permission set:
///* "GPG keys" user permissions (write)
///
///```no_run
/// use octocrab::Result;
/// async fn run() -> Result<()> {
/// octocrab::instance()
/// .users("current_user")
/// .gpg_keys()
/// .delete(42)
/// .await
/// }
pub async fn delete(&self, gpg_key_id: u64) -> crate::Result<()> {
let route = format!("/user/gpg_keys/{gpg_key_id}");
let response = self.handler.crab._delete(route, None::<&()>).await?;
if response.status() != http::StatusCode::NO_CONTENT {
return Err(crate::map_github_error(response).await.unwrap_err());
}
Ok(())
}
}