stripe_misc/webhook_endpoint/
types.rs

1/// You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be
2/// notified about events that happen in your Stripe account or connected
3/// accounts.
4///
5/// Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
6///
7/// Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)
8///
9/// For more details see <<https://stripe.com/docs/api/webhook_endpoints/object>>.
10#[derive(Clone, Debug)]
11#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
12pub struct WebhookEndpoint {
13    /// The API version events are rendered as for this webhook endpoint.
14    pub api_version: Option<String>,
15    /// The ID of the associated Connect application.
16    pub application: Option<String>,
17    /// Time at which the object was created. Measured in seconds since the Unix epoch.
18    pub created: stripe_types::Timestamp,
19    /// An optional description of what the webhook is used for.
20    pub description: Option<String>,
21    /// The list of events to enable for this endpoint.
22    /// `['*']` indicates that all events are enabled, except those that require explicit selection.
23    pub enabled_events: Vec<String>,
24    /// Unique identifier for the object.
25    pub id: stripe_misc::WebhookEndpointId,
26    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
27    pub livemode: bool,
28    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
29    /// This can be useful for storing additional information about the object in a structured format.
30    pub metadata: std::collections::HashMap<String, String>,
31    /// The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures).
32    /// Only returned at creation.
33    pub secret: Option<String>,
34    /// The status of the webhook. It can be `enabled` or `disabled`.
35    pub status: String,
36    /// The URL of the webhook endpoint.
37    pub url: String,
38}
39#[doc(hidden)]
40pub struct WebhookEndpointBuilder {
41    api_version: Option<Option<String>>,
42    application: Option<Option<String>>,
43    created: Option<stripe_types::Timestamp>,
44    description: Option<Option<String>>,
45    enabled_events: Option<Vec<String>>,
46    id: Option<stripe_misc::WebhookEndpointId>,
47    livemode: Option<bool>,
48    metadata: Option<std::collections::HashMap<String, String>>,
49    secret: Option<Option<String>>,
50    status: Option<String>,
51    url: Option<String>,
52}
53
54#[allow(
55    unused_variables,
56    irrefutable_let_patterns,
57    clippy::let_unit_value,
58    clippy::match_single_binding,
59    clippy::single_match
60)]
61const _: () = {
62    use miniserde::de::{Map, Visitor};
63    use miniserde::json::Value;
64    use miniserde::{Deserialize, Result, make_place};
65    use stripe_types::miniserde_helpers::FromValueOpt;
66    use stripe_types::{MapBuilder, ObjectDeser};
67
68    make_place!(Place);
69
70    impl Deserialize for WebhookEndpoint {
71        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
72            Place::new(out)
73        }
74    }
75
76    struct Builder<'a> {
77        out: &'a mut Option<WebhookEndpoint>,
78        builder: WebhookEndpointBuilder,
79    }
80
81    impl Visitor for Place<WebhookEndpoint> {
82        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
83            Ok(Box::new(Builder {
84                out: &mut self.out,
85                builder: WebhookEndpointBuilder::deser_default(),
86            }))
87        }
88    }
89
90    impl MapBuilder for WebhookEndpointBuilder {
91        type Out = WebhookEndpoint;
92        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
93            Ok(match k {
94                "api_version" => Deserialize::begin(&mut self.api_version),
95                "application" => Deserialize::begin(&mut self.application),
96                "created" => Deserialize::begin(&mut self.created),
97                "description" => Deserialize::begin(&mut self.description),
98                "enabled_events" => Deserialize::begin(&mut self.enabled_events),
99                "id" => Deserialize::begin(&mut self.id),
100                "livemode" => Deserialize::begin(&mut self.livemode),
101                "metadata" => Deserialize::begin(&mut self.metadata),
102                "secret" => Deserialize::begin(&mut self.secret),
103                "status" => Deserialize::begin(&mut self.status),
104                "url" => Deserialize::begin(&mut self.url),
105                _ => <dyn Visitor>::ignore(),
106            })
107        }
108
109        fn deser_default() -> Self {
110            Self {
111                api_version: Deserialize::default(),
112                application: Deserialize::default(),
113                created: Deserialize::default(),
114                description: Deserialize::default(),
115                enabled_events: Deserialize::default(),
116                id: Deserialize::default(),
117                livemode: Deserialize::default(),
118                metadata: Deserialize::default(),
119                secret: Deserialize::default(),
120                status: Deserialize::default(),
121                url: Deserialize::default(),
122            }
123        }
124
125        fn take_out(&mut self) -> Option<Self::Out> {
126            let (
127                Some(api_version),
128                Some(application),
129                Some(created),
130                Some(description),
131                Some(enabled_events),
132                Some(id),
133                Some(livemode),
134                Some(metadata),
135                Some(secret),
136                Some(status),
137                Some(url),
138            ) = (
139                self.api_version.take(),
140                self.application.take(),
141                self.created,
142                self.description.take(),
143                self.enabled_events.take(),
144                self.id.take(),
145                self.livemode,
146                self.metadata.take(),
147                self.secret.take(),
148                self.status.take(),
149                self.url.take(),
150            )
151            else {
152                return None;
153            };
154            Some(Self::Out {
155                api_version,
156                application,
157                created,
158                description,
159                enabled_events,
160                id,
161                livemode,
162                metadata,
163                secret,
164                status,
165                url,
166            })
167        }
168    }
169
170    impl Map for Builder<'_> {
171        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
172            self.builder.key(k)
173        }
174
175        fn finish(&mut self) -> Result<()> {
176            *self.out = self.builder.take_out();
177            Ok(())
178        }
179    }
180
181    impl ObjectDeser for WebhookEndpoint {
182        type Builder = WebhookEndpointBuilder;
183    }
184
185    impl FromValueOpt for WebhookEndpoint {
186        fn from_value(v: Value) -> Option<Self> {
187            let Value::Object(obj) = v else {
188                return None;
189            };
190            let mut b = WebhookEndpointBuilder::deser_default();
191            for (k, v) in obj {
192                match k.as_str() {
193                    "api_version" => b.api_version = FromValueOpt::from_value(v),
194                    "application" => b.application = FromValueOpt::from_value(v),
195                    "created" => b.created = FromValueOpt::from_value(v),
196                    "description" => b.description = FromValueOpt::from_value(v),
197                    "enabled_events" => b.enabled_events = FromValueOpt::from_value(v),
198                    "id" => b.id = FromValueOpt::from_value(v),
199                    "livemode" => b.livemode = FromValueOpt::from_value(v),
200                    "metadata" => b.metadata = FromValueOpt::from_value(v),
201                    "secret" => b.secret = FromValueOpt::from_value(v),
202                    "status" => b.status = FromValueOpt::from_value(v),
203                    "url" => b.url = FromValueOpt::from_value(v),
204                    _ => {}
205                }
206            }
207            b.take_out()
208        }
209    }
210};
211#[cfg(feature = "serialize")]
212impl serde::Serialize for WebhookEndpoint {
213    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
214        use serde::ser::SerializeStruct;
215        let mut s = s.serialize_struct("WebhookEndpoint", 12)?;
216        s.serialize_field("api_version", &self.api_version)?;
217        s.serialize_field("application", &self.application)?;
218        s.serialize_field("created", &self.created)?;
219        s.serialize_field("description", &self.description)?;
220        s.serialize_field("enabled_events", &self.enabled_events)?;
221        s.serialize_field("id", &self.id)?;
222        s.serialize_field("livemode", &self.livemode)?;
223        s.serialize_field("metadata", &self.metadata)?;
224        s.serialize_field("secret", &self.secret)?;
225        s.serialize_field("status", &self.status)?;
226        s.serialize_field("url", &self.url)?;
227
228        s.serialize_field("object", "webhook_endpoint")?;
229        s.end()
230    }
231}
232impl stripe_types::Object for WebhookEndpoint {
233    type Id = stripe_misc::WebhookEndpointId;
234    fn id(&self) -> &Self::Id {
235        &self.id
236    }
237
238    fn into_id(self) -> Self::Id {
239        self.id
240    }
241}
242stripe_types::def_id!(WebhookEndpointId);
stripe_misc/webhook_endpoint/types.rs

stripe_misc/webhook_endpoint/
types.rs
