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
104                _ => <dyn Visitor>::ignore(),
105            })
106        }
107
108        fn deser_default() -> Self {
109            Self {
110                active: Deserialize::default(),
111                created: Deserialize::default(),
112                delivery_estimate: Deserialize::default(),
113                display_name: Deserialize::default(),
114                fixed_amount: Deserialize::default(),
115                id: Deserialize::default(),
116                livemode: Deserialize::default(),
117                metadata: Deserialize::default(),
118                tax_behavior: Deserialize::default(),
119                tax_code: Deserialize::default(),
120                type_: Deserialize::default(),
121            }
122        }
123
124        fn take_out(&mut self) -> Option<Self::Out> {
125            let (
126                Some(active),
127                Some(created),
128                Some(delivery_estimate),
129                Some(display_name),
130                Some(fixed_amount),
131                Some(id),
132                Some(livemode),
133                Some(metadata),
134                Some(tax_behavior),
135                Some(tax_code),
136                Some(type_),
137            ) = (
138                self.active,
139                self.created,
140                self.delivery_estimate,
141                self.display_name.take(),
142                self.fixed_amount.take(),
143                self.id.take(),
144                self.livemode,
145                self.metadata.take(),
146                self.tax_behavior,
147                self.tax_code.take(),
148                self.type_,
149            )
150            else {
151                return None;
152            };
153            Some(Self::Out {
154                active,
155                created,
156                delivery_estimate,
157                display_name,
158                fixed_amount,
159                id,
160                livemode,
161                metadata,
162                tax_behavior,
163                tax_code,
164                type_,
165            })
166        }
167    }
168
169    impl Map for Builder<'_> {
170        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
171            self.builder.key(k)
172        }
173
174        fn finish(&mut self) -> Result<()> {
175            *self.out = self.builder.take_out();
176            Ok(())
177        }
178    }
179
180    impl ObjectDeser for ShippingRate {
181        type Builder = ShippingRateBuilder;
182    }
183
184    impl FromValueOpt for ShippingRate {
185        fn from_value(v: Value) -> Option<Self> {
186            let Value::Object(obj) = v else {
187                return None;
188            };
189            let mut b = ShippingRateBuilder::deser_default();
190            for (k, v) in obj {
191                match k.as_str() {
192                    "active" => b.active = FromValueOpt::from_value(v),
193                    "created" => b.created = FromValueOpt::from_value(v),
194                    "delivery_estimate" => b.delivery_estimate = FromValueOpt::from_value(v),
195                    "display_name" => b.display_name = FromValueOpt::from_value(v),
196                    "fixed_amount" => b.fixed_amount = FromValueOpt::from_value(v),
197                    "id" => b.id = FromValueOpt::from_value(v),
198                    "livemode" => b.livemode = FromValueOpt::from_value(v),
199                    "metadata" => b.metadata = FromValueOpt::from_value(v),
200                    "tax_behavior" => b.tax_behavior = FromValueOpt::from_value(v),
201                    "tax_code" => b.tax_code = FromValueOpt::from_value(v),
202                    "type" => b.type_ = FromValueOpt::from_value(v),
203
204                    _ => {}
205                }
206            }
207            b.take_out()
208        }
209    }
210};
211#[cfg(feature = "serialize")]
212impl serde::Serialize for ShippingRate {
213    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
214        use serde::ser::SerializeStruct;
215        let mut s = s.serialize_struct("ShippingRate", 12)?;
216        s.serialize_field("active", &self.active)?;
217        s.serialize_field("created", &self.created)?;
218        s.serialize_field("delivery_estimate", &self.delivery_estimate)?;
219        s.serialize_field("display_name", &self.display_name)?;
220        s.serialize_field("fixed_amount", &self.fixed_amount)?;
221        s.serialize_field("id", &self.id)?;
222        s.serialize_field("livemode", &self.livemode)?;
223        s.serialize_field("metadata", &self.metadata)?;
224        s.serialize_field("tax_behavior", &self.tax_behavior)?;
225        s.serialize_field("tax_code", &self.tax_code)?;
226        s.serialize_field("type", &self.type_)?;
227
228        s.serialize_field("object", "shipping_rate")?;
229        s.end()
230    }
231}
232impl stripe_types::Object for ShippingRate {
233    type Id = stripe_shared::ShippingRateId;
234    fn id(&self) -> &Self::Id {
235        &self.id
236    }
237
238    fn into_id(self) -> Self::Id {
239        self.id
240    }
241}
242stripe_types::def_id!(ShippingRateId);
243#[derive(Copy, Clone, Eq, PartialEq)]
244pub enum ShippingRateTaxBehavior {
245    Exclusive,
246    Inclusive,
247    Unspecified,
248}
249impl ShippingRateTaxBehavior {
250    pub fn as_str(self) -> &'static str {
251        use ShippingRateTaxBehavior::*;
252        match self {
253            Exclusive => "exclusive",
254            Inclusive => "inclusive",
255            Unspecified => "unspecified",
256        }
257    }
258}
259
260impl std::str::FromStr for ShippingRateTaxBehavior {
261    type Err = stripe_types::StripeParseError;
262    fn from_str(s: &str) -> Result<Self, Self::Err> {
263        use ShippingRateTaxBehavior::*;
264        match s {
265            "exclusive" => Ok(Exclusive),
266            "inclusive" => Ok(Inclusive),
267            "unspecified" => Ok(Unspecified),
268            _ => Err(stripe_types::StripeParseError),
269        }
270    }
271}
272impl std::fmt::Display for ShippingRateTaxBehavior {
273    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
274        f.write_str(self.as_str())
275    }
276}
277
278impl std::fmt::Debug for ShippingRateTaxBehavior {
279    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
280        f.write_str(self.as_str())
281    }
282}
283impl serde::Serialize for ShippingRateTaxBehavior {
284    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
285    where
286        S: serde::Serializer,
287    {
288        serializer.serialize_str(self.as_str())
289    }
290}
291impl miniserde::Deserialize for ShippingRateTaxBehavior {
292    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
293        crate::Place::new(out)
294    }
295}
296
297impl miniserde::de::Visitor for crate::Place<ShippingRateTaxBehavior> {
298    fn string(&mut self, s: &str) -> miniserde::Result<()> {
299        use std::str::FromStr;
300        self.out = Some(ShippingRateTaxBehavior::from_str(s).map_err(|_| miniserde::Error)?);
301        Ok(())
302    }
303}
304
305stripe_types::impl_from_val_with_from_str!(ShippingRateTaxBehavior);
306#[cfg(feature = "deserialize")]
307impl<'de> serde::Deserialize<'de> for ShippingRateTaxBehavior {
308    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
309        use std::str::FromStr;
310        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
311        Self::from_str(&s)
312            .map_err(|_| serde::de::Error::custom("Unknown value for ShippingRateTaxBehavior"))
313    }
314}
315#[derive(Copy, Clone, Eq, PartialEq)]
316pub enum ShippingRateType {
317    FixedAmount,
318}
319impl ShippingRateType {
320    pub fn as_str(self) -> &'static str {
321        use ShippingRateType::*;
322        match self {
323            FixedAmount => "fixed_amount",
324        }
325    }
326}
327
328impl std::str::FromStr for ShippingRateType {
329    type Err = stripe_types::StripeParseError;
330    fn from_str(s: &str) -> Result<Self, Self::Err> {
331        use ShippingRateType::*;
332        match s {
333            "fixed_amount" => Ok(FixedAmount),
334            _ => Err(stripe_types::StripeParseError),
335        }
336    }
337}
338impl std::fmt::Display for ShippingRateType {
339    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
340        f.write_str(self.as_str())
341    }
342}
343
344impl std::fmt::Debug for ShippingRateType {
345    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
346        f.write_str(self.as_str())
347    }
348}
349impl serde::Serialize for ShippingRateType {
350    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
351    where
352        S: serde::Serializer,
353    {
354        serializer.serialize_str(self.as_str())
355    }
356}
357impl miniserde::Deserialize for ShippingRateType {
358    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
359        crate::Place::new(out)
360    }
361}
362
363impl miniserde::de::Visitor for crate::Place<ShippingRateType> {
364    fn string(&mut self, s: &str) -> miniserde::Result<()> {
365        use std::str::FromStr;
366        self.out = Some(ShippingRateType::from_str(s).map_err(|_| miniserde::Error)?);
367        Ok(())
368    }
369}
370
371stripe_types::impl_from_val_with_from_str!(ShippingRateType);
372#[cfg(feature = "deserialize")]
373impl<'de> serde::Deserialize<'de> for ShippingRateType {
374    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
375        use std::str::FromStr;
376        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
377        Self::from_str(&s)
378            .map_err(|_| serde::de::Error::custom("Unknown value for ShippingRateType"))
379    }
380}
stripe_shared/shipping_rate.rs

stripe_shared/
shipping_rate.rs
