stripe_shared/
shipping_rate.rs

1/// Shipping rates describe the price of shipping presented to your customers and
2/// applied to a purchase.
3/// For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
4///
5/// For more details see <<https://stripe.com/docs/api/shipping_rates/object>>.
6#[derive(Clone, Debug)]
7#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
8pub struct ShippingRate {
9    /// Whether the shipping rate can be used for new purchases. Defaults to `true`.
10    pub active: bool,
11    /// Time at which the object was created. Measured in seconds since the Unix epoch.
12    pub created: stripe_types::Timestamp,
13    /// The estimated range for how long shipping will take, meant to be displayable to the customer.
14    /// This will appear on CheckoutSessions.
15    pub delivery_estimate: Option<stripe_shared::ShippingRateDeliveryEstimate>,
16    /// The name of the shipping rate, meant to be displayable to the customer.
17    /// This will appear on CheckoutSessions.
18    pub display_name: Option<String>,
19    pub fixed_amount: Option<stripe_shared::ShippingRateFixedAmount>,
20    /// Unique identifier for the object.
21    pub id: stripe_shared::ShippingRateId,
22    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
23    pub livemode: bool,
24    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
25    /// This can be useful for storing additional information about the object in a structured format.
26    pub metadata: std::collections::HashMap<String, String>,
27    /// Specifies whether the rate is considered inclusive of taxes or exclusive of taxes.
28    /// One of `inclusive`, `exclusive`, or `unspecified`.
29    pub tax_behavior: Option<stripe_shared::ShippingRateTaxBehavior>,
30    /// A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
31    /// The Shipping tax code is `txcd_92010001`.
32    pub tax_code: Option<stripe_types::Expandable<stripe_shared::TaxCode>>,
33    /// The type of calculation to use on the shipping rate.
34    #[cfg_attr(feature = "deserialize", serde(rename = "type"))]
35    pub type_: stripe_shared::ShippingRateType,
36}
37#[doc(hidden)]
38pub struct ShippingRateBuilder {
39    active: Option<bool>,
40    created: Option<stripe_types::Timestamp>,
41    delivery_estimate: Option<Option<stripe_shared::ShippingRateDeliveryEstimate>>,
42    display_name: Option<Option<String>>,
43    fixed_amount: Option<Option<stripe_shared::ShippingRateFixedAmount>>,
44    id: Option<stripe_shared::ShippingRateId>,
45    livemode: Option<bool>,
46    metadata: Option<std::collections::HashMap<String, String>>,
47    tax_behavior: Option<Option<stripe_shared::ShippingRateTaxBehavior>>,
48    tax_code: Option<Option<stripe_types::Expandable<stripe_shared::TaxCode>>>,
49    type_: Option<stripe_shared::ShippingRateType>,
50}
51
52#[allow(
53    unused_variables,
54    irrefutable_let_patterns,
55    clippy::let_unit_value,
56    clippy::match_single_binding,
57    clippy::single_match
58)]
59const _: () = {
60    use miniserde::de::{Map, Visitor};
61    use miniserde::json::Value;
62    use miniserde::{Deserialize, Result, make_place};
63    use stripe_types::miniserde_helpers::FromValueOpt;
64    use stripe_types::{MapBuilder, ObjectDeser};
65
66    make_place!(Place);
67
68    impl Deserialize for ShippingRate {
69        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
70            Place::new(out)
71        }
72    }
73
74    struct Builder<'a> {
75        out: &'a mut Option<ShippingRate>,
76        builder: ShippingRateBuilder,
77    }
78
79    impl Visitor for Place<ShippingRate> {
80        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
81            Ok(Box::new(Builder {
82                out: &mut self.out,
83                builder: ShippingRateBuilder::deser_default(),
84            }))
85        }
86    }
87
88    impl MapBuilder for ShippingRateBuilder {
89        type Out = ShippingRate;
90        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
91            Ok(match k {
92                "active" => Deserialize::begin(&mut self.active),
93                "created" => Deserialize::begin(&mut self.created),
94                "delivery_estimate" => Deserialize::begin(&mut self.delivery_estimate),
95                "display_name" => Deserialize::begin(&mut self.display_name),
96                "fixed_amount" => Deserialize::begin(&mut self.fixed_amount),
97                "id" => Deserialize::begin(&mut self.id),
98                "livemode" => Deserialize::begin(&mut self.livemode),
99                "metadata" => Deserialize::begin(&mut self.metadata),
100                "tax_behavior" => Deserialize::begin(&mut self.tax_behavior),
101                "tax_code" => Deserialize::begin(&mut self.tax_code),
102                "type" => Deserialize::begin(&mut self.type_),
103                _ => <dyn Visitor>::ignore(),
104            })
105        }
106
107        fn deser_default() -> Self {
108            Self {
109                active: Deserialize::default(),
110                created: Deserialize::default(),
111                delivery_estimate: Deserialize::default(),
112                display_name: Deserialize::default(),
113                fixed_amount: Deserialize::default(),
114                id: Deserialize::default(),
115                livemode: Deserialize::default(),
116                metadata: Deserialize::default(),
117                tax_behavior: Deserialize::default(),
118                tax_code: Deserialize::default(),
119                type_: Deserialize::default(),
120            }
121        }
122
123        fn take_out(&mut self) -> Option<Self::Out> {
124            let (
125                Some(active),
126                Some(created),
127                Some(delivery_estimate),
128                Some(display_name),
129                Some(fixed_amount),
130                Some(id),
131                Some(livemode),
132                Some(metadata),
133                Some(tax_behavior),
134                Some(tax_code),
135                Some(type_),
136            ) = (
137                self.active,
138                self.created,
139                self.delivery_estimate,
140                self.display_name.take(),
141                self.fixed_amount.take(),
142                self.id.take(),
143                self.livemode,
144                self.metadata.take(),
145                self.tax_behavior,
146                self.tax_code.take(),
147                self.type_,
148            )
149            else {
150                return None;
151            };
152            Some(Self::Out {
153                active,
154                created,
155                delivery_estimate,
156                display_name,
157                fixed_amount,
158                id,
159                livemode,
160                metadata,
161                tax_behavior,
162                tax_code,
163                type_,
164            })
165        }
166    }
167
168    impl Map for Builder<'_> {
169        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
170            self.builder.key(k)
171        }
172
173        fn finish(&mut self) -> Result<()> {
174            *self.out = self.builder.take_out();
175            Ok(())
176        }
177    }
178
179    impl ObjectDeser for ShippingRate {
180        type Builder = ShippingRateBuilder;
181    }
182
183    impl FromValueOpt for ShippingRate {
184        fn from_value(v: Value) -> Option<Self> {
185            let Value::Object(obj) = v else {
186                return None;
187            };
188            let mut b = ShippingRateBuilder::deser_default();
189            for (k, v) in obj {
190                match k.as_str() {
191                    "active" => b.active = FromValueOpt::from_value(v),
192                    "created" => b.created = FromValueOpt::from_value(v),
193                    "delivery_estimate" => b.delivery_estimate = FromValueOpt::from_value(v),
194                    "display_name" => b.display_name = FromValueOpt::from_value(v),
195                    "fixed_amount" => b.fixed_amount = FromValueOpt::from_value(v),
196                    "id" => b.id = FromValueOpt::from_value(v),
197                    "livemode" => b.livemode = FromValueOpt::from_value(v),
198                    "metadata" => b.metadata = FromValueOpt::from_value(v),
199                    "tax_behavior" => b.tax_behavior = FromValueOpt::from_value(v),
200                    "tax_code" => b.tax_code = FromValueOpt::from_value(v),
201                    "type" => b.type_ = FromValueOpt::from_value(v),
202                    _ => {}
203                }
204            }
205            b.take_out()
206        }
207    }
208};
209#[cfg(feature = "serialize")]
210impl serde::Serialize for ShippingRate {
211    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
212        use serde::ser::SerializeStruct;
213        let mut s = s.serialize_struct("ShippingRate", 12)?;
214        s.serialize_field("active", &self.active)?;
215        s.serialize_field("created", &self.created)?;
216        s.serialize_field("delivery_estimate", &self.delivery_estimate)?;
217        s.serialize_field("display_name", &self.display_name)?;
218        s.serialize_field("fixed_amount", &self.fixed_amount)?;
219        s.serialize_field("id", &self.id)?;
220        s.serialize_field("livemode", &self.livemode)?;
221        s.serialize_field("metadata", &self.metadata)?;
222        s.serialize_field("tax_behavior", &self.tax_behavior)?;
223        s.serialize_field("tax_code", &self.tax_code)?;
224        s.serialize_field("type", &self.type_)?;
225
226        s.serialize_field("object", "shipping_rate")?;
227        s.end()
228    }
229}
230impl stripe_types::Object for ShippingRate {
231    type Id = stripe_shared::ShippingRateId;
232    fn id(&self) -> &Self::Id {
233        &self.id
234    }
235
236    fn into_id(self) -> Self::Id {
237        self.id
238    }
239}
240stripe_types::def_id!(ShippingRateId);
241#[derive(Copy, Clone, Eq, PartialEq)]
242pub enum ShippingRateTaxBehavior {
243    Exclusive,
244    Inclusive,
245    Unspecified,
246}
247impl ShippingRateTaxBehavior {
248    pub fn as_str(self) -> &'static str {
249        use ShippingRateTaxBehavior::*;
250        match self {
251            Exclusive => "exclusive",
252            Inclusive => "inclusive",
253            Unspecified => "unspecified",
254        }
255    }
256}
257
258impl std::str::FromStr for ShippingRateTaxBehavior {
259    type Err = stripe_types::StripeParseError;
260    fn from_str(s: &str) -> Result<Self, Self::Err> {
261        use ShippingRateTaxBehavior::*;
262        match s {
263            "exclusive" => Ok(Exclusive),
264            "inclusive" => Ok(Inclusive),
265            "unspecified" => Ok(Unspecified),
266            _ => Err(stripe_types::StripeParseError),
267        }
268    }
269}
270impl std::fmt::Display for ShippingRateTaxBehavior {
271    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
272        f.write_str(self.as_str())
273    }
274}
275
276impl std::fmt::Debug for ShippingRateTaxBehavior {
277    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
278        f.write_str(self.as_str())
279    }
280}
281impl serde::Serialize for ShippingRateTaxBehavior {
282    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
283    where
284        S: serde::Serializer,
285    {
286        serializer.serialize_str(self.as_str())
287    }
288}
289impl miniserde::Deserialize for ShippingRateTaxBehavior {
290    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
291        crate::Place::new(out)
292    }
293}
294
295impl miniserde::de::Visitor for crate::Place<ShippingRateTaxBehavior> {
296    fn string(&mut self, s: &str) -> miniserde::Result<()> {
297        use std::str::FromStr;
298        self.out = Some(ShippingRateTaxBehavior::from_str(s).map_err(|_| miniserde::Error)?);
299        Ok(())
300    }
301}
302
303stripe_types::impl_from_val_with_from_str!(ShippingRateTaxBehavior);
304#[cfg(feature = "deserialize")]
305impl<'de> serde::Deserialize<'de> for ShippingRateTaxBehavior {
306    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
307        use std::str::FromStr;
308        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
309        Self::from_str(&s)
310            .map_err(|_| serde::de::Error::custom("Unknown value for ShippingRateTaxBehavior"))
311    }
312}
313#[derive(Copy, Clone, Eq, PartialEq)]
314pub enum ShippingRateType {
315    FixedAmount,
316}
317impl ShippingRateType {
318    pub fn as_str(self) -> &'static str {
319        use ShippingRateType::*;
320        match self {
321            FixedAmount => "fixed_amount",
322        }
323    }
324}
325
326impl std::str::FromStr for ShippingRateType {
327    type Err = stripe_types::StripeParseError;
328    fn from_str(s: &str) -> Result<Self, Self::Err> {
329        use ShippingRateType::*;
330        match s {
331            "fixed_amount" => Ok(FixedAmount),
332            _ => Err(stripe_types::StripeParseError),
333        }
334    }
335}
336impl std::fmt::Display for ShippingRateType {
337    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
338        f.write_str(self.as_str())
339    }
340}
341
342impl std::fmt::Debug for ShippingRateType {
343    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
344        f.write_str(self.as_str())
345    }
346}
347impl serde::Serialize for ShippingRateType {
348    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
349    where
350        S: serde::Serializer,
351    {
352        serializer.serialize_str(self.as_str())
353    }
354}
355impl miniserde::Deserialize for ShippingRateType {
356    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
357        crate::Place::new(out)
358    }
359}
360
361impl miniserde::de::Visitor for crate::Place<ShippingRateType> {
362    fn string(&mut self, s: &str) -> miniserde::Result<()> {
363        use std::str::FromStr;
364        self.out = Some(ShippingRateType::from_str(s).map_err(|_| miniserde::Error)?);
365        Ok(())
366    }
367}
368
369stripe_types::impl_from_val_with_from_str!(ShippingRateType);
370#[cfg(feature = "deserialize")]
371impl<'de> serde::Deserialize<'de> for ShippingRateType {
372    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
373        use std::str::FromStr;
374        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
375        Self::from_str(&s)
376            .map_err(|_| serde::de::Error::custom("Unknown value for ShippingRateType"))
377    }
378}
stripe_shared/shipping_rate.rs

stripe_shared/
shipping_rate.rs
