stripe_shared/
file_link.rs

1/// To share the contents of a `File` object with non-Stripe users, you can
2/// create a `FileLink`. `FileLink`s contain a URL that you can use to
3/// retrieve the contents of the file without authentication.
4///
5/// For more details see <<https://stripe.com/docs/api/file_links/object>>.
6#[derive(Clone, Debug)]
7#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
8pub struct FileLink {
9    /// Time at which the object was created. Measured in seconds since the Unix epoch.
10    pub created: stripe_types::Timestamp,
11    /// Returns if the link is already expired.
12    pub expired: bool,
13    /// Time that the link expires.
14    pub expires_at: Option<stripe_types::Timestamp>,
15    /// The file object this link points to.
16    pub file: stripe_types::Expandable<stripe_shared::File>,
17    /// Unique identifier for the object.
18    pub id: stripe_shared::FileLinkId,
19    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
20    pub livemode: bool,
21    /// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
22    /// This can be useful for storing additional information about the object in a structured format.
23    pub metadata: std::collections::HashMap<String, String>,
24    /// The publicly accessible URL to download the file.
25    pub url: Option<String>,
26}
27#[doc(hidden)]
28pub struct FileLinkBuilder {
29    created: Option<stripe_types::Timestamp>,
30    expired: Option<bool>,
31    expires_at: Option<Option<stripe_types::Timestamp>>,
32    file: Option<stripe_types::Expandable<stripe_shared::File>>,
33    id: Option<stripe_shared::FileLinkId>,
34    livemode: Option<bool>,
35    metadata: Option<std::collections::HashMap<String, String>>,
36    url: Option<Option<String>>,
37}
38
39#[allow(
40    unused_variables,
41    irrefutable_let_patterns,
42    clippy::let_unit_value,
43    clippy::match_single_binding,
44    clippy::single_match
45)]
46const _: () = {
47    use miniserde::de::{Map, Visitor};
48    use miniserde::json::Value;
49    use miniserde::{make_place, Deserialize, Result};
50    use stripe_types::miniserde_helpers::FromValueOpt;
51    use stripe_types::{MapBuilder, ObjectDeser};
52
53    make_place!(Place);
54
55    impl Deserialize for FileLink {
56        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
57            Place::new(out)
58        }
59    }
60
61    struct Builder<'a> {
62        out: &'a mut Option<FileLink>,
63        builder: FileLinkBuilder,
64    }
65
66    impl Visitor for Place<FileLink> {
67        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
68            Ok(Box::new(Builder { out: &mut self.out, builder: FileLinkBuilder::deser_default() }))
69        }
70    }
71
72    impl MapBuilder for FileLinkBuilder {
73        type Out = FileLink;
74        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
75            Ok(match k {
76                "created" => Deserialize::begin(&mut self.created),
77                "expired" => Deserialize::begin(&mut self.expired),
78                "expires_at" => Deserialize::begin(&mut self.expires_at),
79                "file" => Deserialize::begin(&mut self.file),
80                "id" => Deserialize::begin(&mut self.id),
81                "livemode" => Deserialize::begin(&mut self.livemode),
82                "metadata" => Deserialize::begin(&mut self.metadata),
83                "url" => Deserialize::begin(&mut self.url),
84
85                _ => <dyn Visitor>::ignore(),
86            })
87        }
88
89        fn deser_default() -> Self {
90            Self {
91                created: Deserialize::default(),
92                expired: Deserialize::default(),
93                expires_at: Deserialize::default(),
94                file: Deserialize::default(),
95                id: Deserialize::default(),
96                livemode: Deserialize::default(),
97                metadata: Deserialize::default(),
98                url: Deserialize::default(),
99            }
100        }
101
102        fn take_out(&mut self) -> Option<Self::Out> {
103            let (
104                Some(created),
105                Some(expired),
106                Some(expires_at),
107                Some(file),
108                Some(id),
109                Some(livemode),
110                Some(metadata),
111                Some(url),
112            ) = (
113                self.created,
114                self.expired,
115                self.expires_at,
116                self.file.take(),
117                self.id.take(),
118                self.livemode,
119                self.metadata.take(),
120                self.url.take(),
121            )
122            else {
123                return None;
124            };
125            Some(Self::Out { created, expired, expires_at, file, id, livemode, metadata, url })
126        }
127    }
128
129    impl<'a> Map for Builder<'a> {
130        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
131            self.builder.key(k)
132        }
133
134        fn finish(&mut self) -> Result<()> {
135            *self.out = self.builder.take_out();
136            Ok(())
137        }
138    }
139
140    impl ObjectDeser for FileLink {
141        type Builder = FileLinkBuilder;
142    }
143
144    impl FromValueOpt for FileLink {
145        fn from_value(v: Value) -> Option<Self> {
146            let Value::Object(obj) = v else {
147                return None;
148            };
149            let mut b = FileLinkBuilder::deser_default();
150            for (k, v) in obj {
151                match k.as_str() {
152                    "created" => b.created = FromValueOpt::from_value(v),
153                    "expired" => b.expired = FromValueOpt::from_value(v),
154                    "expires_at" => b.expires_at = FromValueOpt::from_value(v),
155                    "file" => b.file = FromValueOpt::from_value(v),
156                    "id" => b.id = FromValueOpt::from_value(v),
157                    "livemode" => b.livemode = FromValueOpt::from_value(v),
158                    "metadata" => b.metadata = FromValueOpt::from_value(v),
159                    "url" => b.url = FromValueOpt::from_value(v),
160
161                    _ => {}
162                }
163            }
164            b.take_out()
165        }
166    }
167};
168#[cfg(feature = "serialize")]
169impl serde::Serialize for FileLink {
170    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
171        use serde::ser::SerializeStruct;
172        let mut s = s.serialize_struct("FileLink", 9)?;
173        s.serialize_field("created", &self.created)?;
174        s.serialize_field("expired", &self.expired)?;
175        s.serialize_field("expires_at", &self.expires_at)?;
176        s.serialize_field("file", &self.file)?;
177        s.serialize_field("id", &self.id)?;
178        s.serialize_field("livemode", &self.livemode)?;
179        s.serialize_field("metadata", &self.metadata)?;
180        s.serialize_field("url", &self.url)?;
181
182        s.serialize_field("object", "file_link")?;
183        s.end()
184    }
185}
186impl stripe_types::Object for FileLink {
187    type Id = stripe_shared::FileLinkId;
188    fn id(&self) -> &Self::Id {
189        &self.id
190    }
191
192    fn into_id(self) -> Self::Id {
193        self.id
194    }
195}
196stripe_types::def_id!(FileLinkId);
stripe_shared/file_link.rs

stripe_shared/
file_link.rs
