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://stripe.com/docs/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
73                _ => <dyn Visitor>::ignore(),
74            })
75        }
76
77        fn deser_default() -> Self {
78            Self {
79                minimum_balance_by_currency: Deserialize::default(),
80                schedule: Deserialize::default(),
81                statement_descriptor: Deserialize::default(),
82                status: Deserialize::default(),
83            }
84        }
85
86        fn take_out(&mut self) -> Option<Self::Out> {
87            let (
88                Some(minimum_balance_by_currency),
89                Some(schedule),
90                Some(statement_descriptor),
91                Some(status),
92            ) = (
93                self.minimum_balance_by_currency.take(),
94                self.schedule.take(),
95                self.statement_descriptor.take(),
96                self.status,
97            )
98            else {
99                return None;
100            };
101            Some(Self::Out { minimum_balance_by_currency, schedule, statement_descriptor, status })
102        }
103    }
104
105    impl Map for Builder<'_> {
106        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
107            self.builder.key(k)
108        }
109
110        fn finish(&mut self) -> Result<()> {
111            *self.out = self.builder.take_out();
112            Ok(())
113        }
114    }
115
116    impl ObjectDeser for BalanceSettingsResourcePayouts {
117        type Builder = BalanceSettingsResourcePayoutsBuilder;
118    }
119
120    impl FromValueOpt for BalanceSettingsResourcePayouts {
121        fn from_value(v: Value) -> Option<Self> {
122            let Value::Object(obj) = v else {
123                return None;
124            };
125            let mut b = BalanceSettingsResourcePayoutsBuilder::deser_default();
126            for (k, v) in obj {
127                match k.as_str() {
128                    "minimum_balance_by_currency" => {
129                        b.minimum_balance_by_currency = FromValueOpt::from_value(v)
130                    }
131                    "schedule" => b.schedule = FromValueOpt::from_value(v),
132                    "statement_descriptor" => b.statement_descriptor = FromValueOpt::from_value(v),
133                    "status" => b.status = FromValueOpt::from_value(v),
134
135                    _ => {}
136                }
137            }
138            b.take_out()
139        }
140    }
141};
142/// Whether the funds in this account can be paid out.
143#[derive(Copy, Clone, Eq, PartialEq)]
144pub enum BalanceSettingsResourcePayoutsStatus {
145    Disabled,
146    Enabled,
147}
148impl BalanceSettingsResourcePayoutsStatus {
149    pub fn as_str(self) -> &'static str {
150        use BalanceSettingsResourcePayoutsStatus::*;
151        match self {
152            Disabled => "disabled",
153            Enabled => "enabled",
154        }
155    }
156}
157
158impl std::str::FromStr for BalanceSettingsResourcePayoutsStatus {
159    type Err = stripe_types::StripeParseError;
160    fn from_str(s: &str) -> Result<Self, Self::Err> {
161        use BalanceSettingsResourcePayoutsStatus::*;
162        match s {
163            "disabled" => Ok(Disabled),
164            "enabled" => Ok(Enabled),
165            _ => Err(stripe_types::StripeParseError),
166        }
167    }
168}
169impl std::fmt::Display for BalanceSettingsResourcePayoutsStatus {
170    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
171        f.write_str(self.as_str())
172    }
173}
174
175impl std::fmt::Debug for BalanceSettingsResourcePayoutsStatus {
176    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
177        f.write_str(self.as_str())
178    }
179}
180#[cfg(feature = "serialize")]
181impl serde::Serialize for BalanceSettingsResourcePayoutsStatus {
182    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
183    where
184        S: serde::Serializer,
185    {
186        serializer.serialize_str(self.as_str())
187    }
188}
189impl miniserde::Deserialize for BalanceSettingsResourcePayoutsStatus {
190    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
191        crate::Place::new(out)
192    }
193}
194
195impl miniserde::de::Visitor for crate::Place<BalanceSettingsResourcePayoutsStatus> {
196    fn string(&mut self, s: &str) -> miniserde::Result<()> {
197        use std::str::FromStr;
198        self.out =
199            Some(BalanceSettingsResourcePayoutsStatus::from_str(s).map_err(|_| miniserde::Error)?);
200        Ok(())
201    }
202}
203
204stripe_types::impl_from_val_with_from_str!(BalanceSettingsResourcePayoutsStatus);
205#[cfg(feature = "deserialize")]
206impl<'de> serde::Deserialize<'de> for BalanceSettingsResourcePayoutsStatus {
207    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
208        use std::str::FromStr;
209        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
210        Self::from_str(&s).map_err(|_| {
211            serde::de::Error::custom("Unknown value for BalanceSettingsResourcePayoutsStatus")
212        })
213    }
214}