Skip to main content

stripe_shared/
payment_method_options_boleto.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 PaymentMethodOptionsBoleto {
6    /// The number of calendar days before a Boleto voucher expires.
7    /// For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
8    pub expires_after_days: u32,
9    /// Indicates that you intend to make future payments with this PaymentIntent's payment method.
10    ///
11    /// If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions.
12    /// If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
13    ///
14    /// If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
15    ///
16    /// When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
17    pub setup_future_usage: Option<PaymentMethodOptionsBoletoSetupFutureUsage>,
18}
19#[cfg(feature = "redact-generated-debug")]
20impl std::fmt::Debug for PaymentMethodOptionsBoleto {
21    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
22        f.debug_struct("PaymentMethodOptionsBoleto").finish_non_exhaustive()
23    }
24}
25#[doc(hidden)]
26pub struct PaymentMethodOptionsBoletoBuilder {
27    expires_after_days: Option<u32>,
28    setup_future_usage: Option<Option<PaymentMethodOptionsBoletoSetupFutureUsage>>,
29}
30
31#[allow(
32    unused_variables,
33    irrefutable_let_patterns,
34    clippy::let_unit_value,
35    clippy::match_single_binding,
36    clippy::single_match
37)]
38const _: () = {
39    use miniserde::de::{Map, Visitor};
40    use miniserde::json::Value;
41    use miniserde::{Deserialize, Result, make_place};
42    use stripe_types::miniserde_helpers::FromValueOpt;
43    use stripe_types::{MapBuilder, ObjectDeser};
44
45    make_place!(Place);
46
47    impl Deserialize for PaymentMethodOptionsBoleto {
48        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
49            Place::new(out)
50        }
51    }
52
53    struct Builder<'a> {
54        out: &'a mut Option<PaymentMethodOptionsBoleto>,
55        builder: PaymentMethodOptionsBoletoBuilder,
56    }
57
58    impl Visitor for Place<PaymentMethodOptionsBoleto> {
59        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
60            Ok(Box::new(Builder {
61                out: &mut self.out,
62                builder: PaymentMethodOptionsBoletoBuilder::deser_default(),
63            }))
64        }
65    }
66
67    impl MapBuilder for PaymentMethodOptionsBoletoBuilder {
68        type Out = PaymentMethodOptionsBoleto;
69        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
70            Ok(match k {
71                "expires_after_days" => Deserialize::begin(&mut self.expires_after_days),
72                "setup_future_usage" => Deserialize::begin(&mut self.setup_future_usage),
73                _ => <dyn Visitor>::ignore(),
74            })
75        }
76
77        fn deser_default() -> Self {
78            Self { expires_after_days: None, setup_future_usage: Some(None) }
79        }
80
81        fn take_out(&mut self) -> Option<Self::Out> {
82            let (Some(expires_after_days), Some(setup_future_usage)) =
83                (self.expires_after_days, self.setup_future_usage.take())
84            else {
85                return None;
86            };
87            Some(Self::Out { expires_after_days, setup_future_usage })
88        }
89    }
90
91    impl Map for Builder<'_> {
92        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
93            self.builder.key(k)
94        }
95
96        fn finish(&mut self) -> Result<()> {
97            *self.out = self.builder.take_out();
98            Ok(())
99        }
100    }
101
102    impl ObjectDeser for PaymentMethodOptionsBoleto {
103        type Builder = PaymentMethodOptionsBoletoBuilder;
104    }
105
106    impl FromValueOpt for PaymentMethodOptionsBoleto {
107        fn from_value(v: Value) -> Option<Self> {
108            let Value::Object(obj) = v else {
109                return None;
110            };
111            let mut b = PaymentMethodOptionsBoletoBuilder::deser_default();
112            for (k, v) in obj {
113                match k.as_str() {
114                    "expires_after_days" => b.expires_after_days = FromValueOpt::from_value(v),
115                    "setup_future_usage" => b.setup_future_usage = FromValueOpt::from_value(v),
116                    _ => {}
117                }
118            }
119            b.take_out()
120        }
121    }
122};
123/// Indicates that you intend to make future payments with this PaymentIntent's payment method.
124///
125/// If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions.
126/// If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
127///
128/// If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
129///
130/// When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
131#[derive(Clone, Eq, PartialEq)]
132#[non_exhaustive]
133pub enum PaymentMethodOptionsBoletoSetupFutureUsage {
134    None,
135    OffSession,
136    OnSession,
137    /// An unrecognized value from Stripe. Should not be used as a request parameter.
138    Unknown(String),
139}
140impl PaymentMethodOptionsBoletoSetupFutureUsage {
141    pub fn as_str(&self) -> &str {
142        use PaymentMethodOptionsBoletoSetupFutureUsage::*;
143        match self {
144            None => "none",
145            OffSession => "off_session",
146            OnSession => "on_session",
147            Unknown(v) => v,
148        }
149    }
150}
151
152impl std::str::FromStr for PaymentMethodOptionsBoletoSetupFutureUsage {
153    type Err = std::convert::Infallible;
154    fn from_str(s: &str) -> Result<Self, Self::Err> {
155        use PaymentMethodOptionsBoletoSetupFutureUsage::*;
156        match s {
157            "none" => Ok(None),
158            "off_session" => Ok(OffSession),
159            "on_session" => Ok(OnSession),
160            v => {
161                tracing::warn!(
162                    "Unknown value '{}' for enum '{}'",
163                    v,
164                    "PaymentMethodOptionsBoletoSetupFutureUsage"
165                );
166                Ok(Unknown(v.to_owned()))
167            }
168        }
169    }
170}
171impl std::fmt::Display for PaymentMethodOptionsBoletoSetupFutureUsage {
172    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
173        f.write_str(self.as_str())
174    }
175}
176
177#[cfg(not(feature = "redact-generated-debug"))]
178impl std::fmt::Debug for PaymentMethodOptionsBoletoSetupFutureUsage {
179    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
180        f.write_str(self.as_str())
181    }
182}
183#[cfg(feature = "redact-generated-debug")]
184impl std::fmt::Debug for PaymentMethodOptionsBoletoSetupFutureUsage {
185    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
186        f.debug_struct(stringify!(PaymentMethodOptionsBoletoSetupFutureUsage))
187            .finish_non_exhaustive()
188    }
189}
190#[cfg(feature = "serialize")]
191impl serde::Serialize for PaymentMethodOptionsBoletoSetupFutureUsage {
192    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
193    where
194        S: serde::Serializer,
195    {
196        serializer.serialize_str(self.as_str())
197    }
198}
199impl miniserde::Deserialize for PaymentMethodOptionsBoletoSetupFutureUsage {
200    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
201        crate::Place::new(out)
202    }
203}
204
205impl miniserde::de::Visitor for crate::Place<PaymentMethodOptionsBoletoSetupFutureUsage> {
206    fn string(&mut self, s: &str) -> miniserde::Result<()> {
207        use std::str::FromStr;
208        self.out =
209            Some(PaymentMethodOptionsBoletoSetupFutureUsage::from_str(s).expect("infallible"));
210        Ok(())
211    }
212}
213
214stripe_types::impl_from_val_with_from_str!(PaymentMethodOptionsBoletoSetupFutureUsage);
215#[cfg(feature = "deserialize")]
216impl<'de> serde::Deserialize<'de> for PaymentMethodOptionsBoletoSetupFutureUsage {
217    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
218        use std::str::FromStr;
219        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
220        Ok(Self::from_str(&s).expect("infallible"))
221    }
222}