Skip to main content

stripe_shared/
mandate_pix.rs

1#[derive(Clone, Eq, PartialEq)]
2#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
3#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
4#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
5pub struct MandatePix {
6    /// Determines if the amount includes the IOF tax.
7    pub amount_includes_iof: Option<MandatePixAmountIncludesIof>,
8    /// Type of amount.
9    pub amount_type: Option<MandatePixAmountType>,
10    /// Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
11    pub end_date: Option<String>,
12    /// Schedule at which the future payments will be charged.
13    pub payment_schedule: Option<MandatePixPaymentSchedule>,
14    /// Subscription name displayed to buyers in their bank app.
15    pub reference: Option<String>,
16    /// Start date of the mandate, in `YYYY-MM-DD`.
17    pub start_date: Option<String>,
18}
19#[cfg(feature = "redact-generated-debug")]
20impl std::fmt::Debug for MandatePix {
21    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
22        f.debug_struct("MandatePix").finish_non_exhaustive()
23    }
24}
25#[doc(hidden)]
26pub struct MandatePixBuilder {
27    amount_includes_iof: Option<Option<MandatePixAmountIncludesIof>>,
28    amount_type: Option<Option<MandatePixAmountType>>,
29    end_date: Option<Option<String>>,
30    payment_schedule: Option<Option<MandatePixPaymentSchedule>>,
31    reference: Option<Option<String>>,
32    start_date: Option<Option<String>>,
33}
34
35#[allow(
36    unused_variables,
37    irrefutable_let_patterns,
38    clippy::let_unit_value,
39    clippy::match_single_binding,
40    clippy::single_match
41)]
42const _: () = {
43    use miniserde::de::{Map, Visitor};
44    use miniserde::json::Value;
45    use miniserde::{Deserialize, Result, make_place};
46    use stripe_types::miniserde_helpers::FromValueOpt;
47    use stripe_types::{MapBuilder, ObjectDeser};
48
49    make_place!(Place);
50
51    impl Deserialize for MandatePix {
52        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
53            Place::new(out)
54        }
55    }
56
57    struct Builder<'a> {
58        out: &'a mut Option<MandatePix>,
59        builder: MandatePixBuilder,
60    }
61
62    impl Visitor for Place<MandatePix> {
63        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
64            Ok(Box::new(Builder {
65                out: &mut self.out,
66                builder: MandatePixBuilder::deser_default(),
67            }))
68        }
69    }
70
71    impl MapBuilder for MandatePixBuilder {
72        type Out = MandatePix;
73        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
74            Ok(match k {
75                "amount_includes_iof" => Deserialize::begin(&mut self.amount_includes_iof),
76                "amount_type" => Deserialize::begin(&mut self.amount_type),
77                "end_date" => Deserialize::begin(&mut self.end_date),
78                "payment_schedule" => Deserialize::begin(&mut self.payment_schedule),
79                "reference" => Deserialize::begin(&mut self.reference),
80                "start_date" => Deserialize::begin(&mut self.start_date),
81                _ => <dyn Visitor>::ignore(),
82            })
83        }
84
85        fn deser_default() -> Self {
86            Self {
87                amount_includes_iof: Some(None),
88                amount_type: Some(None),
89                end_date: Some(None),
90                payment_schedule: Some(None),
91                reference: Some(None),
92                start_date: Some(None),
93            }
94        }
95
96        fn take_out(&mut self) -> Option<Self::Out> {
97            let (
98                Some(amount_includes_iof),
99                Some(amount_type),
100                Some(end_date),
101                Some(payment_schedule),
102                Some(reference),
103                Some(start_date),
104            ) = (
105                self.amount_includes_iof.take(),
106                self.amount_type.take(),
107                self.end_date.take(),
108                self.payment_schedule.take(),
109                self.reference.take(),
110                self.start_date.take(),
111            )
112            else {
113                return None;
114            };
115            Some(Self::Out {
116                amount_includes_iof,
117                amount_type,
118                end_date,
119                payment_schedule,
120                reference,
121                start_date,
122            })
123        }
124    }
125
126    impl Map for Builder<'_> {
127        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
128            self.builder.key(k)
129        }
130
131        fn finish(&mut self) -> Result<()> {
132            *self.out = self.builder.take_out();
133            Ok(())
134        }
135    }
136
137    impl ObjectDeser for MandatePix {
138        type Builder = MandatePixBuilder;
139    }
140
141    impl FromValueOpt for MandatePix {
142        fn from_value(v: Value) -> Option<Self> {
143            let Value::Object(obj) = v else {
144                return None;
145            };
146            let mut b = MandatePixBuilder::deser_default();
147            for (k, v) in obj {
148                match k.as_str() {
149                    "amount_includes_iof" => b.amount_includes_iof = FromValueOpt::from_value(v),
150                    "amount_type" => b.amount_type = FromValueOpt::from_value(v),
151                    "end_date" => b.end_date = FromValueOpt::from_value(v),
152                    "payment_schedule" => b.payment_schedule = FromValueOpt::from_value(v),
153                    "reference" => b.reference = FromValueOpt::from_value(v),
154                    "start_date" => b.start_date = FromValueOpt::from_value(v),
155                    _ => {}
156                }
157            }
158            b.take_out()
159        }
160    }
161};
162/// Determines if the amount includes the IOF tax.
163#[derive(Clone, Eq, PartialEq)]
164#[non_exhaustive]
165pub enum MandatePixAmountIncludesIof {
166    Always,
167    Never,
168    /// An unrecognized value from Stripe. Should not be used as a request parameter.
169    Unknown(String),
170}
171impl MandatePixAmountIncludesIof {
172    pub fn as_str(&self) -> &str {
173        use MandatePixAmountIncludesIof::*;
174        match self {
175            Always => "always",
176            Never => "never",
177            Unknown(v) => v,
178        }
179    }
180}
181
182impl std::str::FromStr for MandatePixAmountIncludesIof {
183    type Err = std::convert::Infallible;
184    fn from_str(s: &str) -> Result<Self, Self::Err> {
185        use MandatePixAmountIncludesIof::*;
186        match s {
187            "always" => Ok(Always),
188            "never" => Ok(Never),
189            v => {
190                tracing::warn!(
191                    "Unknown value '{}' for enum '{}'",
192                    v,
193                    "MandatePixAmountIncludesIof"
194                );
195                Ok(Unknown(v.to_owned()))
196            }
197        }
198    }
199}
200impl std::fmt::Display for MandatePixAmountIncludesIof {
201    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
202        f.write_str(self.as_str())
203    }
204}
205
206#[cfg(not(feature = "redact-generated-debug"))]
207impl std::fmt::Debug for MandatePixAmountIncludesIof {
208    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
209        f.write_str(self.as_str())
210    }
211}
212#[cfg(feature = "redact-generated-debug")]
213impl std::fmt::Debug for MandatePixAmountIncludesIof {
214    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
215        f.debug_struct(stringify!(MandatePixAmountIncludesIof)).finish_non_exhaustive()
216    }
217}
218#[cfg(feature = "serialize")]
219impl serde::Serialize for MandatePixAmountIncludesIof {
220    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
221    where
222        S: serde::Serializer,
223    {
224        serializer.serialize_str(self.as_str())
225    }
226}
227impl miniserde::Deserialize for MandatePixAmountIncludesIof {
228    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
229        crate::Place::new(out)
230    }
231}
232
233impl miniserde::de::Visitor for crate::Place<MandatePixAmountIncludesIof> {
234    fn string(&mut self, s: &str) -> miniserde::Result<()> {
235        use std::str::FromStr;
236        self.out = Some(MandatePixAmountIncludesIof::from_str(s).expect("infallible"));
237        Ok(())
238    }
239}
240
241stripe_types::impl_from_val_with_from_str!(MandatePixAmountIncludesIof);
242#[cfg(feature = "deserialize")]
243impl<'de> serde::Deserialize<'de> for MandatePixAmountIncludesIof {
244    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
245        use std::str::FromStr;
246        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
247        Ok(Self::from_str(&s).expect("infallible"))
248    }
249}
250/// Type of amount.
251#[derive(Clone, Eq, PartialEq)]
252#[non_exhaustive]
253pub enum MandatePixAmountType {
254    Fixed,
255    Maximum,
256    /// An unrecognized value from Stripe. Should not be used as a request parameter.
257    Unknown(String),
258}
259impl MandatePixAmountType {
260    pub fn as_str(&self) -> &str {
261        use MandatePixAmountType::*;
262        match self {
263            Fixed => "fixed",
264            Maximum => "maximum",
265            Unknown(v) => v,
266        }
267    }
268}
269
270impl std::str::FromStr for MandatePixAmountType {
271    type Err = std::convert::Infallible;
272    fn from_str(s: &str) -> Result<Self, Self::Err> {
273        use MandatePixAmountType::*;
274        match s {
275            "fixed" => Ok(Fixed),
276            "maximum" => Ok(Maximum),
277            v => {
278                tracing::warn!("Unknown value '{}' for enum '{}'", v, "MandatePixAmountType");
279                Ok(Unknown(v.to_owned()))
280            }
281        }
282    }
283}
284impl std::fmt::Display for MandatePixAmountType {
285    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
286        f.write_str(self.as_str())
287    }
288}
289
290#[cfg(not(feature = "redact-generated-debug"))]
291impl std::fmt::Debug for MandatePixAmountType {
292    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
293        f.write_str(self.as_str())
294    }
295}
296#[cfg(feature = "redact-generated-debug")]
297impl std::fmt::Debug for MandatePixAmountType {
298    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
299        f.debug_struct(stringify!(MandatePixAmountType)).finish_non_exhaustive()
300    }
301}
302#[cfg(feature = "serialize")]
303impl serde::Serialize for MandatePixAmountType {
304    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
305    where
306        S: serde::Serializer,
307    {
308        serializer.serialize_str(self.as_str())
309    }
310}
311impl miniserde::Deserialize for MandatePixAmountType {
312    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
313        crate::Place::new(out)
314    }
315}
316
317impl miniserde::de::Visitor for crate::Place<MandatePixAmountType> {
318    fn string(&mut self, s: &str) -> miniserde::Result<()> {
319        use std::str::FromStr;
320        self.out = Some(MandatePixAmountType::from_str(s).expect("infallible"));
321        Ok(())
322    }
323}
324
325stripe_types::impl_from_val_with_from_str!(MandatePixAmountType);
326#[cfg(feature = "deserialize")]
327impl<'de> serde::Deserialize<'de> for MandatePixAmountType {
328    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
329        use std::str::FromStr;
330        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
331        Ok(Self::from_str(&s).expect("infallible"))
332    }
333}
334/// Schedule at which the future payments will be charged.
335#[derive(Clone, Eq, PartialEq)]
336#[non_exhaustive]
337pub enum MandatePixPaymentSchedule {
338    Halfyearly,
339    Monthly,
340    Quarterly,
341    Weekly,
342    Yearly,
343    /// An unrecognized value from Stripe. Should not be used as a request parameter.
344    Unknown(String),
345}
346impl MandatePixPaymentSchedule {
347    pub fn as_str(&self) -> &str {
348        use MandatePixPaymentSchedule::*;
349        match self {
350            Halfyearly => "halfyearly",
351            Monthly => "monthly",
352            Quarterly => "quarterly",
353            Weekly => "weekly",
354            Yearly => "yearly",
355            Unknown(v) => v,
356        }
357    }
358}
359
360impl std::str::FromStr for MandatePixPaymentSchedule {
361    type Err = std::convert::Infallible;
362    fn from_str(s: &str) -> Result<Self, Self::Err> {
363        use MandatePixPaymentSchedule::*;
364        match s {
365            "halfyearly" => Ok(Halfyearly),
366            "monthly" => Ok(Monthly),
367            "quarterly" => Ok(Quarterly),
368            "weekly" => Ok(Weekly),
369            "yearly" => Ok(Yearly),
370            v => {
371                tracing::warn!("Unknown value '{}' for enum '{}'", v, "MandatePixPaymentSchedule");
372                Ok(Unknown(v.to_owned()))
373            }
374        }
375    }
376}
377impl std::fmt::Display for MandatePixPaymentSchedule {
378    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
379        f.write_str(self.as_str())
380    }
381}
382
383#[cfg(not(feature = "redact-generated-debug"))]
384impl std::fmt::Debug for MandatePixPaymentSchedule {
385    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
386        f.write_str(self.as_str())
387    }
388}
389#[cfg(feature = "redact-generated-debug")]
390impl std::fmt::Debug for MandatePixPaymentSchedule {
391    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
392        f.debug_struct(stringify!(MandatePixPaymentSchedule)).finish_non_exhaustive()
393    }
394}
395#[cfg(feature = "serialize")]
396impl serde::Serialize for MandatePixPaymentSchedule {
397    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
398    where
399        S: serde::Serializer,
400    {
401        serializer.serialize_str(self.as_str())
402    }
403}
404impl miniserde::Deserialize for MandatePixPaymentSchedule {
405    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
406        crate::Place::new(out)
407    }
408}
409
410impl miniserde::de::Visitor for crate::Place<MandatePixPaymentSchedule> {
411    fn string(&mut self, s: &str) -> miniserde::Result<()> {
412        use std::str::FromStr;
413        self.out = Some(MandatePixPaymentSchedule::from_str(s).expect("infallible"));
414        Ok(())
415    }
416}
417
418stripe_types::impl_from_val_with_from_str!(MandatePixPaymentSchedule);
419#[cfg(feature = "deserialize")]
420impl<'de> serde::Deserialize<'de> for MandatePixPaymentSchedule {
421    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
422        use std::str::FromStr;
423        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
424        Ok(Self::from_str(&s).expect("infallible"))
425    }
426}