async-stripe-shared 1.0.0-rc.6

/// These bank accounts are payment methods on `Customer` objects.
///
/// On the other hand [External Accounts](/api#external_accounts) are transfer
/// destinations on `Account` objects for connected accounts.
/// They can be bank accounts or debit cards as well, and are documented in the links above.
///
/// Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
#[derive(Clone)]
#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
pub struct BankAccount {
    /// The account this bank account belongs to.
    /// Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
    pub account: Option<stripe_types::Expandable<stripe_shared::Account>>,
    /// The name of the person or business that owns the bank account.
    pub account_holder_name: Option<String>,
    /// The type of entity that holds the account. This can be either `individual` or `company`.
    pub account_holder_type: Option<String>,
    /// The bank account type.
    /// This can only be `checking` or `savings` in most countries.
    /// In Japan, this can only be `futsu` or `toza`.
    pub account_type: Option<String>,
    /// A set of available payout methods for this bank account.
    /// Only values from this set should be passed as the `method` when creating a payout.
    pub available_payout_methods: Option<Vec<BankAccountAvailablePayoutMethods>>,
    /// Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
    pub bank_name: Option<String>,
    /// Two-letter ISO code representing the country the bank account is located in.
    pub country: String,
    /// Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
    pub currency: stripe_types::Currency,
    /// The ID of the customer that the bank account is associated with.
    pub customer: Option<stripe_types::Expandable<stripe_shared::Customer>>,
    /// Whether this bank account is the default external account for its currency.
    pub default_for_currency: Option<bool>,
    /// Uniquely identifies this particular bank account.
    /// You can use this attribute to check whether two bank accounts are the same.
    pub fingerprint: Option<String>,
    /// Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
    pub future_requirements: Option<stripe_shared::ExternalAccountRequirements>,
    /// Unique identifier for the object.
    pub id: stripe_shared::BankAccountId,
    /// The last four digits of the bank account number.
    pub last4: String,
    /// 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>>,
    /// Information about the requirements for the bank account, including what information needs to be collected.
    pub requirements: Option<stripe_shared::ExternalAccountRequirements>,
    /// The routing transit number for the bank account.
    pub routing_number: Option<String>,
    /// For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`.
    /// A bank account that hasn't had any activity or validation performed is `new`.
    /// If Stripe can determine that the bank account exists, its status will be `validated`.
    /// Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run.
    /// If customer bank account verification has succeeded, the bank account status will be `verified`.
    /// If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`.
    /// If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation.
    /// This account will need to be reverified to continue using it for money movement.
    /// If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
    ///
    /// For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`.
    /// If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated.
    /// In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`.
    /// Other validations aren't run against external accounts because they're only used for payouts.
    /// This means the other statuses don't apply.
    pub status: String,
}
#[cfg(feature = "redact-generated-debug")]
impl std::fmt::Debug for BankAccount {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("BankAccount").finish_non_exhaustive()
    }
}
#[doc(hidden)]
pub struct BankAccountBuilder {
    account: Option<Option<stripe_types::Expandable<stripe_shared::Account>>>,
    account_holder_name: Option<Option<String>>,
    account_holder_type: Option<Option<String>>,
    account_type: Option<Option<String>>,
    available_payout_methods: Option<Option<Vec<BankAccountAvailablePayoutMethods>>>,
    bank_name: Option<Option<String>>,
    country: Option<String>,
    currency: Option<stripe_types::Currency>,
    customer: Option<Option<stripe_types::Expandable<stripe_shared::Customer>>>,
    default_for_currency: Option<Option<bool>>,
    fingerprint: Option<Option<String>>,
    future_requirements: Option<Option<stripe_shared::ExternalAccountRequirements>>,
    id: Option<stripe_shared::BankAccountId>,
    last4: Option<String>,
    metadata: Option<Option<std::collections::HashMap<String, String>>>,
    requirements: Option<Option<stripe_shared::ExternalAccountRequirements>>,
    routing_number: Option<Option<String>>,
    status: Option<String>,
}

