1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
// ====================================== // This file was automatically generated. // ====================================== use crate::config::{Client, Response}; use crate::ids::TopupId; use crate::params::{Expand, Expandable, List, Metadata, Object, RangeQuery, Timestamp}; use crate::resources::{BalanceTransaction, Currency, Source}; use serde_derive::{Deserialize, Serialize}; /// The resource representing a Stripe "Topup". /// /// For more details see [https://stripe.com/docs/api/topups/object](https://stripe.com/docs/api/topups/object). #[derive(Clone, Debug, Deserialize, Serialize)] pub struct Topup { /// Unique identifier for the object. pub id: TopupId, /// Amount transferred. pub amount: i64, /// ID of the balance transaction that describes the impact of this top-up on your account balance. /// /// May not be specified depending on status of top-up. #[serde(skip_serializing_if = "Option::is_none")] pub balance_transaction: Option<Expandable<BalanceTransaction>>, /// Time at which the object was created. /// /// Measured in seconds since the Unix epoch. pub created: Timestamp, /// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. /// /// Must be a [supported currency](https://stripe.com/docs/currencies). pub currency: Currency, /// An arbitrary string attached to the object. /// /// Often useful for displaying to users. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// Date the funds are expected to arrive in your Stripe account for payouts. /// /// This factors in delays like weekends or bank holidays. /// May not be specified depending on status of top-up. #[serde(skip_serializing_if = "Option::is_none")] pub expected_availability_date: Option<Timestamp>, /// Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). #[serde(skip_serializing_if = "Option::is_none")] pub failure_code: Option<String>, /// Message to user further explaining reason for top-up failure if available. #[serde(skip_serializing_if = "Option::is_none")] pub failure_message: Option<String>, /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. pub livemode: bool, /// Set of key-value pairs that you can attach to an object. /// /// This can be useful for storing additional information about the object in a structured format. pub metadata: Metadata, pub source: Source, /// Extra information about a top-up. /// /// This will appear on your source's bank statement. /// It must contain at least one letter. #[serde(skip_serializing_if = "Option::is_none")] pub statement_descriptor: Option<String>, /// The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. pub status: TopupStatus, /// A string that identifies this top-up as part of a group. #[serde(skip_serializing_if = "Option::is_none")] pub transfer_group: Option<String>, } impl Topup { /// Returns a list of top-ups. pub fn list(client: &Client, params: ListTopups<'_>) -> Response<List<Topup>> { client.get_query("/topups", ¶ms) } /// Retrieves the details of a top-up that has previously been created. /// /// Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information. pub fn retrieve(client: &Client, id: &TopupId, expand: &[&str]) -> Response<Topup> { client.get_query(&format!("/topups/{}", id), &Expand { expand }) } /// Updates the metadata of a top-up. /// /// Other top-up details are not editable by design. pub fn update(client: &Client, id: &TopupId, params: UpdateTopup<'_>) -> Response<Topup> { client.post_form(&format!("/topups/{}", id), ¶ms) } } impl Object for Topup { type Id = TopupId; fn id(&self) -> Self::Id { self.id.clone() } fn object(&self) -> &'static str { "topup" } } /// The parameters for `Topup::list`. #[derive(Clone, Debug, Serialize, Default)] pub struct ListTopups<'a> { /// A positive integer representing how much to transfer. #[serde(skip_serializing_if = "Option::is_none")] pub amount: Option<RangeQuery<Timestamp>>, /// A filter on the list, based on the object `created` field. /// /// The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. #[serde(skip_serializing_if = "Option::is_none")] pub created: Option<RangeQuery<Timestamp>>, /// A cursor for use in pagination. /// /// `ending_before` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub ending_before: Option<TopupId>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// A limit on the number of objects to be returned. /// /// Limit can range between 1 and 100, and the default is 10. #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<u64>, /// A cursor for use in pagination. /// /// `starting_after` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub starting_after: Option<TopupId>, /// Only return top-ups that have the given status. /// /// One of `canceled`, `failed`, `pending` or `succeeded`. #[serde(skip_serializing_if = "Option::is_none")] pub status: Option<TopupStatusFilter>, } impl<'a> ListTopups<'a> { pub fn new() -> Self { ListTopups { amount: Default::default(), created: Default::default(), ending_before: Default::default(), expand: Default::default(), limit: Default::default(), starting_after: Default::default(), status: Default::default(), } } } /// The parameters for `Topup::update`. #[derive(Clone, Debug, Serialize, Default)] pub struct UpdateTopup<'a> { /// An arbitrary string attached to the object. /// /// Often useful for displaying to users. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// Set of key-value pairs that you can attach to an object. /// /// This can be useful for storing additional information about the object in a structured format. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, } impl<'a> UpdateTopup<'a> { pub fn new() -> Self { UpdateTopup { description: Default::default(), expand: Default::default(), metadata: Default::default(), } } } /// An enum representing the possible values of an `Topup`'s `status` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum TopupStatus { Canceled, Failed, Pending, Reversed, Succeeded, } impl TopupStatus { pub fn as_str(&self) -> &'static str { match self { TopupStatus::Canceled => "canceled", TopupStatus::Failed => "failed", TopupStatus::Pending => "pending", TopupStatus::Reversed => "reversed", TopupStatus::Succeeded => "succeeded", } } } impl AsRef<str> for TopupStatus { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for TopupStatus { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } } /// An enum representing the possible values of an `ListTopups`'s `status` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum TopupStatusFilter { Canceled, Failed, Pending, Succeeded, } impl TopupStatusFilter { pub fn as_str(&self) -> &'static str { match self { TopupStatusFilter::Canceled => "canceled", TopupStatusFilter::Failed => "failed", TopupStatusFilter::Pending => "pending", TopupStatusFilter::Succeeded => "succeeded", } } } impl AsRef<str> for TopupStatusFilter { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for TopupStatusFilter { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } }