dco3 0.20.1

Async API wrapper for DRACOON in Rust.
Documentation 
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

//! This module implements a subset of the DRACOON user API.
//! Documentation can be found here: <https://download.dracoon.com/api/swagger-ui/index.html?configUrl=/api/spec_v4/swagger-config#/user>

use async_trait::async_trait;
use dco3_crypto::PlainUserKeyPairContainer;

pub use self::models::*;
use super::client::errors::DracoonClientError;

pub mod account;
pub mod keypairs;
pub mod models;

#[async_trait]
pub trait User {
    /// Get the user account information.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, User};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    /// let account = dracoon.user().get_user_account().await.unwrap();
    /// # }
    /// ```
    async fn get_user_account(&self) -> Result<UserAccount, DracoonClientError>;
    /// Update the user account information.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, User, user::{UpdateUserAccountRequest}};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    ///
    /// let update = UpdateUserAccountRequest::builder()
    ///                      .with_first_name("Jane")
    ///                      .with_last_name("Doe")
    ///                      .with_email("jane.doe@localhost")
    ///                      .build();
    ///
    /// let account = dracoon.user().update_user_account(update).await.unwrap();
    /// # }
    /// ```  
    async fn update_user_account(
        &self,
        update: UpdateUserAccountRequest,
    ) -> Result<UserAccount, DracoonClientError>;

    /// Get the customer data.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, User};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    /// let customer = dracoon.user().get_customer_info().await.unwrap();
    /// # }
    async fn get_customer_info(&self) -> Result<CustomerData, DracoonClientError>;
}

#[async_trait]
#[allow(clippy::module_name_repetitions)]
pub trait UserAccountKeyPairs {
    /// Get the plain user keypair container.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, UserAccountKeyPairs};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    /// let keypair = dracoon.user().get_user_keypair("secret123").await.unwrap();
    /// // note: you will usually not need the plain keypair since encryption / decryption
    /// // is handled by the dracoon client for up- and downloads.
    /// # }
    /// ```
    async fn get_user_keypair(
        &self,
        secret: &str,
    ) -> Result<PlainUserKeyPairContainer, DracoonClientError>;
    /// Set the user keypair container.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, UserAccountKeyPairs};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    /// dracoon.user().set_user_keypair("Secret123!").await.unwrap();
    /// // note: you need to delete the existing keypair before setting a new one.
    /// # }
    /// ```
    async fn set_user_keypair(&self, secret: &str) -> Result<(), DracoonClientError>;
    /// Delete the user keypair container.
    /// ```no_run
    /// # use dco3::{Dracoon, auth::OAuth2Flow, UserAccountKeyPairs};
    /// # #[tokio::main]
    /// # async fn main() {
    /// # let dracoon = Dracoon::builder()
    /// #  .with_base_url("https://dracoon.team")
    /// #  .with_client_id("client_id")
    /// #  .with_client_secret("client_secret")
    /// #  .build()
    /// #  .unwrap()
    /// #  .connect(OAuth2Flow::PasswordFlow("username".into(), "password".into()))
    /// #  .await
    /// #  .unwrap();
    /// dracoon.user().delete_user_keypair().await.unwrap();
    /// // note: you need to delete the existing keypair before setting a new one.
    /// # }
    /// ```
    async fn delete_user_keypair(&self) -> Result<(), DracoonClientError>;
}