async-stripe-shared 1.0.0-rc.6

/// A coupon contains information about a percent-off or amount-off discount you
/// might want to apply to a customer.
/// Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),.
/// [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more.
/// Coupons do not work with conventional one-off [charges](/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents).
///
/// For more details see <<https://stripe.com/docs/api/coupons/object>>.
#[derive(Clone)]
#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
pub struct Coupon {
    /// Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.
    pub amount_off: Option<i64>,
    pub applies_to: Option<stripe_shared::CouponAppliesTo>,
    /// Time at which the object was created. Measured in seconds since the Unix epoch.
    pub created: stripe_types::Timestamp,
    /// If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.
    pub currency: Option<stripe_types::Currency>,
    /// Coupons defined in each available currency option.
    /// Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
    pub currency_options: Option<
        std::collections::HashMap<stripe_types::Currency, stripe_shared::CouponCurrencyOption>,
    >,
    /// One of `forever`, `once`, or `repeating`.
    /// Describes how long a customer who applies this coupon will get the discount.
    pub duration: stripe_shared::CouponDuration,
    /// If `duration` is `repeating`, the number of months the coupon applies.
    /// Null if coupon `duration` is `forever` or `once`.
    pub duration_in_months: Option<i64>,
    /// Unique identifier for the object.
    pub id: stripe_shared::CouponId,
    /// If the object exists in live mode, the value is `true`.
    /// If the object exists in test mode, the value is `false`.
    pub livemode: bool,
    /// Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
    pub max_redemptions: Option<i64>,
    /// Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object.
    /// This can be useful for storing additional information about the object in a structured format.
    pub metadata: Option<std::collections::HashMap<String, String>>,
    /// Name of the coupon displayed to customers on for instance invoices or receipts.
    pub name: Option<String>,
    /// Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
    /// For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
    pub percent_off: Option<f64>,
    /// Date after which the coupon can no longer be redeemed.
    pub redeem_by: Option<stripe_types::Timestamp>,
    /// Number of times this coupon has been applied to a customer.
    pub times_redeemed: i64,
    /// Taking account of the above properties, whether this coupon can still be applied to a customer.
    pub valid: bool,
}
#[cfg(feature = "redact-generated-debug")]
impl std::fmt::Debug for Coupon {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("Coupon").finish_non_exhaustive()
    }
}
#[doc(hidden)]
pub struct CouponBuilder {
    amount_off: Option<Option<i64>>,
    applies_to: Option<Option<stripe_shared::CouponAppliesTo>>,
    created: Option<stripe_types::Timestamp>,
    currency: Option<Option<stripe_types::Currency>>,
    currency_options: Option<
        Option<
            std::collections::HashMap<stripe_types::Currency, stripe_shared::CouponCurrencyOption>,
        >,
    >,
    duration: Option<stripe_shared::CouponDuration>,
    duration_in_months: Option<Option<i64>>,
    id: Option<stripe_shared::CouponId>,
    livemode: Option<bool>,
    max_redemptions: Option<Option<i64>>,
    metadata: Option<Option<std::collections::HashMap<String, String>>>,
    name: Option<Option<String>>,
    percent_off: Option<Option<f64>>,
    redeem_by: Option<Option<stripe_types::Timestamp>>,
    times_redeemed: Option<i64>,
    valid: Option<bool>,
}

