stripe_shared/
cancellation_details.rs

1#[derive(Clone, Debug)]
2#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
3#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
4pub struct CancellationDetails {
5    /// Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
6    pub comment: Option<String>,
7    /// The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
8    pub feedback: Option<CancellationDetailsFeedback>,
9    /// Why this subscription was canceled.
10    pub reason: Option<CancellationDetailsReason>,
11}
12#[doc(hidden)]
13pub struct CancellationDetailsBuilder {
14    comment: Option<Option<String>>,
15    feedback: Option<Option<CancellationDetailsFeedback>>,
16    reason: Option<Option<CancellationDetailsReason>>,
17}
18
19#[allow(
20    unused_variables,
21    irrefutable_let_patterns,
22    clippy::let_unit_value,
23    clippy::match_single_binding,
24    clippy::single_match
25)]
26const _: () = {
27    use miniserde::de::{Map, Visitor};
28    use miniserde::json::Value;
29    use miniserde::{Deserialize, Result, make_place};
30    use stripe_types::miniserde_helpers::FromValueOpt;
31    use stripe_types::{MapBuilder, ObjectDeser};
32
33    make_place!(Place);
34
35    impl Deserialize for CancellationDetails {
36        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
37            Place::new(out)
38        }
39    }
40
41    struct Builder<'a> {
42        out: &'a mut Option<CancellationDetails>,
43        builder: CancellationDetailsBuilder,
44    }
45
46    impl Visitor for Place<CancellationDetails> {
47        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
48            Ok(Box::new(Builder {
49                out: &mut self.out,
50                builder: CancellationDetailsBuilder::deser_default(),
51            }))
52        }
53    }
54
55    impl MapBuilder for CancellationDetailsBuilder {
56        type Out = CancellationDetails;
57        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
58            Ok(match k {
59                "comment" => Deserialize::begin(&mut self.comment),
60                "feedback" => Deserialize::begin(&mut self.feedback),
61                "reason" => Deserialize::begin(&mut self.reason),
62                _ => <dyn Visitor>::ignore(),
63            })
64        }
65
66        fn deser_default() -> Self {
67            Self {
68                comment: Deserialize::default(),
69                feedback: Deserialize::default(),
70                reason: Deserialize::default(),
71            }
72        }
73
74        fn take_out(&mut self) -> Option<Self::Out> {
75            let (Some(comment), Some(feedback), Some(reason)) =
76                (self.comment.take(), self.feedback, self.reason)
77            else {
78                return None;
79            };
80            Some(Self::Out { comment, feedback, reason })
81        }
82    }
83
84    impl Map for Builder<'_> {
85        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
86            self.builder.key(k)
87        }
88
89        fn finish(&mut self) -> Result<()> {
90            *self.out = self.builder.take_out();
91            Ok(())
92        }
93    }
94
95    impl ObjectDeser for CancellationDetails {
96        type Builder = CancellationDetailsBuilder;
97    }
98
99    impl FromValueOpt for CancellationDetails {
100        fn from_value(v: Value) -> Option<Self> {
101            let Value::Object(obj) = v else {
102                return None;
103            };
104            let mut b = CancellationDetailsBuilder::deser_default();
105            for (k, v) in obj {
106                match k.as_str() {
107                    "comment" => b.comment = FromValueOpt::from_value(v),
108                    "feedback" => b.feedback = FromValueOpt::from_value(v),
109                    "reason" => b.reason = FromValueOpt::from_value(v),
110                    _ => {}
111                }
112            }
113            b.take_out()
114        }
115    }
116};
117/// The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
118#[derive(Copy, Clone, Eq, PartialEq)]
119pub enum CancellationDetailsFeedback {
120    CustomerService,
121    LowQuality,
122    MissingFeatures,
123    Other,
124    SwitchedService,
125    TooComplex,
126    TooExpensive,
127    Unused,
128}
129impl CancellationDetailsFeedback {
130    pub fn as_str(self) -> &'static str {
131        use CancellationDetailsFeedback::*;
132        match self {
133            CustomerService => "customer_service",
134            LowQuality => "low_quality",
135            MissingFeatures => "missing_features",
136            Other => "other",
137            SwitchedService => "switched_service",
138            TooComplex => "too_complex",
139            TooExpensive => "too_expensive",
140            Unused => "unused",
141        }
142    }
143}
144
145impl std::str::FromStr for CancellationDetailsFeedback {
146    type Err = stripe_types::StripeParseError;
147    fn from_str(s: &str) -> Result<Self, Self::Err> {
148        use CancellationDetailsFeedback::*;
149        match s {
150            "customer_service" => Ok(CustomerService),
151            "low_quality" => Ok(LowQuality),
152            "missing_features" => Ok(MissingFeatures),
153            "other" => Ok(Other),
154            "switched_service" => Ok(SwitchedService),
155            "too_complex" => Ok(TooComplex),
156            "too_expensive" => Ok(TooExpensive),
157            "unused" => Ok(Unused),
158            _ => Err(stripe_types::StripeParseError),
159        }
160    }
161}
162impl std::fmt::Display for CancellationDetailsFeedback {
163    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
164        f.write_str(self.as_str())
165    }
166}
167
168impl std::fmt::Debug for CancellationDetailsFeedback {
169    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
170        f.write_str(self.as_str())
171    }
172}
173#[cfg(feature = "serialize")]
174impl serde::Serialize for CancellationDetailsFeedback {
175    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
176    where
177        S: serde::Serializer,
178    {
179        serializer.serialize_str(self.as_str())
180    }
181}
182impl miniserde::Deserialize for CancellationDetailsFeedback {
183    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
184        crate::Place::new(out)
185    }
186}
187
188impl miniserde::de::Visitor for crate::Place<CancellationDetailsFeedback> {
189    fn string(&mut self, s: &str) -> miniserde::Result<()> {
190        use std::str::FromStr;
191        self.out = Some(CancellationDetailsFeedback::from_str(s).map_err(|_| miniserde::Error)?);
192        Ok(())
193    }
194}
195
196stripe_types::impl_from_val_with_from_str!(CancellationDetailsFeedback);
197#[cfg(feature = "deserialize")]
198impl<'de> serde::Deserialize<'de> for CancellationDetailsFeedback {
199    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
200        use std::str::FromStr;
201        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
202        Self::from_str(&s)
203            .map_err(|_| serde::de::Error::custom("Unknown value for CancellationDetailsFeedback"))
204    }
205}
206/// Why this subscription was canceled.
207#[derive(Copy, Clone, Eq, PartialEq)]
208pub enum CancellationDetailsReason {
209    CancellationRequested,
210    PaymentDisputed,
211    PaymentFailed,
212}
213impl CancellationDetailsReason {
214    pub fn as_str(self) -> &'static str {
215        use CancellationDetailsReason::*;
216        match self {
217            CancellationRequested => "cancellation_requested",
218            PaymentDisputed => "payment_disputed",
219            PaymentFailed => "payment_failed",
220        }
221    }
222}
223
224impl std::str::FromStr for CancellationDetailsReason {
225    type Err = stripe_types::StripeParseError;
226    fn from_str(s: &str) -> Result<Self, Self::Err> {
227        use CancellationDetailsReason::*;
228        match s {
229            "cancellation_requested" => Ok(CancellationRequested),
230            "payment_disputed" => Ok(PaymentDisputed),
231            "payment_failed" => Ok(PaymentFailed),
232            _ => Err(stripe_types::StripeParseError),
233        }
234    }
235}
236impl std::fmt::Display for CancellationDetailsReason {
237    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
238        f.write_str(self.as_str())
239    }
240}
241
242impl std::fmt::Debug for CancellationDetailsReason {
243    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
244        f.write_str(self.as_str())
245    }
246}
247#[cfg(feature = "serialize")]
248impl serde::Serialize for CancellationDetailsReason {
249    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
250    where
251        S: serde::Serializer,
252    {
253        serializer.serialize_str(self.as_str())
254    }
255}
256impl miniserde::Deserialize for CancellationDetailsReason {
257    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
258        crate::Place::new(out)
259    }
260}
261
262impl miniserde::de::Visitor for crate::Place<CancellationDetailsReason> {
263    fn string(&mut self, s: &str) -> miniserde::Result<()> {
264        use std::str::FromStr;
265        self.out = Some(CancellationDetailsReason::from_str(s).map_err(|_| miniserde::Error)?);
266        Ok(())
267    }
268}
269
270stripe_types::impl_from_val_with_from_str!(CancellationDetailsReason);
271#[cfg(feature = "deserialize")]
272impl<'de> serde::Deserialize<'de> for CancellationDetailsReason {
273    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
274        use std::str::FromStr;
275        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
276        Self::from_str(&s)
277            .map_err(|_| serde::de::Error::custom("Unknown value for CancellationDetailsReason"))
278    }
279}