#[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 BankAccount {
        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
            Place::new(out)
        }
    }

    struct Builder<'a> {
        out: &'a mut Option<BankAccount>,
        builder: BankAccountBuilder,
    }

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

    impl MapBuilder for BankAccountBuilder {
        type Out = BankAccount;
        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
            Ok(match k {
                "account" => Deserialize::begin(&mut self.account),
                "account_holder_name" => Deserialize::begin(&mut self.account_holder_name),
                "account_holder_type" => Deserialize::begin(&mut self.account_holder_type),
                "account_type" => Deserialize::begin(&mut self.account_type),
                "available_payout_methods" => {
                    Deserialize::begin(&mut self.available_payout_methods)
                }
                "bank_name" => Deserialize::begin(&mut self.bank_name),
                "country" => Deserialize::begin(&mut self.country),
                "currency" => Deserialize::begin(&mut self.currency),
                "customer" => Deserialize::begin(&mut self.customer),
                "default_for_currency" => Deserialize::begin(&mut self.default_for_currency),
                "fingerprint" => Deserialize::begin(&mut self.fingerprint),
                "future_requirements" => Deserialize::begin(&mut self.future_requirements),
                "id" => Deserialize::begin(&mut self.id),
                "last4" => Deserialize::begin(&mut self.last4),
                "metadata" => Deserialize::begin(&mut self.metadata),
                "requirements" => Deserialize::begin(&mut self.requirements),
                "routing_number" => Deserialize::begin(&mut self.routing_number),
                "status" => Deserialize::begin(&mut self.status),
                _ => <dyn Visitor>::ignore(),
            })
        }

        fn deser_default() -> Self {
            Self {
                account: Some(None),
                account_holder_name: Some(None),
                account_holder_type: Some(None),
                account_type: Some(None),
                available_payout_methods: Some(None),
                bank_name: Some(None),
                country: None,
                currency: None,
                customer: Some(None),
                default_for_currency: Some(None),
                fingerprint: Some(None),
                future_requirements: Some(None),
                id: None,
                last4: None,
                metadata: Some(None),
                requirements: Some(None),
                routing_number: Some(None),
                status: None,
            }
        }

        fn take_out(&mut self) -> Option<Self::Out> {
            let (
                Some(account),
                Some(account_holder_name),
                Some(account_holder_type),
                Some(account_type),
                Some(available_payout_methods),
                Some(bank_name),
                Some(country),
                Some(currency),
                Some(customer),
                Some(default_for_currency),
                Some(fingerprint),
                Some(future_requirements),
                Some(id),
                Some(last4),
                Some(metadata),
                Some(requirements),
                Some(routing_number),
                Some(status),
            ) = (
                self.account.take(),
                self.account_holder_name.take(),
                self.account_holder_type.take(),
                self.account_type.take(),
                self.available_payout_methods.take(),
                self.bank_name.take(),
                self.country.take(),
                self.currency.take(),
                self.customer.take(),
                self.default_for_currency,
                self.fingerprint.take(),
                self.future_requirements.take(),
                self.id.take(),
                self.last4.take(),
                self.metadata.take(),
                self.requirements.take(),
                self.routing_number.take(),
                self.status.take(),
            )
            else {
                return None;
            };
            Some(Self::Out {
                account,
                account_holder_name,
                account_holder_type,
                account_type,
                available_payout_methods,
                bank_name,
                country,
                currency,
                customer,
                default_for_currency,
                fingerprint,
                future_requirements,
                id,
                last4,
                metadata,
                requirements,
                routing_number,
                status,
            })
        }
    }

    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 BankAccount {
        type Builder = BankAccountBuilder;
    }

    impl FromValueOpt for BankAccount {
        fn from_value(v: Value) -> Option<Self> {
            let Value::Object(obj) = v else {
                return None;
            };
            let mut b = BankAccountBuilder::deser_default();
            for (k, v) in obj {
                match k.as_str() {
                    "account" => b.account = FromValueOpt::from_value(v),
                    "account_holder_name" => b.account_holder_name = FromValueOpt::from_value(v),
                    "account_holder_type" => b.account_holder_type = FromValueOpt::from_value(v),
                    "account_type" => b.account_type = FromValueOpt::from_value(v),
                    "available_payout_methods" => {
                        b.available_payout_methods = FromValueOpt::from_value(v)
                    }
                    "bank_name" => b.bank_name = FromValueOpt::from_value(v),
                    "country" => b.country = FromValueOpt::from_value(v),
                    "currency" => b.currency = FromValueOpt::from_value(v),
                    "customer" => b.customer = FromValueOpt::from_value(v),
                    "default_for_currency" => b.default_for_currency = FromValueOpt::from_value(v),
                    "fingerprint" => b.fingerprint = FromValueOpt::from_value(v),
                    "future_requirements" => b.future_requirements = FromValueOpt::from_value(v),
                    "id" => b.id = FromValueOpt::from_value(v),
                    "last4" => b.last4 = FromValueOpt::from_value(v),
                    "metadata" => b.metadata = FromValueOpt::from_value(v),
                    "requirements" => b.requirements = FromValueOpt::from_value(v),
                    "routing_number" => b.routing_number = FromValueOpt::from_value(v),
                    "status" => b.status = FromValueOpt::from_value(v),
                    _ => {}
                }
            }
            b.take_out()
        }
    }
};
#[cfg(feature = "serialize")]
impl serde::Serialize for BankAccount {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        use serde::ser::SerializeStruct;
        let mut s = s.serialize_struct("BankAccount", 19)?;
        s.serialize_field("account", &self.account)?;
        s.serialize_field("account_holder_name", &self.account_holder_name)?;
        s.serialize_field("account_holder_type", &self.account_holder_type)?;
        s.serialize_field("account_type", &self.account_type)?;
        s.serialize_field("available_payout_methods", &self.available_payout_methods)?;
        s.serialize_field("bank_name", &self.bank_name)?;
        s.serialize_field("country", &self.country)?;
        s.serialize_field("currency", &self.currency)?;
        s.serialize_field("customer", &self.customer)?;
        s.serialize_field("default_for_currency", &self.default_for_currency)?;
        s.serialize_field("fingerprint", &self.fingerprint)?;
        s.serialize_field("future_requirements", &self.future_requirements)?;
        s.serialize_field("id", &self.id)?;
        s.serialize_field("last4", &self.last4)?;
        s.serialize_field("metadata", &self.metadata)?;
        s.serialize_field("requirements", &self.requirements)?;
        s.serialize_field("routing_number", &self.routing_number)?;
        s.serialize_field("status", &self.status)?;