#[allow(
    unused_variables,
    irrefutable_let_patterns,
    clippy::let_unit_value,
    clippy::match_single_binding,
    clippy::single_match
)]
const _: () = {
    use miniserde::de::{Map, Visitor};
    use miniserde::json::Value;
    use miniserde::{Deserialize, Result, make_place};
    use stripe_types::miniserde_helpers::FromValueOpt;
    use stripe_types::{MapBuilder, ObjectDeser};

    make_place!(Place);

    impl Deserialize for Coupon {
        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
            Place::new(out)
        }
    }

    struct Builder<'a> {
        out: &'a mut Option<Coupon>,
        builder: CouponBuilder,
    }

    impl Visitor for Place<Coupon> {
        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
            Ok(Box::new(Builder { out: &mut self.out, builder: CouponBuilder::deser_default() }))
        }
    }

    impl MapBuilder for CouponBuilder {
        type Out = Coupon;
        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
            Ok(match k {
                "amount_off" => Deserialize::begin(&mut self.amount_off),
                "applies_to" => Deserialize::begin(&mut self.applies_to),
                "created" => Deserialize::begin(&mut self.created),
                "currency" => Deserialize::begin(&mut self.currency),
                "currency_options" => Deserialize::begin(&mut self.currency_options),
                "duration" => Deserialize::begin(&mut self.duration),
                "duration_in_months" => Deserialize::begin(&mut self.duration_in_months),
                "id" => Deserialize::begin(&mut self.id),
                "livemode" => Deserialize::begin(&mut self.livemode),
                "max_redemptions" => Deserialize::begin(&mut self.max_redemptions),
                "metadata" => Deserialize::begin(&mut self.metadata),
                "name" => Deserialize::begin(&mut self.name),
                "percent_off" => Deserialize::begin(&mut self.percent_off),
                "redeem_by" => Deserialize::begin(&mut self.redeem_by),
                "times_redeemed" => Deserialize::begin(&mut self.times_redeemed),
                "valid" => Deserialize::begin(&mut self.valid),
                _ => <dyn Visitor>::ignore(),
            })
        }

        fn deser_default() -> Self {
            Self {
                amount_off: Some(None),
                applies_to: Some(None),
                created: None,
                currency: Some(None),
                currency_options: Some(None),
                duration: None,
                duration_in_months: Some(None),
                id: None,
                livemode: None,
                max_redemptions: Some(None),
                metadata: Some(None),
                name: Some(None),
                percent_off: Some(None),
                redeem_by: Some(None),
                times_redeemed: None,
                valid: None,
            }
        }

        fn take_out(&mut self) -> Option<Self::Out> {
            let (
                Some(amount_off),
                Some(applies_to),
                Some(created),
                Some(currency),
                Some(currency_options),
                Some(duration),
                Some(duration_in_months),
                Some(id),
                Some(livemode),
                Some(max_redemptions),
                Some(metadata),
                Some(name),
                Some(percent_off),
                Some(redeem_by),
                Some(times_redeemed),
                Some(valid),
            ) = (
                self.amount_off,
                self.applies_to.take(),
                self.created,
                self.currency.take(),
                self.currency_options.take(),
                self.duration.take(),
                self.duration_in_months,
                self.id.take(),
                self.livemode,
                self.max_redemptions,
                self.metadata.take(),
                self.name.take(),
                self.percent_off,
                self.redeem_by,
                self.times_redeemed,
                self.valid,
            )
            else {
                return None;
            };
            Some(Self::Out {
                amount_off,
                applies_to,
                created,
                currency,
                currency_options,
                duration,
                duration_in_months,
                id,
                livemode,
                max_redemptions,
                metadata,
                name,
                percent_off,
                redeem_by,
                times_redeemed,
                valid,
            })
        }
    }

    impl Map for Builder<'_> {
        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
            self.builder.key(k)
        }

        fn finish(&mut self) -> Result<()> {
            *self.out = self.builder.take_out();
            Ok(())
        }
    }

    impl ObjectDeser for Coupon {
        type Builder = CouponBuilder;
    }

    impl FromValueOpt for Coupon {
        fn from_value(v: Value) -> Option<Self> {
            let Value::Object(obj) = v else {
                return None;
            };
            let mut b = CouponBuilder::deser_default();
            for (k, v) in obj {
                match k.as_str() {
                    "amount_off" => b.amount_off = FromValueOpt::from_value(v),
                    "applies_to" => b.applies_to = FromValueOpt::from_value(v),
                    "created" => b.created = FromValueOpt::from_value(v),
                    "currency" => b.currency = FromValueOpt::from_value(v),
                    "currency_options" => b.currency_options = FromValueOpt::from_value(v),
                    "duration" => b.duration = FromValueOpt::from_value(v),
                    "duration_in_months" => b.duration_in_months = FromValueOpt::from_value(v),
                    "id" => b.id = FromValueOpt::from_value(v),
                    "livemode" => b.livemode = FromValueOpt::from_value(v),
                    "max_redemptions" => b.max_redemptions = FromValueOpt::from_value(v),
                    "metadata" => b.metadata = FromValueOpt::from_value(v),
                    "name" => b.name = FromValueOpt::from_value(v),
                    "percent_off" => b.percent_off = FromValueOpt::from_value(v),
                    "redeem_by" => b.redeem_by = FromValueOpt::from_value(v),
                    "times_redeemed" => b.times_redeemed = FromValueOpt::from_value(v),
                    "valid" => b.valid = FromValueOpt::from_value(v),
                    _ => {}
                }
            }
            b.take_out()
        }
    }
};
#[cfg(feature = "serialize")]
impl serde::Serialize for Coupon {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        use serde::ser::SerializeStruct;
        let mut s = s.serialize_struct("Coupon", 17)?;
        s.serialize_field("amount_off", &self.amount_off)?;
        s.serialize_field("applies_to", &self.applies_to)?;
        s.serialize_field("created", &self.created)?;
        s.serialize_field("currency", &self.currency)?;
        s.serialize_field("currency_options", &self.currency_options)?;
        s.serialize_field("duration", &self.duration)?;
        s.serialize_field("duration_in_months", &self.duration_in_months)?;
        s.serialize_field("id", &self.id)?;
        s.serialize_field("livemode", &self.livemode)?;
        s.serialize_field("max_redemptions", &self.max_redemptions)?;
        s.serialize_field("metadata", &self.metadata)?;
        s.serialize_field("name", &self.name)?;
        s.serialize_field("percent_off", &self.percent_off)?;
        s.serialize_field("redeem_by", &self.redeem_by)?;
        s.serialize_field("times_redeemed", &self.times_redeemed)?;
        s.serialize_field("valid", &self.valid)?;

