stripe_shared/
issuing_token.rs

1/// An issuing token object is created when an issued card is added to a digital wallet.
2/// As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.
3///
4/// For more details see <<https://stripe.com/docs/api/issuing/tokens/object>>.
5#[derive(Clone, Debug)]
6#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
7pub struct IssuingToken {
8    /// Card associated with this token.
9    pub card: stripe_types::Expandable<stripe_shared::IssuingCard>,
10    /// Time at which the object was created. Measured in seconds since the Unix epoch.
11    pub created: stripe_types::Timestamp,
12    /// The hashed ID derived from the device ID from the card network associated with the token.
13    pub device_fingerprint: Option<String>,
14    /// Unique identifier for the object.
15    pub id: stripe_shared::IssuingTokenId,
16    /// The last four digits of the token.
17    pub last4: Option<String>,
18    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
19    pub livemode: bool,
20    /// The token service provider / card network associated with the token.
21    pub network: IssuingTokenNetwork,
22    pub network_data: Option<stripe_shared::IssuingNetworkTokenNetworkData>,
23    /// Time at which the token was last updated by the card network.
24    /// Measured in seconds since the Unix epoch.
25    pub network_updated_at: stripe_types::Timestamp,
26    /// The usage state of the token.
27    pub status: stripe_shared::IssuingTokenStatus,
28    /// The digital wallet for this token, if one was used.
29    pub wallet_provider: Option<IssuingTokenWalletProvider>,
30}
31#[doc(hidden)]
32pub struct IssuingTokenBuilder {
33    card: Option<stripe_types::Expandable<stripe_shared::IssuingCard>>,
34    created: Option<stripe_types::Timestamp>,
35    device_fingerprint: Option<Option<String>>,
36    id: Option<stripe_shared::IssuingTokenId>,
37    last4: Option<Option<String>>,
38    livemode: Option<bool>,
39    network: Option<IssuingTokenNetwork>,
40    network_data: Option<Option<stripe_shared::IssuingNetworkTokenNetworkData>>,
41    network_updated_at: Option<stripe_types::Timestamp>,
42    status: Option<stripe_shared::IssuingTokenStatus>,
43    wallet_provider: Option<Option<IssuingTokenWalletProvider>>,
44}
45
46#[allow(
47    unused_variables,
48    irrefutable_let_patterns,
49    clippy::let_unit_value,
50    clippy::match_single_binding,
51    clippy::single_match
52)]
53const _: () = {
54    use miniserde::de::{Map, Visitor};
55    use miniserde::json::Value;
56    use miniserde::{Deserialize, Result, make_place};
57    use stripe_types::miniserde_helpers::FromValueOpt;
58    use stripe_types::{MapBuilder, ObjectDeser};
59
60    make_place!(Place);
61
62    impl Deserialize for IssuingToken {
63        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
64            Place::new(out)
65        }
66    }
67
68    struct Builder<'a> {
69        out: &'a mut Option<IssuingToken>,
70        builder: IssuingTokenBuilder,
71    }
72
73    impl Visitor for Place<IssuingToken> {
74        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
75            Ok(Box::new(Builder {
76                out: &mut self.out,
77                builder: IssuingTokenBuilder::deser_default(),
78            }))
79        }
80    }
81
82    impl MapBuilder for IssuingTokenBuilder {
83        type Out = IssuingToken;
84        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
85            Ok(match k {
86                "card" => Deserialize::begin(&mut self.card),
87                "created" => Deserialize::begin(&mut self.created),
88                "device_fingerprint" => Deserialize::begin(&mut self.device_fingerprint),
89                "id" => Deserialize::begin(&mut self.id),
90                "last4" => Deserialize::begin(&mut self.last4),
91                "livemode" => Deserialize::begin(&mut self.livemode),
92                "network" => Deserialize::begin(&mut self.network),
93                "network_data" => Deserialize::begin(&mut self.network_data),
94                "network_updated_at" => Deserialize::begin(&mut self.network_updated_at),
95                "status" => Deserialize::begin(&mut self.status),
96                "wallet_provider" => Deserialize::begin(&mut self.wallet_provider),
97                _ => <dyn Visitor>::ignore(),
98            })
99        }
100
101        fn deser_default() -> Self {
102            Self {
103                card: Deserialize::default(),
104                created: Deserialize::default(),
105                device_fingerprint: Deserialize::default(),
106                id: Deserialize::default(),
107                last4: Deserialize::default(),
108                livemode: Deserialize::default(),
109                network: Deserialize::default(),
110                network_data: Deserialize::default(),
111                network_updated_at: Deserialize::default(),
112                status: Deserialize::default(),
113                wallet_provider: Deserialize::default(),
114            }
115        }
116
117        fn take_out(&mut self) -> Option<Self::Out> {
118            let (
119                Some(card),
120                Some(created),
121                Some(device_fingerprint),
122                Some(id),
123                Some(last4),
124                Some(livemode),
125                Some(network),
126                Some(network_data),
127                Some(network_updated_at),
128                Some(status),
129                Some(wallet_provider),
130            ) = (
131                self.card.take(),
132                self.created,
133                self.device_fingerprint.take(),
134                self.id.take(),
135                self.last4.take(),
136                self.livemode,
137                self.network,
138                self.network_data.take(),
139                self.network_updated_at,
140                self.status,
141                self.wallet_provider,
142            )
143            else {
144                return None;
145            };
146            Some(Self::Out {
147                card,
148                created,
149                device_fingerprint,
150                id,
151                last4,
152                livemode,
153                network,
154                network_data,
155                network_updated_at,
156                status,
157                wallet_provider,
158            })
159        }
160    }
161
162    impl Map for Builder<'_> {
163        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
164            self.builder.key(k)
165        }
166
167        fn finish(&mut self) -> Result<()> {
168            *self.out = self.builder.take_out();
169            Ok(())
170        }
171    }
172
173    impl ObjectDeser for IssuingToken {
174        type Builder = IssuingTokenBuilder;
175    }
176
177    impl FromValueOpt for IssuingToken {
178        fn from_value(v: Value) -> Option<Self> {
179            let Value::Object(obj) = v else {
180                return None;
181            };
182            let mut b = IssuingTokenBuilder::deser_default();
183            for (k, v) in obj {
184                match k.as_str() {
185                    "card" => b.card = FromValueOpt::from_value(v),
186                    "created" => b.created = FromValueOpt::from_value(v),
187                    "device_fingerprint" => b.device_fingerprint = FromValueOpt::from_value(v),
188                    "id" => b.id = FromValueOpt::from_value(v),
189                    "last4" => b.last4 = FromValueOpt::from_value(v),
190                    "livemode" => b.livemode = FromValueOpt::from_value(v),
191                    "network" => b.network = FromValueOpt::from_value(v),
192                    "network_data" => b.network_data = FromValueOpt::from_value(v),
193                    "network_updated_at" => b.network_updated_at = FromValueOpt::from_value(v),
194                    "status" => b.status = FromValueOpt::from_value(v),
195                    "wallet_provider" => b.wallet_provider = FromValueOpt::from_value(v),
196                    _ => {}
197                }
198            }
199            b.take_out()
200        }
201    }
202};
203#[cfg(feature = "serialize")]
204impl serde::Serialize for IssuingToken {
205    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
206        use serde::ser::SerializeStruct;
207        let mut s = s.serialize_struct("IssuingToken", 12)?;
208        s.serialize_field("card", &self.card)?;
209        s.serialize_field("created", &self.created)?;
210        s.serialize_field("device_fingerprint", &self.device_fingerprint)?;
211        s.serialize_field("id", &self.id)?;
212        s.serialize_field("last4", &self.last4)?;
213        s.serialize_field("livemode", &self.livemode)?;
214        s.serialize_field("network", &self.network)?;
215        s.serialize_field("network_data", &self.network_data)?;
216        s.serialize_field("network_updated_at", &self.network_updated_at)?;
217        s.serialize_field("status", &self.status)?;
218        s.serialize_field("wallet_provider", &self.wallet_provider)?;
219
220        s.serialize_field("object", "issuing.token")?;
221        s.end()
222    }
223}
224/// The token service provider / card network associated with the token.
225#[derive(Copy, Clone, Eq, PartialEq)]
226pub enum IssuingTokenNetwork {
227    Mastercard,
228    Visa,
229}
230impl IssuingTokenNetwork {
231    pub fn as_str(self) -> &'static str {
232        use IssuingTokenNetwork::*;
233        match self {
234            Mastercard => "mastercard",
235            Visa => "visa",
236        }
237    }
238}
239
240impl std::str::FromStr for IssuingTokenNetwork {
241    type Err = stripe_types::StripeParseError;
242    fn from_str(s: &str) -> Result<Self, Self::Err> {
243        use IssuingTokenNetwork::*;
244        match s {
245            "mastercard" => Ok(Mastercard),
246            "visa" => Ok(Visa),
247            _ => Err(stripe_types::StripeParseError),
248        }
249    }
250}
251impl std::fmt::Display for IssuingTokenNetwork {
252    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
253        f.write_str(self.as_str())
254    }
255}
256
257impl std::fmt::Debug for IssuingTokenNetwork {
258    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
259        f.write_str(self.as_str())
260    }
261}
262#[cfg(feature = "serialize")]
263impl serde::Serialize for IssuingTokenNetwork {
264    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
265    where
266        S: serde::Serializer,
267    {
268        serializer.serialize_str(self.as_str())
269    }
270}
271impl miniserde::Deserialize for IssuingTokenNetwork {
272    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
273        crate::Place::new(out)
274    }
275}
276
277impl miniserde::de::Visitor for crate::Place<IssuingTokenNetwork> {
278    fn string(&mut self, s: &str) -> miniserde::Result<()> {
279        use std::str::FromStr;
280        self.out = Some(IssuingTokenNetwork::from_str(s).map_err(|_| miniserde::Error)?);
281        Ok(())
282    }
283}
284
285stripe_types::impl_from_val_with_from_str!(IssuingTokenNetwork);
286#[cfg(feature = "deserialize")]
287impl<'de> serde::Deserialize<'de> for IssuingTokenNetwork {
288    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
289        use std::str::FromStr;
290        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
291        Self::from_str(&s)
292            .map_err(|_| serde::de::Error::custom("Unknown value for IssuingTokenNetwork"))
293    }
294}
295/// The digital wallet for this token, if one was used.
296#[derive(Copy, Clone, Eq, PartialEq)]
297pub enum IssuingTokenWalletProvider {
298    ApplePay,
299    GooglePay,
300    SamsungPay,
301}
302impl IssuingTokenWalletProvider {
303    pub fn as_str(self) -> &'static str {
304        use IssuingTokenWalletProvider::*;
305        match self {
306            ApplePay => "apple_pay",
307            GooglePay => "google_pay",
308            SamsungPay => "samsung_pay",
309        }
310    }
311}
312
313impl std::str::FromStr for IssuingTokenWalletProvider {
314    type Err = stripe_types::StripeParseError;
315    fn from_str(s: &str) -> Result<Self, Self::Err> {
316        use IssuingTokenWalletProvider::*;
317        match s {
318            "apple_pay" => Ok(ApplePay),
319            "google_pay" => Ok(GooglePay),
320            "samsung_pay" => Ok(SamsungPay),
321            _ => Err(stripe_types::StripeParseError),
322        }
323    }
324}
325impl std::fmt::Display for IssuingTokenWalletProvider {
326    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
327        f.write_str(self.as_str())
328    }
329}
330
331impl std::fmt::Debug for IssuingTokenWalletProvider {
332    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
333        f.write_str(self.as_str())
334    }
335}
336#[cfg(feature = "serialize")]
337impl serde::Serialize for IssuingTokenWalletProvider {
338    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
339    where
340        S: serde::Serializer,
341    {
342        serializer.serialize_str(self.as_str())
343    }
344}
345impl miniserde::Deserialize for IssuingTokenWalletProvider {
346    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
347        crate::Place::new(out)
348    }
349}
350
351impl miniserde::de::Visitor for crate::Place<IssuingTokenWalletProvider> {
352    fn string(&mut self, s: &str) -> miniserde::Result<()> {
353        use std::str::FromStr;
354        self.out = Some(IssuingTokenWalletProvider::from_str(s).map_err(|_| miniserde::Error)?);
355        Ok(())
356    }
357}
358
359stripe_types::impl_from_val_with_from_str!(IssuingTokenWalletProvider);
360#[cfg(feature = "deserialize")]
361impl<'de> serde::Deserialize<'de> for IssuingTokenWalletProvider {
362    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
363        use std::str::FromStr;
364        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
365        Self::from_str(&s)
366            .map_err(|_| serde::de::Error::custom("Unknown value for IssuingTokenWalletProvider"))
367    }
368}
369impl stripe_types::Object for IssuingToken {
370    type Id = stripe_shared::IssuingTokenId;
371    fn id(&self) -> &Self::Id {
372        &self.id
373    }
374
375    fn into_id(self) -> Self::Id {
376        self.id
377    }
378}
379stripe_types::def_id!(IssuingTokenId);
380#[derive(Copy, Clone, Eq, PartialEq)]
381pub enum IssuingTokenStatus {
382    Active,
383    Deleted,
384    Requested,
385    Suspended,
386}
387impl IssuingTokenStatus {
388    pub fn as_str(self) -> &'static str {
389        use IssuingTokenStatus::*;
390        match self {
391            Active => "active",
392            Deleted => "deleted",
393            Requested => "requested",
394            Suspended => "suspended",
395        }
396    }
397}
398
399impl std::str::FromStr for IssuingTokenStatus {
400    type Err = stripe_types::StripeParseError;
401    fn from_str(s: &str) -> Result<Self, Self::Err> {
402        use IssuingTokenStatus::*;
403        match s {
404            "active" => Ok(Active),
405            "deleted" => Ok(Deleted),
406            "requested" => Ok(Requested),
407            "suspended" => Ok(Suspended),
408            _ => Err(stripe_types::StripeParseError),
409        }
410    }
411}
412impl std::fmt::Display for IssuingTokenStatus {
413    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
414        f.write_str(self.as_str())
415    }
416}
417
418impl std::fmt::Debug for IssuingTokenStatus {
419    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
420        f.write_str(self.as_str())
421    }
422}
423impl serde::Serialize for IssuingTokenStatus {
424    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
425    where
426        S: serde::Serializer,
427    {
428        serializer.serialize_str(self.as_str())
429    }
430}
431impl miniserde::Deserialize for IssuingTokenStatus {
432    fn begin(out: &mut Option<Self>) -> &mut dyn miniserde::de::Visitor {
433        crate::Place::new(out)
434    }
435}
436
437impl miniserde::de::Visitor for crate::Place<IssuingTokenStatus> {
438    fn string(&mut self, s: &str) -> miniserde::Result<()> {
439        use std::str::FromStr;
440        self.out = Some(IssuingTokenStatus::from_str(s).map_err(|_| miniserde::Error)?);
441        Ok(())
442    }
443}
444
445stripe_types::impl_from_val_with_from_str!(IssuingTokenStatus);
446#[cfg(feature = "deserialize")]
447impl<'de> serde::Deserialize<'de> for IssuingTokenStatus {
448    fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
449        use std::str::FromStr;
450        let s: std::borrow::Cow<'de, str> = serde::Deserialize::deserialize(deserializer)?;
451        Self::from_str(&s)
452            .map_err(|_| serde::de::Error::custom("Unknown value for IssuingTokenStatus"))
453    }
454}
stripe_shared/issuing_token.rs

stripe_shared/
issuing_token.rs
