stripe_shared/
billing_credit_balance_transaction.rs

1/// A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
2#[derive(Clone, Debug)]
3#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
4pub struct BillingCreditBalanceTransaction {
5    /// Time at which the object was created. Measured in seconds since the Unix epoch.
6    pub created: stripe_types::Timestamp,
7    /// Credit details for this credit balance transaction. Only present if type is `credit`.
8    pub credit: Option<stripe_shared::BillingCreditGrantsResourceBalanceCredit>,
9    /// The credit grant associated with this credit balance transaction.
10    pub credit_grant: stripe_types::Expandable<stripe_shared::BillingCreditGrant>,
11    /// Debit details for this credit balance transaction. Only present if type is `debit`.
12    pub debit: Option<stripe_shared::BillingCreditGrantsResourceBalanceDebit>,
13    /// The effective time of this credit balance transaction.
14    pub effective_at: stripe_types::Timestamp,
15    /// Unique identifier for the object.
16    pub id: stripe_shared::BillingCreditBalanceTransactionId,
17    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
18    pub livemode: bool,
19    /// ID of the test clock this credit balance transaction belongs to.
20    pub test_clock: Option<stripe_types::Expandable<stripe_shared::TestHelpersTestClock>>,
21    /// The type of credit balance transaction (credit or debit).
22    #[cfg_attr(feature = "deserialize", serde(rename = "type"))]
23    pub type_: Option<BillingCreditBalanceTransactionType>,
24}
25#[doc(hidden)]
26pub struct BillingCreditBalanceTransactionBuilder {
27    created: Option<stripe_types::Timestamp>,
28    credit: Option<Option<stripe_shared::BillingCreditGrantsResourceBalanceCredit>>,
29    credit_grant: Option<stripe_types::Expandable<stripe_shared::BillingCreditGrant>>,
30    debit: Option<Option<stripe_shared::BillingCreditGrantsResourceBalanceDebit>>,
31    effective_at: Option<stripe_types::Timestamp>,
32    id: Option<stripe_shared::BillingCreditBalanceTransactionId>,
33    livemode: Option<bool>,
34    test_clock: Option<Option<stripe_types::Expandable<stripe_shared::TestHelpersTestClock>>>,
35    type_: Option<Option<BillingCreditBalanceTransactionType>>,
36}
37
38#[allow(
39    unused_variables,
40    irrefutable_let_patterns,
41    clippy::let_unit_value,
42    clippy::match_single_binding,
43    clippy::single_match
44)]
45const _: () = {
46    use miniserde::de::{Map, Visitor};
47    use miniserde::json::Value;
48    use miniserde::{Deserialize, Result, make_place};
49    use stripe_types::miniserde_helpers::FromValueOpt;
50    use stripe_types::{MapBuilder, ObjectDeser};
51
52    make_place!(Place);
53
54    impl Deserialize for BillingCreditBalanceTransaction {
55        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
56            Place::new(out)
57        }
58    }
59
60    struct Builder<'a> {
61        out: &'a mut Option<BillingCreditBalanceTransaction>,
62        builder: BillingCreditBalanceTransactionBuilder,
63    }
64
65    impl Visitor for Place<BillingCreditBalanceTransaction> {
66        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
67            Ok(Box::new(Builder {
68                out: &mut self.out,
69                builder: BillingCreditBalanceTransactionBuilder::deser_default(),
70            }))
71        }
72    }
73
74    impl MapBuilder for BillingCreditBalanceTransactionBuilder {
75        type Out = BillingCreditBalanceTransaction;
76        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
77            Ok(match k {
78                "created" => Deserialize::begin(&mut self.created),
79                "credit" => Deserialize::begin(&mut self.credit),
80                "credit_grant" => Deserialize::begin(&mut self.credit_grant),
81                "debit" => Deserialize::begin(&mut self.debit),
82                "effective_at" => Deserialize::begin(&mut self.effective_at),
83                "id" => Deserialize::begin(&mut self.id),
84                "livemode" => Deserialize::begin(&mut self.livemode),
85                "test_clock" => Deserialize::begin(&mut self.test_clock),
86                "type" => Deserialize::begin(&mut self.type_),
87
88                _ => <dyn Visitor>::ignore(),
89            })
90        }
91
92        fn deser_default() -> Self {
93            Self {
94                created: Deserialize::default(),
95                credit: Deserialize::default(),
96                credit_grant: Deserialize::default(),
97                debit: Deserialize::default(),
98                effective_at: Deserialize::default(),
99                id: Deserialize::default(),
100                livemode: Deserialize::default(),
101                test_clock: Deserialize::default(),
102                type_: Deserialize::default(),
103            }
104        }
105
106        fn take_out(&mut self) -> Option<Self::Out> {
107            let (
108                Some(created),
109                Some(credit),
110                Some(credit_grant),
111                Some(debit),
112                Some(effective_at),
113                Some(id),
114                Some(livemode),
115                Some(test_clock),
116                Some(type_),
117            ) = (
118                self.created,
119                self.credit.take(),
120                self.credit_grant.take(),
121                self.debit.take(),
122                self.effective_at,
123                self.id.take(),
124                self.livemode,
125                self.test_clock.take(),
126                self.type_,
127            )
128            else {
129                return None;
130            };
131            Some(Self::Out {
132                created,
133                credit,
134                credit_grant,
135                debit,
136                effective_at,
137                id,
138                livemode,
139                test_clock,
140                type_,
141            })
142        }
143    }
144
145    impl Map for Builder<'_> {
146        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
147            self.builder.key(k)
148        }
149
150        fn finish(&mut self) -> Result<()> {
151            *self.out = self.builder.take_out();
152            Ok(())
153        }
154    }
155
156    impl ObjectDeser for BillingCreditBalanceTransaction {
157        type Builder = BillingCreditBalanceTransactionBuilder;
158    }
159
160    impl FromValueOpt for BillingCreditBalanceTransaction {
161        fn from_value(v: Value) -> Option<Self> {
162            let Value::Object(obj) = v else {
163                return None;
164            };
165            let mut b = BillingCreditBalanceTransactionBuilder::deser_default();
166            for (k, v) in obj {
167                match k.as_str() {
168                    "created" => b.created = FromValueOpt::from_value(v),
169                    "credit" => b.credit = FromValueOpt::from_value(v),
170                    "credit_grant" => b.credit_grant = FromValueOpt::from_value(v),
171                    "debit" => b.debit = FromValueOpt::from_value(v),
172                    "effective_at" => b.effective_at = FromValueOpt::from_value(v),
173                    "id" => b.id = FromValueOpt::from_value(v),
174                    "livemode" => b.livemode = FromValueOpt::from_value(v),
175                    "test_clock" => b.test_clock = FromValueOpt::from_value(v),
176                    "type" => b.type_ = FromValueOpt::from_value(v),
177
178                    _ => {}
179                }
180            }
181            b.take_out()
182        }
183    }
184};
185#[cfg(feature = "serialize")]
186impl serde::Serialize for BillingCreditBalanceTransaction {
187    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
188        use serde::ser::SerializeStruct;
189        let mut s = s.serialize_struct("BillingCreditBalanceTransaction", 10)?;
190        s.serialize_field("created", &self.created)?;
191        s.serialize_field("credit", &self.credit)?;
192        s.serialize_field("credit_grant", &self.credit_grant)?;
193        s.serialize_field("debit", &self.debit)?;
194        s.serialize_field("effective_at", &self.effective_at)?;
195        s.serialize_field("id", &self.id)?;
196        s.serialize_field("livemode", &self.livemode)?;
197        s.serialize_field("test_clock", &self.test_clock)?;
198        s.serialize_field("type", &self.type_)?;
199
200        s.serialize_field("object", "billing.credit_balance_transaction")?;
201        s.end()
202    }
203}
204/// The type of credit balance transaction (credit or debit).
205#[derive(Copy, Clone, Eq, PartialEq)]
206pub enum BillingCreditBalanceTransactionType {
207    Credit,
208    Debit,
209}
210impl BillingCreditBalanceTransactionType {
211    pub fn as_str(self) -> &'static str {
212        use BillingCreditBalanceTransactionType::*;
213        match self {
214            Credit => "credit",
215            Debit => "debit",
216        }
217    }
218}
219
220impl std::str::FromStr for BillingCreditBalanceTransactionType {
221    type Err = stripe_types::StripeParseError;
222    fn from_str(s: &str) -> Result<Self, Self::Err> {
223        use BillingCreditBalanceTransactionType::*;
224        match s {
225            "credit" => Ok(Credit),
226            "debit" => Ok(Debit),
227            _ => Err(stripe_types::StripeParseError),
228        }
229    }
230}
231impl std::fmt::Display for BillingCreditBalanceTransactionType {
232    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
233        f.write_str(self.as_str())
234    }
235}
236
237impl std::fmt::Debug for BillingCreditBalanceTransactionType {
238    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
239        f.write_str(self.as_str())
240    }
241}
242#[cfg(feature = "serialize")]
243impl serde::Serialize for BillingCreditBalanceTransactionType {
244    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
245    where
246        S: serde::Serializer,
247    {
248        serializer.serialize_str(self.as_str())
249    }
250}
251impl miniserde::Deserialize for BillingCreditBalanceTransactionType {
252    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
253        crate::Place::new(out)
254    }
255}
256
257impl miniserde::de::Visitor for crate::Place<BillingCreditBalanceTransactionType> {
258    fn string(&mut self, s: &str) -> miniserde::Result<()> {
259        use std::str::FromStr;
260        self.out =
261            Some(BillingCreditBalanceTransactionType::from_str(s).map_err(|_| miniserde::Error)?);
262        Ok(())
263    }
264}
265
266stripe_types::impl_from_val_with_from_str!(BillingCreditBalanceTransactionType);
267#[cfg(feature = "deserialize")]
268impl<'de> serde::Deserialize<'de> for BillingCreditBalanceTransactionType {
269    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
270        use std::str::FromStr;
271        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
272        Self::from_str(&s).map_err(|_| {
273            serde::de::Error::custom("Unknown value for BillingCreditBalanceTransactionType")
274        })
275    }
276}
277impl stripe_types::Object for BillingCreditBalanceTransaction {
278    type Id = stripe_shared::BillingCreditBalanceTransactionId;
279    fn id(&self) -> &Self::Id {
280        &self.id
281    }
282
283    fn into_id(self) -> Self::Id {
284        self.id
285    }
286}
287stripe_types::def_id!(BillingCreditBalanceTransactionId);
stripe_shared/billing_credit_balance_transaction.rs

stripe_shared/
billing_credit_balance_transaction.rs