        s.serialize_field("object", "coupon")?;
        s.end()
    }
}
impl stripe_types::Object for Coupon {
    type Id = stripe_shared::CouponId;
    fn id(&self) -> &Self::Id {
        &self.id
    }

    fn into_id(self) -> Self::Id {
        self.id
    }
}
stripe_types::def_id!(CouponId);
#[derive(Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum CouponDuration {
    Forever,
    Once,
    Repeating,
    /// An unrecognized value from Stripe. Should not be used as a request parameter.
    Unknown(String),
}
impl CouponDuration {
    pub fn as_str(&self) -> &str {
        use CouponDuration::*;
        match self {
            Forever => "forever",
            Once => "once",
            Repeating => "repeating",
            Unknown(v) => v,
        }
    }
}

impl std::str::FromStr for CouponDuration {
    type Err = std::convert::Infallible;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        use CouponDuration::*;
        match s {
            "forever" => Ok(Forever),
            "once" => Ok(Once),
            "repeating" => Ok(Repeating),
            v => {
                tracing::warn!("Unknown value '{}' for enum '{}'", v, "CouponDuration");
                Ok(Unknown(v.to_owned()))
            }
        }
    }
}
impl std::fmt::Display for CouponDuration {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

#[cfg(not(feature = "redact-generated-debug"))]
impl std::fmt::Debug for CouponDuration {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}
#[cfg(feature = "redact-generated-debug")]
impl std::fmt::Debug for CouponDuration {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct(stringify!(CouponDuration)).finish_non_exhaustive()
    }
}
impl serde::Serialize for CouponDuration {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}
impl miniserde::Deserialize for CouponDuration {
    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
        crate::Place::new(out)
    }
}

impl miniserde::de::Visitor for crate::Place<CouponDuration> {
    fn string(&mut self, s: &str) -> miniserde::Result<()> {
        use std::str::FromStr;
        self.out = Some(CouponDuration::from_str(s).expect("infallible"));
        Ok(())
    }
}

stripe_types::impl_from_val_with_from_str!(CouponDuration);
#[cfg(feature = "deserialize")]
impl<'de> serde::Deserialize<'de> for CouponDuration {
    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        use std::str::FromStr;
        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
        Ok(Self::from_str(&s).expect("infallible"))
    }
}