twilight_http/request/guild/
update_guild_onboarding.rs

1use std::future::IntoFuture;
2
3use twilight_model::{
4    guild::onboarding::{Onboarding, OnboardingMode, OnboardingPromptEmoji, OnboardingPromptType},
5    id::{
6        marker::{
7            ChannelMarker, GuildMarker, OnboardingPromptMarker, OnboardingPromptOptionMarker,
8            RoleMarker,
9        },
10        Id,
11    },
12};
13
14use serde::{Deserialize, Serialize};
15
16use crate::{
17    client::Client,
18    error::Error,
19    request::{self, AuditLogReason, Request, TryIntoRequest},
20    response::{Response, ResponseFuture},
21    routing::Route,
22};
23
24use twilight_validate::request::{audit_reason as validate_audit_reason, ValidationError};
25
26#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
27pub struct UpdateOnboardingPromptOption {
28    pub channel_ids: Vec<Id<ChannelMarker>>,
29    pub description: Option<String>,
30    pub emoji: OnboardingPromptEmoji,
31    #[serde(skip_serializing_if = "Option::is_none")]
32    pub id: Option<Id<OnboardingPromptOptionMarker>>,
33    pub role_ids: Vec<Id<RoleMarker>>,
34    pub title: String,
35}
36
37#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
38pub struct UpdateGuildOnboardingPrompt {
39    pub id: Id<OnboardingPromptMarker>,
40    pub in_onboarding: bool,
41    #[serde(rename = "type")]
42    pub kind: OnboardingPromptType,
43    pub options: Vec<UpdateOnboardingPromptOption>,
44    pub required: bool,
45    pub single_select: bool,
46    pub title: String,
47}
48
49#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
50pub struct UpdateGuildOnboardingFields {
51    pub default_channel_ids: Vec<Id<ChannelMarker>>,
52    pub prompts: Vec<UpdateGuildOnboardingPrompt>,
53    pub enabled: bool,
54    pub mode: OnboardingMode,
55}
56
57/// Update the guild's onboarding flow
58#[must_use = "requests must be configured and executed"]
59pub struct UpdateGuildOnboarding<'a> {
60    fields: UpdateGuildOnboardingFields,
61    guild_id: Id<GuildMarker>,
62    http: &'a Client,
63    reason: Result<Option<&'a str>, ValidationError>,
64}
65
66impl<'a> UpdateGuildOnboarding<'a> {
67    pub(crate) const fn new(
68        http: &'a Client,
69        guild_id: Id<GuildMarker>,
70        fields: UpdateGuildOnboardingFields,
71    ) -> Self {
72        Self {
73            fields,
74            guild_id,
75            http,
76            reason: Ok(None),
77        }
78    }
79}
80
81impl<'a> AuditLogReason<'a> for UpdateGuildOnboarding<'a> {
82    fn reason(mut self, reason: &'a str) -> Self {
83        self.reason = validate_audit_reason(reason).and(Ok(Some(reason)));
84
85        self
86    }
87}
88
89impl IntoFuture for UpdateGuildOnboarding<'_> {
90    type Output = Result<Response<Onboarding>, Error>;
91
92    type IntoFuture = ResponseFuture<Onboarding>;
93
94    fn into_future(self) -> Self::IntoFuture {
95        let http = self.http;
96
97        match self.try_into_request() {
98            Ok(request) => http.request(request),
99            Err(source) => ResponseFuture::error(source),
100        }
101    }
102}
103
104impl TryIntoRequest for UpdateGuildOnboarding<'_> {
105    fn try_into_request(self) -> Result<Request, Error> {
106        let mut request = Request::builder(&Route::UpdateGuildOnboarding {
107            guild_id: self.guild_id.get(),
108        });
109
110        request = request.json(&self.fields);
111
112        if let Some(reason) = self.reason.map_err(Error::validation)? {
113            let header = request::audit_header(reason)?;
114
115            request = request.headers(header);
116        }
117
118        request.build()
119    }
120}
twilight_http/request/guild/update_guild_onboarding.rs

twilight_http/request/guild/
update_guild_onboarding.rs
