Skip to main content

stripe_misc/
gelato_session_document_options.rs

1#[derive(Clone, Eq, PartialEq)]
2#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
3#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
4#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
5pub struct GelatoSessionDocumentOptions {
6    /// Array of strings of allowed identity document types.
7    /// If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
8    pub allowed_types: Option<Vec<GelatoSessionDocumentOptionsAllowedTypes>>,
9    /// Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.
10    pub require_id_number: Option<bool>,
11    /// Disable image uploads, identity document images have to be captured using the device’s camera.
12    pub require_live_capture: Option<bool>,
13    /// Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face.
14    /// [Learn more](https://docs.stripe.com/identity/selfie).
15    pub require_matching_selfie: Option<bool>,
16}
17#[cfg(feature = "redact-generated-debug")]
18impl std::fmt::Debug for GelatoSessionDocumentOptions {
19    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
20        f.debug_struct("GelatoSessionDocumentOptions").finish_non_exhaustive()
21    }
22}
23#[doc(hidden)]
24pub struct GelatoSessionDocumentOptionsBuilder {
25    allowed_types: Option<Option<Vec<GelatoSessionDocumentOptionsAllowedTypes>>>,
26    require_id_number: Option<Option<bool>>,
27    require_live_capture: Option<Option<bool>>,
28    require_matching_selfie: Option<Option<bool>>,
29}
30
31#[allow(
32    unused_variables,
33    irrefutable_let_patterns,
34    clippy::let_unit_value,
35    clippy::match_single_binding,
36    clippy::single_match
37)]
38const _: () = {
39    use miniserde::de::{Map, Visitor};
40    use miniserde::json::Value;
41    use miniserde::{Deserialize, Result, make_place};
42    use stripe_types::miniserde_helpers::FromValueOpt;
43    use stripe_types::{MapBuilder, ObjectDeser};
44
45    make_place!(Place);
46
47    impl Deserialize for GelatoSessionDocumentOptions {
48        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
49            Place::new(out)
50        }
51    }
52
53    struct Builder<'a> {
54        out: &'a mut Option<GelatoSessionDocumentOptions>,
55        builder: GelatoSessionDocumentOptionsBuilder,
56    }
57
58    impl Visitor for Place<GelatoSessionDocumentOptions> {
59        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
60            Ok(Box::new(Builder {
61                out: &mut self.out,
62                builder: GelatoSessionDocumentOptionsBuilder::deser_default(),
63            }))
64        }
65    }
66
67    impl MapBuilder for GelatoSessionDocumentOptionsBuilder {
68        type Out = GelatoSessionDocumentOptions;
69        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
70            Ok(match k {
71                "allowed_types" => Deserialize::begin(&mut self.allowed_types),
72                "require_id_number" => Deserialize::begin(&mut self.require_id_number),
73                "require_live_capture" => Deserialize::begin(&mut self.require_live_capture),
74                "require_matching_selfie" => Deserialize::begin(&mut self.require_matching_selfie),
75                _ => <dyn Visitor>::ignore(),
76            })
77        }
78
79        fn deser_default() -> Self {
80            Self {
81                allowed_types: Some(None),
82                require_id_number: Some(None),
83                require_live_capture: Some(None),
84                require_matching_selfie: Some(None),
85            }
86        }
87
88        fn take_out(&mut self) -> Option<Self::Out> {
89            let (
90                Some(allowed_types),
91                Some(require_id_number),
92                Some(require_live_capture),
93                Some(require_matching_selfie),
94            ) = (
95                self.allowed_types.take(),
96                self.require_id_number,
97                self.require_live_capture,
98                self.require_matching_selfie,
99            )
100            else {
101                return None;
102            };
103            Some(Self::Out {
104                allowed_types,
105                require_id_number,
106                require_live_capture,
107                require_matching_selfie,
108            })
109        }
110    }
111
112    impl Map for Builder<'_> {
113        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
114            self.builder.key(k)
115        }
116
117        fn finish(&mut self) -> Result<()> {
118            *self.out = self.builder.take_out();
119            Ok(())
120        }
121    }
122
123    impl ObjectDeser for GelatoSessionDocumentOptions {
124        type Builder = GelatoSessionDocumentOptionsBuilder;
125    }
126
127    impl FromValueOpt for GelatoSessionDocumentOptions {
128        fn from_value(v: Value) -> Option<Self> {
129            let Value::Object(obj) = v else {
130                return None;
131            };
132            let mut b = GelatoSessionDocumentOptionsBuilder::deser_default();
133            for (k, v) in obj {
134                match k.as_str() {
135                    "allowed_types" => b.allowed_types = FromValueOpt::from_value(v),
136                    "require_id_number" => b.require_id_number = FromValueOpt::from_value(v),
137                    "require_live_capture" => b.require_live_capture = FromValueOpt::from_value(v),
138                    "require_matching_selfie" => {
139                        b.require_matching_selfie = FromValueOpt::from_value(v)
140                    }
141                    _ => {}
142                }
143            }
144            b.take_out()
145        }
146    }
147};
148/// Array of strings of allowed identity document types.
149/// If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
150#[derive(Clone, Eq, PartialEq)]
151#[non_exhaustive]
152pub enum GelatoSessionDocumentOptionsAllowedTypes {
153    DrivingLicense,
154    IdCard,
155    Passport,
156    /// An unrecognized value from Stripe. Should not be used as a request parameter.
157    Unknown(String),
158}
159impl GelatoSessionDocumentOptionsAllowedTypes {
160    pub fn as_str(&self) -> &str {
161        use GelatoSessionDocumentOptionsAllowedTypes::*;
162        match self {
163            DrivingLicense => "driving_license",
164            IdCard => "id_card",
165            Passport => "passport",
166            Unknown(v) => v,
167        }
168    }
169}
170
171impl std::str::FromStr for GelatoSessionDocumentOptionsAllowedTypes {
172    type Err = std::convert::Infallible;
173    fn from_str(s: &str) -> Result<Self, Self::Err> {
174        use GelatoSessionDocumentOptionsAllowedTypes::*;
175        match s {
176            "driving_license" => Ok(DrivingLicense),
177            "id_card" => Ok(IdCard),
178            "passport" => Ok(Passport),
179            v => {
180                tracing::warn!(
181                    "Unknown value '{}' for enum '{}'",
182                    v,
183                    "GelatoSessionDocumentOptionsAllowedTypes"
184                );
185                Ok(Unknown(v.to_owned()))
186            }
187        }
188    }
189}
190impl std::fmt::Display for GelatoSessionDocumentOptionsAllowedTypes {
191    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
192        f.write_str(self.as_str())
193    }
194}
195
196#[cfg(not(feature = "redact-generated-debug"))]
197impl std::fmt::Debug for GelatoSessionDocumentOptionsAllowedTypes {
198    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
199        f.write_str(self.as_str())
200    }
201}
202#[cfg(feature = "redact-generated-debug")]
203impl std::fmt::Debug for GelatoSessionDocumentOptionsAllowedTypes {
204    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
205        f.debug_struct(stringify!(GelatoSessionDocumentOptionsAllowedTypes)).finish_non_exhaustive()
206    }
207}
208#[cfg(feature = "serialize")]
209impl serde::Serialize for GelatoSessionDocumentOptionsAllowedTypes {
210    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
211    where
212        S: serde::Serializer,
213    {
214        serializer.serialize_str(self.as_str())
215    }
216}
217impl miniserde::Deserialize for GelatoSessionDocumentOptionsAllowedTypes {
218    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
219        crate::Place::new(out)
220    }
221}
222
223impl miniserde::de::Visitor for crate::Place<GelatoSessionDocumentOptionsAllowedTypes> {
224    fn string(&mut self, s: &str) -> miniserde::Result<()> {
225        use std::str::FromStr;
226        self.out = Some(GelatoSessionDocumentOptionsAllowedTypes::from_str(s).expect("infallible"));
227        Ok(())
228    }
229}
230
231stripe_types::impl_from_val_with_from_str!(GelatoSessionDocumentOptionsAllowedTypes);
232#[cfg(feature = "deserialize")]
233impl<'de> serde::Deserialize<'de> for GelatoSessionDocumentOptionsAllowedTypes {
234    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
235        use std::str::FromStr;
236        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
237        Ok(Self::from_str(&s).expect("infallible"))
238    }
239}