stripe_shared/
credit_note_line_item.rs

1/// The credit note line item object
2///
3/// For more details see <<https://stripe.com/docs/api/credit_notes/line_item>>.
4#[derive(Clone, Debug)]
5#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
6pub struct CreditNoteLineItem {
7    /// The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
8    pub amount: i64,
9    /// Description of the item being credited.
10    pub description: Option<String>,
11    /// The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
12    pub discount_amount: i64,
13    /// The amount of discount calculated per discount for this line item
14    pub discount_amounts: Vec<stripe_shared::DiscountsResourceDiscountAmount>,
15    /// Unique identifier for the object.
16    pub id: stripe_shared::CreditNoteLineItemId,
17    /// ID of the invoice line item being credited
18    pub invoice_line_item: Option<String>,
19    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
20    pub livemode: bool,
21    /// The pretax credit amounts (ex: discount, credit grants, etc) for this line item.
22    pub pretax_credit_amounts: Vec<stripe_shared::CreditNotesPretaxCreditAmount>,
23    /// The number of units of product being credited.
24    pub quantity: Option<u64>,
25    /// The tax rates which apply to the line item.
26    pub tax_rates: Vec<stripe_shared::TaxRate>,
27    /// The tax information of the line item.
28    pub taxes: Option<Vec<stripe_shared::BillingBillResourceInvoicingTaxesTax>>,
29    /// The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`.
30    /// When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
31    #[cfg_attr(feature = "deserialize", serde(rename = "type"))]
32    pub type_: CreditNoteLineItemType,
33    /// The cost of each unit of product being credited.
34    pub unit_amount: Option<i64>,
35    /// Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.
36    pub unit_amount_decimal: Option<String>,
37}
38#[doc(hidden)]
39pub struct CreditNoteLineItemBuilder {
40    amount: Option<i64>,
41    description: Option<Option<String>>,
42    discount_amount: Option<i64>,
43    discount_amounts: Option<Vec<stripe_shared::DiscountsResourceDiscountAmount>>,
44    id: Option<stripe_shared::CreditNoteLineItemId>,
45    invoice_line_item: Option<Option<String>>,
46    livemode: Option<bool>,
47    pretax_credit_amounts: Option<Vec<stripe_shared::CreditNotesPretaxCreditAmount>>,
48    quantity: Option<Option<u64>>,
49    tax_rates: Option<Vec<stripe_shared::TaxRate>>,
50    taxes: Option<Option<Vec<stripe_shared::BillingBillResourceInvoicingTaxesTax>>>,
51    type_: Option<CreditNoteLineItemType>,
52    unit_amount: Option<Option<i64>>,
53    unit_amount_decimal: Option<Option<String>>,
54}
55
56#[allow(
57    unused_variables,
58    irrefutable_let_patterns,
59    clippy::let_unit_value,
60    clippy::match_single_binding,
61    clippy::single_match
62)]
63const _: () = {
64    use miniserde::de::{Map, Visitor};
65    use miniserde::json::Value;
66    use miniserde::{Deserialize, Result, make_place};
67    use stripe_types::miniserde_helpers::FromValueOpt;
68    use stripe_types::{MapBuilder, ObjectDeser};
69
70    make_place!(Place);
71
72    impl Deserialize for CreditNoteLineItem {
73        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
74            Place::new(out)
75        }
76    }
77
78    struct Builder<'a> {
79        out: &'a mut Option<CreditNoteLineItem>,
80        builder: CreditNoteLineItemBuilder,
81    }
82
83    impl Visitor for Place<CreditNoteLineItem> {
84        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
85            Ok(Box::new(Builder {
86                out: &mut self.out,
87                builder: CreditNoteLineItemBuilder::deser_default(),
88            }))
89        }
90    }
91
92    impl MapBuilder for CreditNoteLineItemBuilder {
93        type Out = CreditNoteLineItem;
94        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
95            Ok(match k {
96                "amount" => Deserialize::begin(&mut self.amount),
97                "description" => Deserialize::begin(&mut self.description),
98                "discount_amount" => Deserialize::begin(&mut self.discount_amount),
99                "discount_amounts" => Deserialize::begin(&mut self.discount_amounts),
100                "id" => Deserialize::begin(&mut self.id),
101                "invoice_line_item" => Deserialize::begin(&mut self.invoice_line_item),
102                "livemode" => Deserialize::begin(&mut self.livemode),
103                "pretax_credit_amounts" => Deserialize::begin(&mut self.pretax_credit_amounts),
104                "quantity" => Deserialize::begin(&mut self.quantity),
105                "tax_rates" => Deserialize::begin(&mut self.tax_rates),
106                "taxes" => Deserialize::begin(&mut self.taxes),
107                "type" => Deserialize::begin(&mut self.type_),
108                "unit_amount" => Deserialize::begin(&mut self.unit_amount),
109                "unit_amount_decimal" => Deserialize::begin(&mut self.unit_amount_decimal),
110                _ => <dyn Visitor>::ignore(),
111            })
112        }
113
114        fn deser_default() -> Self {
115            Self {
116                amount: Deserialize::default(),
117                description: Deserialize::default(),
118                discount_amount: Deserialize::default(),
119                discount_amounts: Deserialize::default(),
120                id: Deserialize::default(),
121                invoice_line_item: Deserialize::default(),
122                livemode: Deserialize::default(),
123                pretax_credit_amounts: Deserialize::default(),
124                quantity: Deserialize::default(),
125                tax_rates: Deserialize::default(),
126                taxes: Deserialize::default(),
127                type_: Deserialize::default(),
128                unit_amount: Deserialize::default(),
129                unit_amount_decimal: Deserialize::default(),
130            }
131        }
132
133        fn take_out(&mut self) -> Option<Self::Out> {
134            let (
135                Some(amount),
136                Some(description),
137                Some(discount_amount),
138                Some(discount_amounts),
139                Some(id),
140                Some(invoice_line_item),
141                Some(livemode),
142                Some(pretax_credit_amounts),
143                Some(quantity),
144                Some(tax_rates),
145                Some(taxes),
146                Some(type_),
147                Some(unit_amount),
148                Some(unit_amount_decimal),
149            ) = (
150                self.amount,
151                self.description.take(),
152                self.discount_amount,
153                self.discount_amounts.take(),
154                self.id.take(),
155                self.invoice_line_item.take(),
156                self.livemode,
157                self.pretax_credit_amounts.take(),
158                self.quantity,
159                self.tax_rates.take(),
160                self.taxes.take(),
161                self.type_.take(),
162                self.unit_amount,
163                self.unit_amount_decimal.take(),
164            )
165            else {
166                return None;
167            };
168            Some(Self::Out {
169                amount,
170                description,
171                discount_amount,
172                discount_amounts,
173                id,
174                invoice_line_item,
175                livemode,
176                pretax_credit_amounts,
177                quantity,
178                tax_rates,
179                taxes,
180                type_,
181                unit_amount,
182                unit_amount_decimal,
183            })
184        }
185    }
186
187    impl Map for Builder<'_> {
188        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
189            self.builder.key(k)
190        }
191
192        fn finish(&mut self) -> Result<()> {
193            *self.out = self.builder.take_out();
194            Ok(())
195        }
196    }
197
198    impl ObjectDeser for CreditNoteLineItem {
199        type Builder = CreditNoteLineItemBuilder;
200    }
201
202    impl FromValueOpt for CreditNoteLineItem {
203        fn from_value(v: Value) -> Option<Self> {
204            let Value::Object(obj) = v else {
205                return None;
206            };
207            let mut b = CreditNoteLineItemBuilder::deser_default();
208            for (k, v) in obj {
209                match k.as_str() {
210                    "amount" => b.amount = FromValueOpt::from_value(v),
211                    "description" => b.description = FromValueOpt::from_value(v),
212                    "discount_amount" => b.discount_amount = FromValueOpt::from_value(v),
213                    "discount_amounts" => b.discount_amounts = FromValueOpt::from_value(v),
214                    "id" => b.id = FromValueOpt::from_value(v),
215                    "invoice_line_item" => b.invoice_line_item = FromValueOpt::from_value(v),
216                    "livemode" => b.livemode = FromValueOpt::from_value(v),
217                    "pretax_credit_amounts" => {
218                        b.pretax_credit_amounts = FromValueOpt::from_value(v)
219                    }
220                    "quantity" => b.quantity = FromValueOpt::from_value(v),
221                    "tax_rates" => b.tax_rates = FromValueOpt::from_value(v),
222                    "taxes" => b.taxes = FromValueOpt::from_value(v),
223                    "type" => b.type_ = FromValueOpt::from_value(v),
224                    "unit_amount" => b.unit_amount = FromValueOpt::from_value(v),
225                    "unit_amount_decimal" => b.unit_amount_decimal = FromValueOpt::from_value(v),
226                    _ => {}
227                }
228            }
229            b.take_out()
230        }
231    }
232};
233#[cfg(feature = "serialize")]
234impl serde::Serialize for CreditNoteLineItem {
235    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
236        use serde::ser::SerializeStruct;
237        let mut s = s.serialize_struct("CreditNoteLineItem", 15)?;
238        s.serialize_field("amount", &self.amount)?;
239        s.serialize_field("description", &self.description)?;
240        s.serialize_field("discount_amount", &self.discount_amount)?;
241        s.serialize_field("discount_amounts", &self.discount_amounts)?;
242        s.serialize_field("id", &self.id)?;
243        s.serialize_field("invoice_line_item", &self.invoice_line_item)?;
244        s.serialize_field("livemode", &self.livemode)?;
245        s.serialize_field("pretax_credit_amounts", &self.pretax_credit_amounts)?;
246        s.serialize_field("quantity", &self.quantity)?;
247        s.serialize_field("tax_rates", &self.tax_rates)?;
248        s.serialize_field("taxes", &self.taxes)?;
249        s.serialize_field("type", &self.type_)?;
250        s.serialize_field("unit_amount", &self.unit_amount)?;
251        s.serialize_field("unit_amount_decimal", &self.unit_amount_decimal)?;
252
253        s.serialize_field("object", "credit_note_line_item")?;
254        s.end()
255    }
256}
257/// The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`.
258/// When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.
259#[derive(Clone, Eq, PartialEq)]
260#[non_exhaustive]
261pub enum CreditNoteLineItemType {
262    CustomLineItem,
263    InvoiceLineItem,
264    /// An unrecognized value from Stripe. Should not be used as a request parameter.
265    Unknown(String),
266}
267impl CreditNoteLineItemType {
268    pub fn as_str(&self) -> &str {
269        use CreditNoteLineItemType::*;
270        match self {
271            CustomLineItem => "custom_line_item",
272            InvoiceLineItem => "invoice_line_item",
273            Unknown(v) => v,
274        }
275    }
276}
277
278impl std::str::FromStr for CreditNoteLineItemType {
279    type Err = std::convert::Infallible;
280    fn from_str(s: &str) -> Result<Self, Self::Err> {
281        use CreditNoteLineItemType::*;
282        match s {
283            "custom_line_item" => Ok(CustomLineItem),
284            "invoice_line_item" => Ok(InvoiceLineItem),
285            v => {
286                tracing::warn!("Unknown value '{}' for enum '{}'", v, "CreditNoteLineItemType");
287                Ok(Unknown(v.to_owned()))
288            }
289        }
290    }
291}
292impl std::fmt::Display for CreditNoteLineItemType {
293    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
294        f.write_str(self.as_str())
295    }
296}
297
298impl std::fmt::Debug for CreditNoteLineItemType {
299    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
300        f.write_str(self.as_str())
301    }
302}
303#[cfg(feature = "serialize")]
304impl serde::Serialize for CreditNoteLineItemType {
305    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
306    where
307        S: serde::Serializer,
308    {
309        serializer.serialize_str(self.as_str())
310    }
311}
312impl miniserde::Deserialize for CreditNoteLineItemType {
313    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
314        crate::Place::new(out)
315    }
316}
317
318impl miniserde::de::Visitor for crate::Place<CreditNoteLineItemType> {
319    fn string(&mut self, s: &str) -> miniserde::Result<()> {
320        use std::str::FromStr;
321        self.out = Some(CreditNoteLineItemType::from_str(s).expect("infallible"));
322        Ok(())
323    }
324}
325
326stripe_types::impl_from_val_with_from_str!(CreditNoteLineItemType);
327#[cfg(feature = "deserialize")]
328impl<'de> serde::Deserialize<'de> for CreditNoteLineItemType {
329    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
330        use std::str::FromStr;
331        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
332        Ok(Self::from_str(&s).expect("infallible"))
333    }
334}
335impl stripe_types::Object for CreditNoteLineItem {
336    type Id = stripe_shared::CreditNoteLineItemId;
337    fn id(&self) -> &Self::Id {
338        &self.id
339    }
340
341    fn into_id(self) -> Self::Id {
342        self.id
343    }
344}
345stripe_types::def_id!(CreditNoteLineItemId);
stripe_shared/credit_note_line_item.rs

stripe_shared/
credit_note_line_item.rs
