stripe_shared/
customer_cash_balance_transaction.rs

1/// Customers with certain payments enabled have a cash balance, representing funds that were paid
2/// by the customer to a merchant, but have not yet been allocated to a payment.
3/// Cash Balance Transactions.
4/// represent when funds are moved into or out of this balance.
5/// This includes funding by the customer, allocation.
6/// to payments, and refunds to the customer.
7///
8/// For more details see <<https://stripe.com/docs/api/cash_balance_transactions/object>>.
9#[derive(Clone, Debug)]
10#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
11pub struct CustomerCashBalanceTransaction {
12pub adjusted_for_overdraft: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft>,
13pub applied_to_payment: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction>,
14    /// Time at which the object was created. Measured in seconds since the Unix epoch.
15pub created: stripe_types::Timestamp,
16        /// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
17    /// Must be a [supported currency](https://stripe.com/docs/currencies).
18pub currency: stripe_types::Currency,
19    /// The customer whose available cash balance changed as a result of this transaction.
20pub customer: stripe_types::Expandable<stripe_shared::Customer>,
21        /// The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.
22pub customer_account: Option<String>,
23        /// The total available cash balance for the specified currency after this transaction was applied.
24    /// Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
25pub ending_balance: i64,
26pub funded: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction>,
27    /// Unique identifier for the object.
28pub id: stripe_shared::CustomerCashBalanceTransactionId,
29        /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
30pub livemode: bool,
31        /// The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
32    /// A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
33pub net_amount: i64,
34pub refunded_from_payment: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction>,
35pub transferred_to_balance: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance>,
36        /// The type of the cash balance transaction.
37    /// New types may be added in future.
38    /// See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types.
39#[cfg_attr(feature = "deserialize", serde(rename = "type"))]
40pub type_: CustomerCashBalanceTransactionType,
41pub unapplied_from_payment: Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction>,
42
43}
44#[doc(hidden)]
45pub struct CustomerCashBalanceTransactionBuilder {
46    adjusted_for_overdraft: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft>>,
47applied_to_payment: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction>>,
48created: Option<stripe_types::Timestamp>,
49currency: Option<stripe_types::Currency>,
50customer: Option<stripe_types::Expandable<stripe_shared::Customer>>,
51customer_account: Option<Option<String>>,
52ending_balance: Option<i64>,
53funded: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction>>,
54id: Option<stripe_shared::CustomerCashBalanceTransactionId>,
55livemode: Option<bool>,
56net_amount: Option<i64>,
57refunded_from_payment: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction>>,
58transferred_to_balance: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance>>,
59type_: Option<CustomerCashBalanceTransactionType>,
60unapplied_from_payment: Option<Option<stripe_shared::CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction>>,
61
62}
63
64#[allow(
65    unused_variables,
66    irrefutable_let_patterns,
67    clippy::let_unit_value,
68    clippy::match_single_binding,
69    clippy::single_match
70)]
71const _: () = {
72    use miniserde::de::{Map, Visitor};
73    use miniserde::json::Value;
74    use miniserde::{Deserialize, Result, make_place};
75    use stripe_types::miniserde_helpers::FromValueOpt;
76    use stripe_types::{MapBuilder, ObjectDeser};
77
78    make_place!(Place);
79
80    impl Deserialize for CustomerCashBalanceTransaction {
81        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
82            Place::new(out)
83        }
84    }
85
86    struct Builder<'a> {
87        out: &'a mut Option<CustomerCashBalanceTransaction>,
88        builder: CustomerCashBalanceTransactionBuilder,
89    }
90
91    impl Visitor for Place<CustomerCashBalanceTransaction> {
92        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
93            Ok(Box::new(Builder {
94                out: &mut self.out,
95                builder: CustomerCashBalanceTransactionBuilder::deser_default(),
96            }))
97        }
98    }
99
100    impl MapBuilder for CustomerCashBalanceTransactionBuilder {
101        type Out = CustomerCashBalanceTransaction;
102        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
103            Ok(match k {
104                "adjusted_for_overdraft" => Deserialize::begin(&mut self.adjusted_for_overdraft),
105                "applied_to_payment" => Deserialize::begin(&mut self.applied_to_payment),
106                "created" => Deserialize::begin(&mut self.created),
107                "currency" => Deserialize::begin(&mut self.currency),
108                "customer" => Deserialize::begin(&mut self.customer),
109                "customer_account" => Deserialize::begin(&mut self.customer_account),
110                "ending_balance" => Deserialize::begin(&mut self.ending_balance),
111                "funded" => Deserialize::begin(&mut self.funded),
112                "id" => Deserialize::begin(&mut self.id),
113                "livemode" => Deserialize::begin(&mut self.livemode),
114                "net_amount" => Deserialize::begin(&mut self.net_amount),
115                "refunded_from_payment" => Deserialize::begin(&mut self.refunded_from_payment),
116                "transferred_to_balance" => Deserialize::begin(&mut self.transferred_to_balance),
117                "type" => Deserialize::begin(&mut self.type_),
118                "unapplied_from_payment" => Deserialize::begin(&mut self.unapplied_from_payment),
119                _ => <dyn Visitor>::ignore(),
120            })
121        }
122
123        fn deser_default() -> Self {
124            Self {
125                adjusted_for_overdraft: Deserialize::default(),
126                applied_to_payment: Deserialize::default(),
127                created: Deserialize::default(),
128                currency: Deserialize::default(),
129                customer: Deserialize::default(),
130                customer_account: Deserialize::default(),
131                ending_balance: Deserialize::default(),
132                funded: Deserialize::default(),
133                id: Deserialize::default(),
134                livemode: Deserialize::default(),
135                net_amount: Deserialize::default(),
136                refunded_from_payment: Deserialize::default(),
137                transferred_to_balance: Deserialize::default(),
138                type_: Deserialize::default(),
139                unapplied_from_payment: Deserialize::default(),
140            }
141        }
142
143        fn take_out(&mut self) -> Option<Self::Out> {
144            let (
145                Some(adjusted_for_overdraft),
146                Some(applied_to_payment),
147                Some(created),
148                Some(currency),
149                Some(customer),
150                Some(customer_account),
151                Some(ending_balance),
152                Some(funded),
153                Some(id),
154                Some(livemode),
155                Some(net_amount),
156                Some(refunded_from_payment),
157                Some(transferred_to_balance),
158                Some(type_),
159                Some(unapplied_from_payment),
160            ) = (
161                self.adjusted_for_overdraft.take(),
162                self.applied_to_payment.take(),
163                self.created,
164                self.currency.take(),
165                self.customer.take(),
166                self.customer_account.take(),
167                self.ending_balance,
168                self.funded.take(),
169                self.id.take(),
170                self.livemode,
171                self.net_amount,
172                self.refunded_from_payment.take(),
173                self.transferred_to_balance.take(),
174                self.type_.take(),
175                self.unapplied_from_payment.take(),
176            )
177            else {
178                return None;
179            };
180            Some(Self::Out {
181                adjusted_for_overdraft,
182                applied_to_payment,
183                created,
184                currency,
185                customer,
186                customer_account,
187                ending_balance,
188                funded,
189                id,
190                livemode,
191                net_amount,
192                refunded_from_payment,
193                transferred_to_balance,
194                type_,
195                unapplied_from_payment,
196            })
197        }
198    }
199
200    impl Map for Builder<'_> {
201        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
202            self.builder.key(k)
203        }
204
205        fn finish(&mut self) -> Result<()> {
206            *self.out = self.builder.take_out();
207            Ok(())
208        }
209    }
210
211    impl ObjectDeser for CustomerCashBalanceTransaction {
212        type Builder = CustomerCashBalanceTransactionBuilder;
213    }
214
215    impl FromValueOpt for CustomerCashBalanceTransaction {
216        fn from_value(v: Value) -> Option<Self> {
217            let Value::Object(obj) = v else {
218                return None;
219            };
220            let mut b = CustomerCashBalanceTransactionBuilder::deser_default();
221            for (k, v) in obj {
222                match k.as_str() {
223                    "adjusted_for_overdraft" => {
224                        b.adjusted_for_overdraft = FromValueOpt::from_value(v)
225                    }
226                    "applied_to_payment" => b.applied_to_payment = FromValueOpt::from_value(v),
227                    "created" => b.created = FromValueOpt::from_value(v),
228                    "currency" => b.currency = FromValueOpt::from_value(v),
229                    "customer" => b.customer = FromValueOpt::from_value(v),
230                    "customer_account" => b.customer_account = FromValueOpt::from_value(v),
231                    "ending_balance" => b.ending_balance = FromValueOpt::from_value(v),
232                    "funded" => b.funded = FromValueOpt::from_value(v),
233                    "id" => b.id = FromValueOpt::from_value(v),
234                    "livemode" => b.livemode = FromValueOpt::from_value(v),
235                    "net_amount" => b.net_amount = FromValueOpt::from_value(v),
236                    "refunded_from_payment" => {
237                        b.refunded_from_payment = FromValueOpt::from_value(v)
238                    }
239                    "transferred_to_balance" => {
240                        b.transferred_to_balance = FromValueOpt::from_value(v)
241                    }
242                    "type" => b.type_ = FromValueOpt::from_value(v),
243                    "unapplied_from_payment" => {
244                        b.unapplied_from_payment = FromValueOpt::from_value(v)
245                    }
246                    _ => {}
247                }
248            }
249            b.take_out()
250        }
251    }
252};
253#[cfg(feature = "serialize")]
254impl serde::Serialize for CustomerCashBalanceTransaction {
255    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
256        use serde::ser::SerializeStruct;
257        let mut s = s.serialize_struct("CustomerCashBalanceTransaction", 16)?;
258        s.serialize_field("adjusted_for_overdraft", &self.adjusted_for_overdraft)?;
259        s.serialize_field("applied_to_payment", &self.applied_to_payment)?;
260        s.serialize_field("created", &self.created)?;
261        s.serialize_field("currency", &self.currency)?;
262        s.serialize_field("customer", &self.customer)?;
263        s.serialize_field("customer_account", &self.customer_account)?;
264        s.serialize_field("ending_balance", &self.ending_balance)?;
265        s.serialize_field("funded", &self.funded)?;
266        s.serialize_field("id", &self.id)?;
267        s.serialize_field("livemode", &self.livemode)?;
268        s.serialize_field("net_amount", &self.net_amount)?;
269        s.serialize_field("refunded_from_payment", &self.refunded_from_payment)?;
270        s.serialize_field("transferred_to_balance", &self.transferred_to_balance)?;
271        s.serialize_field("type", &self.type_)?;
272        s.serialize_field("unapplied_from_payment", &self.unapplied_from_payment)?;
273
274        s.serialize_field("object", "customer_cash_balance_transaction")?;
275        s.end()
276    }
277}
278/// The type of the cash balance transaction.
279/// New types may be added in future.
280/// See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types.
281#[derive(Clone, Eq, PartialEq)]
282#[non_exhaustive]
283pub enum CustomerCashBalanceTransactionType {
284    AdjustedForOverdraft,
285    AppliedToPayment,
286    Funded,
287    FundingReversed,
288    RefundedFromPayment,
289    ReturnCanceled,
290    ReturnInitiated,
291    TransferredToBalance,
292    UnappliedFromPayment,
293    /// An unrecognized value from Stripe. Should not be used as a request parameter.
294    Unknown(String),
295}
296impl CustomerCashBalanceTransactionType {
297    pub fn as_str(&self) -> &str {
298        use CustomerCashBalanceTransactionType::*;
299        match self {
300            AdjustedForOverdraft => "adjusted_for_overdraft",
301            AppliedToPayment => "applied_to_payment",
302            Funded => "funded",
303            FundingReversed => "funding_reversed",
304            RefundedFromPayment => "refunded_from_payment",
305            ReturnCanceled => "return_canceled",
306            ReturnInitiated => "return_initiated",
307            TransferredToBalance => "transferred_to_balance",
308            UnappliedFromPayment => "unapplied_from_payment",
309            Unknown(v) => v,
310        }
311    }
312}
313
314impl std::str::FromStr for CustomerCashBalanceTransactionType {
315    type Err = std::convert::Infallible;
316    fn from_str(s: &str) -> Result<Self, Self::Err> {
317        use CustomerCashBalanceTransactionType::*;
318        match s {
319            "adjusted_for_overdraft" => Ok(AdjustedForOverdraft),
320            "applied_to_payment" => Ok(AppliedToPayment),
321            "funded" => Ok(Funded),
322            "funding_reversed" => Ok(FundingReversed),
323            "refunded_from_payment" => Ok(RefundedFromPayment),
324            "return_canceled" => Ok(ReturnCanceled),
325            "return_initiated" => Ok(ReturnInitiated),
326            "transferred_to_balance" => Ok(TransferredToBalance),
327            "unapplied_from_payment" => Ok(UnappliedFromPayment),
328            v => {
329                tracing::warn!(
330                    "Unknown value '{}' for enum '{}'",
331                    v,
332                    "CustomerCashBalanceTransactionType"
333                );
334                Ok(Unknown(v.to_owned()))
335            }
336        }
337    }
338}
339impl std::fmt::Display for CustomerCashBalanceTransactionType {
340    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
341        f.write_str(self.as_str())
342    }
343}
344
345impl std::fmt::Debug for CustomerCashBalanceTransactionType {
346    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
347        f.write_str(self.as_str())
348    }
349}
350#[cfg(feature = "serialize")]
351impl serde::Serialize for CustomerCashBalanceTransactionType {
352    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
353    where
354        S: serde::Serializer,
355    {
356        serializer.serialize_str(self.as_str())
357    }
358}
359impl miniserde::Deserialize for CustomerCashBalanceTransactionType {
360    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
361        crate::Place::new(out)
362    }
363}
364
365impl miniserde::de::Visitor for crate::Place<CustomerCashBalanceTransactionType> {
366    fn string(&mut self, s: &str) -> miniserde::Result<()> {
367        use std::str::FromStr;
368        self.out = Some(CustomerCashBalanceTransactionType::from_str(s).expect("infallible"));
369        Ok(())
370    }
371}
372
373stripe_types::impl_from_val_with_from_str!(CustomerCashBalanceTransactionType);
374#[cfg(feature = "deserialize")]
375impl<'de> serde::Deserialize<'de> for CustomerCashBalanceTransactionType {
376    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
377        use std::str::FromStr;
378        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
379        Ok(Self::from_str(&s).expect("infallible"))
380    }
381}
382impl stripe_types::Object for CustomerCashBalanceTransaction {
383    type Id = stripe_shared::CustomerCashBalanceTransactionId;
384    fn id(&self) -> &Self::Id {
385        &self.id
386    }
387
388    fn into_id(self) -> Self::Id {
389        self.id
390    }
391}
392stripe_types::def_id!(CustomerCashBalanceTransactionId);
stripe_shared/customer_cash_balance_transaction.rs

stripe_shared/
customer_cash_balance_transaction.rs
