stripe_core/
balance_settings_resource_payouts.rs

1#[derive(Clone, Debug)]
2#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
3#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
4pub struct BalanceSettingsResourcePayouts {
5    /// The minimum balance amount to retain per currency after automatic payouts.
6    /// Only funds that exceed these amounts are paid out.
7    /// Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
8    pub minimum_balance_by_currency: Option<std::collections::HashMap<String, i64>>,
9    /// Details on when funds from charges are available, and when they are paid out to an external account.
10    /// See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details.
11    pub schedule: Option<stripe_core::BalanceSettingsResourcePayoutSchedule>,
12    /// The text that appears on the bank account statement for payouts.
13    /// If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
14    pub statement_descriptor: Option<String>,
15    /// Whether the funds in this account can be paid out.
16    pub status: BalanceSettingsResourcePayoutsStatus,
17}
18#[doc(hidden)]
19pub struct BalanceSettingsResourcePayoutsBuilder {
20    minimum_balance_by_currency: Option<Option<std::collections::HashMap<String, i64>>>,
21    schedule: Option<Option<stripe_core::BalanceSettingsResourcePayoutSchedule>>,
22    statement_descriptor: Option<Option<String>>,
23    status: Option<BalanceSettingsResourcePayoutsStatus>,
24}
25
26#[allow(
27    unused_variables,
28    irrefutable_let_patterns,
29    clippy::let_unit_value,
30    clippy::match_single_binding,
31    clippy::single_match
32)]
33const _: () = {
34    use miniserde::de::{Map, Visitor};
35    use miniserde::json::Value;
36    use miniserde::{Deserialize, Result, make_place};
37    use stripe_types::miniserde_helpers::FromValueOpt;
38    use stripe_types::{MapBuilder, ObjectDeser};
39
40    make_place!(Place);
41
42    impl Deserialize for BalanceSettingsResourcePayouts {
43        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
44            Place::new(out)
45        }
46    }
47
48    struct Builder<'a> {
49        out: &'a mut Option<BalanceSettingsResourcePayouts>,
50        builder: BalanceSettingsResourcePayoutsBuilder,
51    }
52
53    impl Visitor for Place<BalanceSettingsResourcePayouts> {
54        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
55            Ok(Box::new(Builder {
56                out: &mut self.out,
57                builder: BalanceSettingsResourcePayoutsBuilder::deser_default(),
58            }))
59        }
60    }
61
62    impl MapBuilder for BalanceSettingsResourcePayoutsBuilder {
63        type Out = BalanceSettingsResourcePayouts;
64        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
65            Ok(match k {
66                "minimum_balance_by_currency" => {
67                    Deserialize::begin(&mut self.minimum_balance_by_currency)
68                }
69                "schedule" => Deserialize::begin(&mut self.schedule),
70                "statement_descriptor" => Deserialize::begin(&mut self.statement_descriptor),
71                "status" => Deserialize::begin(&mut self.status),
72                _ => <dyn Visitor>::ignore(),
73            })
74        }
75
76        fn deser_default() -> Self {
77            Self {
78                minimum_balance_by_currency: Deserialize::default(),
79                schedule: Deserialize::default(),
80                statement_descriptor: Deserialize::default(),
81                status: Deserialize::default(),
82            }
83        }
84
85        fn take_out(&mut self) -> Option<Self::Out> {
86            let (
87                Some(minimum_balance_by_currency),
88                Some(schedule),
89                Some(statement_descriptor),
90                Some(status),
91            ) = (
92                self.minimum_balance_by_currency.take(),
93                self.schedule.take(),
94                self.statement_descriptor.take(),
95                self.status.take(),
96            )
97            else {
98                return None;
99            };
100            Some(Self::Out { minimum_balance_by_currency, schedule, statement_descriptor, status })
101        }
102    }
103
104    impl Map for Builder<'_> {
105        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
106            self.builder.key(k)
107        }
108
109        fn finish(&mut self) -> Result<()> {
110            *self.out = self.builder.take_out();
111            Ok(())
112        }
113    }
114
115    impl ObjectDeser for BalanceSettingsResourcePayouts {
116        type Builder = BalanceSettingsResourcePayoutsBuilder;
117    }
118
119    impl FromValueOpt for BalanceSettingsResourcePayouts {
120        fn from_value(v: Value) -> Option<Self> {
121            let Value::Object(obj) = v else {
122                return None;
123            };
124            let mut b = BalanceSettingsResourcePayoutsBuilder::deser_default();
125            for (k, v) in obj {
126                match k.as_str() {
127                    "minimum_balance_by_currency" => {
128                        b.minimum_balance_by_currency = FromValueOpt::from_value(v)
129                    }
130                    "schedule" => b.schedule = FromValueOpt::from_value(v),
131                    "statement_descriptor" => b.statement_descriptor = FromValueOpt::from_value(v),
132                    "status" => b.status = FromValueOpt::from_value(v),
133                    _ => {}
134                }
135            }
136            b.take_out()
137        }
138    }
139};
140/// Whether the funds in this account can be paid out.
141#[derive(Clone, Eq, PartialEq)]
142#[non_exhaustive]
143pub enum BalanceSettingsResourcePayoutsStatus {
144    Disabled,
145    Enabled,
146    /// An unrecognized value from Stripe. Should not be used as a request parameter.
147    Unknown(String),
148}
149impl BalanceSettingsResourcePayoutsStatus {
150    pub fn as_str(&self) -> &str {
151        use BalanceSettingsResourcePayoutsStatus::*;
152        match self {
153            Disabled => "disabled",
154            Enabled => "enabled",
155            Unknown(v) => v,
156        }
157    }
158}
159
160impl std::str::FromStr for BalanceSettingsResourcePayoutsStatus {
161    type Err = std::convert::Infallible;
162    fn from_str(s: &str) -> Result<Self, Self::Err> {
163        use BalanceSettingsResourcePayoutsStatus::*;
164        match s {
165            "disabled" => Ok(Disabled),
166            "enabled" => Ok(Enabled),
167            v => {
168                tracing::warn!(
169                    "Unknown value '{}' for enum '{}'",
170                    v,
171                    "BalanceSettingsResourcePayoutsStatus"
172                );
173                Ok(Unknown(v.to_owned()))
174            }
175        }
176    }
177}
178impl std::fmt::Display for BalanceSettingsResourcePayoutsStatus {
179    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
180        f.write_str(self.as_str())
181    }
182}
183
184impl std::fmt::Debug for BalanceSettingsResourcePayoutsStatus {
185    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
186        f.write_str(self.as_str())
187    }
188}
189#[cfg(feature = "serialize")]
190impl serde::Serialize for BalanceSettingsResourcePayoutsStatus {
191    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
192    where
193        S: serde::Serializer,
194    {
195        serializer.serialize_str(self.as_str())
196    }
197}
198impl miniserde::Deserialize for BalanceSettingsResourcePayoutsStatus {
199    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
200        crate::Place::new(out)
201    }
202}
203
204impl miniserde::de::Visitor for crate::Place<BalanceSettingsResourcePayoutsStatus> {
205    fn string(&mut self, s: &str) -> miniserde::Result<()> {
206        use std::str::FromStr;
207        self.out = Some(BalanceSettingsResourcePayoutsStatus::from_str(s).expect("infallible"));
208        Ok(())
209    }
210}
211
212stripe_types::impl_from_val_with_from_str!(BalanceSettingsResourcePayoutsStatus);
213#[cfg(feature = "deserialize")]
214impl<'de> serde::Deserialize<'de> for BalanceSettingsResourcePayoutsStatus {
215    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
216        use std::str::FromStr;
217        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
218        Ok(Self::from_str(&s).expect("infallible"))
219    }
220}