        s.serialize_field("object", "bank_account")?;
        s.end()
    }
}
/// A set of available payout methods for this bank account.
/// Only values from this set should be passed as the `method` when creating a payout.
#[derive(Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum BankAccountAvailablePayoutMethods {
    Instant,
    Standard,
    /// An unrecognized value from Stripe. Should not be used as a request parameter.
    Unknown(String),
}
impl BankAccountAvailablePayoutMethods {
    pub fn as_str(&self) -> &str {
        use BankAccountAvailablePayoutMethods::*;
        match self {
            Instant => "instant",
            Standard => "standard",
            Unknown(v) => v,
        }
    }
}

impl std::str::FromStr for BankAccountAvailablePayoutMethods {
    type Err = std::convert::Infallible;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        use BankAccountAvailablePayoutMethods::*;
        match s {
            "instant" => Ok(Instant),
            "standard" => Ok(Standard),
            v => {
                tracing::warn!(
                    "Unknown value '{}' for enum '{}'",
                    v,
                    "BankAccountAvailablePayoutMethods"
                );
                Ok(Unknown(v.to_owned()))
            }
        }
    }
}
impl std::fmt::Display for BankAccountAvailablePayoutMethods {
    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 BankAccountAvailablePayoutMethods {
    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 BankAccountAvailablePayoutMethods {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct(stringify!(BankAccountAvailablePayoutMethods)).finish_non_exhaustive()
    }
}
#[cfg(feature = "serialize")]
impl serde::Serialize for BankAccountAvailablePayoutMethods {
    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 BankAccountAvailablePayoutMethods {
    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
        crate::Place::new(out)
    }
}

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

stripe_types::impl_from_val_with_from_str!(BankAccountAvailablePayoutMethods);
#[cfg(feature = "deserialize")]
impl<'de> serde::Deserialize<'de> for BankAccountAvailablePayoutMethods {
    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"))
    }
}
impl stripe_types::Object for BankAccount {
    type Id = stripe_shared::BankAccountId;
    fn id(&self) -> &Self::Id {
        &self.id
    }

    fn into_id(self) -> Self::Id {
        self.id
    }
}
stripe_types::def_id!(BankAccountId);