stripe_terminal/
terminal_reader_reader_resource_refund_payment_action.rs

1/// Represents a reader action to refund a payment
2#[derive(Clone, Debug)]
3#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
4#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
5pub struct TerminalReaderReaderResourceRefundPaymentAction {
6    /// The amount being refunded.
7    pub amount: Option<i64>,
8    /// Charge that is being refunded.
9    pub charge: Option<stripe_types::Expandable<stripe_shared::Charge>>,
10    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
11    /// This can be useful for storing additional information about the object in a structured format.
12    pub metadata: Option<std::collections::HashMap<String, String>>,
13    /// Payment intent that is being refunded.
14    pub payment_intent: Option<stripe_types::Expandable<stripe_shared::PaymentIntent>>,
15    /// The reason for the refund.
16    pub reason: Option<TerminalReaderReaderResourceRefundPaymentActionReason>,
17    /// Unique identifier for the refund object.
18    pub refund: Option<stripe_types::Expandable<stripe_shared::Refund>>,
19    /// Boolean indicating whether the application fee should be refunded when refunding this charge.
20    /// If a full charge refund is given, the full application fee will be refunded.
21    /// Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded.
22    /// An application fee can be refunded only by the application that created the charge.
23    pub refund_application_fee: Option<bool>,
24    pub refund_payment_config:
25        Option<stripe_terminal::TerminalReaderReaderResourceRefundPaymentConfig>,
26    /// Boolean indicating whether the transfer should be reversed when refunding this charge.
27    /// The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).
28    /// A transfer can be reversed only by the application that created the charge.
29    pub reverse_transfer: Option<bool>,
30}
31#[doc(hidden)]
32pub struct TerminalReaderReaderResourceRefundPaymentActionBuilder {
33    amount: Option<Option<i64>>,
34    charge: Option<Option<stripe_types::Expandable<stripe_shared::Charge>>>,
35    metadata: Option<Option<std::collections::HashMap<String, String>>>,
36    payment_intent: Option<Option<stripe_types::Expandable<stripe_shared::PaymentIntent>>>,
37    reason: Option<Option<TerminalReaderReaderResourceRefundPaymentActionReason>>,
38    refund: Option<Option<stripe_types::Expandable<stripe_shared::Refund>>>,
39    refund_application_fee: Option<Option<bool>>,
40    refund_payment_config:
41        Option<Option<stripe_terminal::TerminalReaderReaderResourceRefundPaymentConfig>>,
42    reverse_transfer: Option<Option<bool>>,
43}
44
45#[allow(
46    unused_variables,
47    irrefutable_let_patterns,
48    clippy::let_unit_value,
49    clippy::match_single_binding,
50    clippy::single_match
51)]
52const _: () = {
53    use miniserde::de::{Map, Visitor};
54    use miniserde::json::Value;
55    use miniserde::{Deserialize, Result, make_place};
56    use stripe_types::miniserde_helpers::FromValueOpt;
57    use stripe_types::{MapBuilder, ObjectDeser};
58
59    make_place!(Place);
60
61    impl Deserialize for TerminalReaderReaderResourceRefundPaymentAction {
62        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
63            Place::new(out)
64        }
65    }
66
67    struct Builder<'a> {
68        out: &'a mut Option<TerminalReaderReaderResourceRefundPaymentAction>,
69        builder: TerminalReaderReaderResourceRefundPaymentActionBuilder,
70    }
71
72    impl Visitor for Place<TerminalReaderReaderResourceRefundPaymentAction> {
73        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
74            Ok(Box::new(Builder {
75                out: &mut self.out,
76                builder: TerminalReaderReaderResourceRefundPaymentActionBuilder::deser_default(),
77            }))
78        }
79    }
80
81    impl MapBuilder for TerminalReaderReaderResourceRefundPaymentActionBuilder {
82        type Out = TerminalReaderReaderResourceRefundPaymentAction;
83        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
84            Ok(match k {
85                "amount" => Deserialize::begin(&mut self.amount),
86                "charge" => Deserialize::begin(&mut self.charge),
87                "metadata" => Deserialize::begin(&mut self.metadata),
88                "payment_intent" => Deserialize::begin(&mut self.payment_intent),
89                "reason" => Deserialize::begin(&mut self.reason),
90                "refund" => Deserialize::begin(&mut self.refund),
91                "refund_application_fee" => Deserialize::begin(&mut self.refund_application_fee),
92                "refund_payment_config" => Deserialize::begin(&mut self.refund_payment_config),
93                "reverse_transfer" => Deserialize::begin(&mut self.reverse_transfer),
94
95                _ => <dyn Visitor>::ignore(),
96            })
97        }
98
99        fn deser_default() -> Self {
100            Self {
101                amount: Deserialize::default(),
102                charge: Deserialize::default(),
103                metadata: Deserialize::default(),
104                payment_intent: Deserialize::default(),
105                reason: Deserialize::default(),
106                refund: Deserialize::default(),
107                refund_application_fee: Deserialize::default(),
108                refund_payment_config: Deserialize::default(),
109                reverse_transfer: Deserialize::default(),
110            }
111        }
112
113        fn take_out(&mut self) -> Option<Self::Out> {
114            let (
115                Some(amount),
116                Some(charge),
117                Some(metadata),
118                Some(payment_intent),
119                Some(reason),
120                Some(refund),
121                Some(refund_application_fee),
122                Some(refund_payment_config),
123                Some(reverse_transfer),
124            ) = (
125                self.amount,
126                self.charge.take(),
127                self.metadata.take(),
128                self.payment_intent.take(),
129                self.reason,
130                self.refund.take(),
131                self.refund_application_fee,
132                self.refund_payment_config,
133                self.reverse_transfer,
134            )
135            else {
136                return None;
137            };
138            Some(Self::Out {
139                amount,
140                charge,
141                metadata,
142                payment_intent,
143                reason,
144                refund,
145                refund_application_fee,
146                refund_payment_config,
147                reverse_transfer,
148            })
149        }
150    }
151
152    impl Map for Builder<'_> {
153        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
154            self.builder.key(k)
155        }
156
157        fn finish(&mut self) -> Result<()> {
158            *self.out = self.builder.take_out();
159            Ok(())
160        }
161    }
162
163    impl ObjectDeser for TerminalReaderReaderResourceRefundPaymentAction {
164        type Builder = TerminalReaderReaderResourceRefundPaymentActionBuilder;
165    }
166
167    impl FromValueOpt for TerminalReaderReaderResourceRefundPaymentAction {
168        fn from_value(v: Value) -> Option<Self> {
169            let Value::Object(obj) = v else {
170                return None;
171            };
172            let mut b = TerminalReaderReaderResourceRefundPaymentActionBuilder::deser_default();
173            for (k, v) in obj {
174                match k.as_str() {
175                    "amount" => b.amount = FromValueOpt::from_value(v),
176                    "charge" => b.charge = FromValueOpt::from_value(v),
177                    "metadata" => b.metadata = FromValueOpt::from_value(v),
178                    "payment_intent" => b.payment_intent = FromValueOpt::from_value(v),
179                    "reason" => b.reason = FromValueOpt::from_value(v),
180                    "refund" => b.refund = FromValueOpt::from_value(v),
181                    "refund_application_fee" => {
182                        b.refund_application_fee = FromValueOpt::from_value(v)
183                    }
184                    "refund_payment_config" => {
185                        b.refund_payment_config = FromValueOpt::from_value(v)
186                    }
187                    "reverse_transfer" => b.reverse_transfer = FromValueOpt::from_value(v),
188
189                    _ => {}
190                }
191            }
192            b.take_out()
193        }
194    }
195};
196/// The reason for the refund.
197#[derive(Copy, Clone, Eq, PartialEq)]
198pub enum TerminalReaderReaderResourceRefundPaymentActionReason {
199    Duplicate,
200    Fraudulent,
201    RequestedByCustomer,
202}
203impl TerminalReaderReaderResourceRefundPaymentActionReason {
204    pub fn as_str(self) -> &'static str {
205        use TerminalReaderReaderResourceRefundPaymentActionReason::*;
206        match self {
207            Duplicate => "duplicate",
208            Fraudulent => "fraudulent",
209            RequestedByCustomer => "requested_by_customer",
210        }
211    }
212}
213
214impl std::str::FromStr for TerminalReaderReaderResourceRefundPaymentActionReason {
215    type Err = stripe_types::StripeParseError;
216    fn from_str(s: &str) -> Result<Self, Self::Err> {
217        use TerminalReaderReaderResourceRefundPaymentActionReason::*;
218        match s {
219            "duplicate" => Ok(Duplicate),
220            "fraudulent" => Ok(Fraudulent),
221            "requested_by_customer" => Ok(RequestedByCustomer),
222            _ => Err(stripe_types::StripeParseError),
223        }
224    }
225}
226impl std::fmt::Display for TerminalReaderReaderResourceRefundPaymentActionReason {
227    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
228        f.write_str(self.as_str())
229    }
230}
231
232impl std::fmt::Debug for TerminalReaderReaderResourceRefundPaymentActionReason {
233    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
234        f.write_str(self.as_str())
235    }
236}
237#[cfg(feature = "serialize")]
238impl serde::Serialize for TerminalReaderReaderResourceRefundPaymentActionReason {
239    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
240    where
241        S: serde::Serializer,
242    {
243        serializer.serialize_str(self.as_str())
244    }
245}
246impl miniserde::Deserialize for TerminalReaderReaderResourceRefundPaymentActionReason {
247    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
248        crate::Place::new(out)
249    }
250}
251
252impl miniserde::de::Visitor
253    for crate::Place<TerminalReaderReaderResourceRefundPaymentActionReason>
254{
255    fn string(&mut self, s: &str) -> miniserde::Result<()> {
256        use std::str::FromStr;
257        self.out = Some(
258            TerminalReaderReaderResourceRefundPaymentActionReason::from_str(s)
259                .map_err(|_| miniserde::Error)?,
260        );
261        Ok(())
262    }
263}
264
265stripe_types::impl_from_val_with_from_str!(TerminalReaderReaderResourceRefundPaymentActionReason);
266#[cfg(feature = "deserialize")]
267impl<'de> serde::Deserialize<'de> for TerminalReaderReaderResourceRefundPaymentActionReason {
268    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
269        use std::str::FromStr;
270        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
271        Self::from_str(&s).map_err(|_| {
272            serde::de::Error::custom(
273                "Unknown value for TerminalReaderReaderResourceRefundPaymentActionReason",
274            )
275        })
276    }
277}