async-stripe-shared 1.0.0-rc.6

API bindings for the Stripe HTTP API
Documentation
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
/// A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
/// For example, you can create a Payment Record to model a payment made on a different payment processor,.
/// in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
/// more Payment Attempt Records, which represent individual attempts made on a payment network.
#[derive(Clone)]
#[cfg_attr(not(feature = "redact-generated-debug"), derive(Debug))]
#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
pub struct PaymentRecord {
    pub amount: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_authorized: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_canceled: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_failed: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_guaranteed: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_refunded: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    pub amount_requested: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount,
    /// ID of the Connect application that created the PaymentRecord.
    pub application: Option<String>,
    /// Time at which the object was created. Measured in seconds since the Unix epoch.
    pub created: stripe_types::Timestamp,
    /// Customer information for this payment.
    pub customer_details:
        Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceCustomerDetails>,
    /// Indicates whether the customer was present in your checkout flow during this payment.
    pub customer_presence: Option<stripe_shared::PaymentRecordCustomerPresence>,
    /// An arbitrary string attached to the object. Often useful for displaying to users.
    pub description: Option<String>,
    /// Unique identifier for the object.
    pub id: stripe_shared::PaymentRecordId,
    /// ID of the latest Payment Attempt Record attached to this Payment Record.
    pub latest_payment_attempt_record: Option<String>,
    /// If the object exists in live mode, the value is `true`.
    /// If the object exists in test mode, the value is `false`.
    pub livemode: bool,
    /// 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: std::collections::HashMap<String, String>,
    /// Information about the Payment Method debited for this payment.
    pub payment_method_details:
        Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails>,
    pub processor_details: stripe_shared::PaymentsPrimitivesPaymentRecordsResourceProcessorDetails,
    /// Indicates who reported the payment.
    pub reported_by: PaymentRecordReportedBy,
    /// Shipping information for this payment.
    pub shipping_details:
        Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceShippingDetails>,
}
#[cfg(feature = "redact-generated-debug")]
impl std::fmt::Debug for PaymentRecord {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("PaymentRecord").finish_non_exhaustive()
    }
}
#[doc(hidden)]
pub struct PaymentRecordBuilder {
    amount: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_authorized: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_canceled: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_failed: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_guaranteed: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_refunded: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    amount_requested: Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceAmount>,
    application: Option<Option<String>>,
    created: Option<stripe_types::Timestamp>,
    customer_details:
        Option<Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceCustomerDetails>>,
    customer_presence: Option<Option<stripe_shared::PaymentRecordCustomerPresence>>,
    description: Option<Option<String>>,
    id: Option<stripe_shared::PaymentRecordId>,
    latest_payment_attempt_record: Option<Option<String>>,
    livemode: Option<bool>,
    metadata: Option<std::collections::HashMap<String, String>>,
    payment_method_details:
        Option<Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails>>,
    processor_details:
        Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceProcessorDetails>,
    reported_by: Option<PaymentRecordReportedBy>,
    shipping_details:
        Option<Option<stripe_shared::PaymentsPrimitivesPaymentRecordsResourceShippingDetails>>,
}

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

    struct Builder<'a> {
        out: &'a mut Option<PaymentRecord>,
        builder: PaymentRecordBuilder,
    }

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

    impl MapBuilder for PaymentRecordBuilder {
        type Out = PaymentRecord;
        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
            Ok(match k {
                "amount" => Deserialize::begin(&mut self.amount),
                "amount_authorized" => Deserialize::begin(&mut self.amount_authorized),
                "amount_canceled" => Deserialize::begin(&mut self.amount_canceled),
                "amount_failed" => Deserialize::begin(&mut self.amount_failed),
                "amount_guaranteed" => Deserialize::begin(&mut self.amount_guaranteed),
                "amount_refunded" => Deserialize::begin(&mut self.amount_refunded),
                "amount_requested" => Deserialize::begin(&mut self.amount_requested),
                "application" => Deserialize::begin(&mut self.application),
                "created" => Deserialize::begin(&mut self.created),
                "customer_details" => Deserialize::begin(&mut self.customer_details),
                "customer_presence" => Deserialize::begin(&mut self.customer_presence),
                "description" => Deserialize::begin(&mut self.description),
                "id" => Deserialize::begin(&mut self.id),
                "latest_payment_attempt_record" => {
                    Deserialize::begin(&mut self.latest_payment_attempt_record)
                }
                "livemode" => Deserialize::begin(&mut self.livemode),
                "metadata" => Deserialize::begin(&mut self.metadata),
                "payment_method_details" => Deserialize::begin(&mut self.payment_method_details),
                "processor_details" => Deserialize::begin(&mut self.processor_details),
                "reported_by" => Deserialize::begin(&mut self.reported_by),
                "shipping_details" => Deserialize::begin(&mut self.shipping_details),
                _ => <dyn Visitor>::ignore(),
            })
        }

        fn deser_default() -> Self {
            Self {
                amount: None,
                amount_authorized: None,
                amount_canceled: None,
                amount_failed: None,
                amount_guaranteed: None,
                amount_refunded: None,
                amount_requested: None,
                application: Some(None),
                created: None,
                customer_details: Some(None),
                customer_presence: Some(None),
                description: Some(None),
                id: None,
                latest_payment_attempt_record: Some(None),
                livemode: None,
                metadata: None,
                payment_method_details: Some(None),
                processor_details: None,
                reported_by: None,
                shipping_details: Some(None),
            }
        }

        fn take_out(&mut self) -> Option<Self::Out> {
            let (
                Some(amount),
                Some(amount_authorized),
                Some(amount_canceled),
                Some(amount_failed),
                Some(amount_guaranteed),
                Some(amount_refunded),
                Some(amount_requested),
                Some(application),
                Some(created),
                Some(customer_details),
                Some(customer_presence),
                Some(description),
                Some(id),
                Some(latest_payment_attempt_record),
                Some(livemode),
                Some(metadata),
                Some(payment_method_details),
                Some(processor_details),
                Some(reported_by),
                Some(shipping_details),
            ) = (
                self.amount.take(),
                self.amount_authorized.take(),
                self.amount_canceled.take(),
                self.amount_failed.take(),
                self.amount_guaranteed.take(),
                self.amount_refunded.take(),
                self.amount_requested.take(),
                self.application.take(),
                self.created,
                self.customer_details.take(),
                self.customer_presence.take(),
                self.description.take(),
                self.id.take(),
                self.latest_payment_attempt_record.take(),
                self.livemode,
                self.metadata.take(),
                self.payment_method_details.take(),
                self.processor_details.take(),
                self.reported_by.take(),
                self.shipping_details.take(),
            )
            else {
                return None;
            };
            Some(Self::Out {
                amount,
                amount_authorized,
                amount_canceled,
                amount_failed,
                amount_guaranteed,
                amount_refunded,
                amount_requested,
                application,
                created,
                customer_details,
                customer_presence,
                description,
                id,
                latest_payment_attempt_record,
                livemode,
                metadata,
                payment_method_details,
                processor_details,
                reported_by,
                shipping_details,
            })
        }
    }

    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 PaymentRecord {
        type Builder = PaymentRecordBuilder;
    }

    impl FromValueOpt for PaymentRecord {
        fn from_value(v: Value) -> Option<Self> {
            let Value::Object(obj) = v else {
                return None;
            };
            let mut b = PaymentRecordBuilder::deser_default();
            for (k, v) in obj {
                match k.as_str() {
                    "amount" => b.amount = FromValueOpt::from_value(v),
                    "amount_authorized" => b.amount_authorized = FromValueOpt::from_value(v),
                    "amount_canceled" => b.amount_canceled = FromValueOpt::from_value(v),
                    "amount_failed" => b.amount_failed = FromValueOpt::from_value(v),
                    "amount_guaranteed" => b.amount_guaranteed = FromValueOpt::from_value(v),
                    "amount_refunded" => b.amount_refunded = FromValueOpt::from_value(v),
                    "amount_requested" => b.amount_requested = FromValueOpt::from_value(v),
                    "application" => b.application = FromValueOpt::from_value(v),
                    "created" => b.created = FromValueOpt::from_value(v),
                    "customer_details" => b.customer_details = FromValueOpt::from_value(v),
                    "customer_presence" => b.customer_presence = FromValueOpt::from_value(v),
                    "description" => b.description = FromValueOpt::from_value(v),
                    "id" => b.id = FromValueOpt::from_value(v),
                    "latest_payment_attempt_record" => {
                        b.latest_payment_attempt_record = FromValueOpt::from_value(v)
                    }
                    "livemode" => b.livemode = FromValueOpt::from_value(v),
                    "metadata" => b.metadata = FromValueOpt::from_value(v),
                    "payment_method_details" => {
                        b.payment_method_details = FromValueOpt::from_value(v)
                    }
                    "processor_details" => b.processor_details = FromValueOpt::from_value(v),
                    "reported_by" => b.reported_by = FromValueOpt::from_value(v),
                    "shipping_details" => b.shipping_details = FromValueOpt::from_value(v),
                    _ => {}
                }
            }
            b.take_out()
        }
    }
};
#[cfg(feature = "serialize")]
impl serde::Serialize for PaymentRecord {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        use serde::ser::SerializeStruct;
        let mut s = s.serialize_struct("PaymentRecord", 21)?;
        s.serialize_field("amount", &self.amount)?;
        s.serialize_field("amount_authorized", &self.amount_authorized)?;
        s.serialize_field("amount_canceled", &self.amount_canceled)?;
        s.serialize_field("amount_failed", &self.amount_failed)?;
        s.serialize_field("amount_guaranteed", &self.amount_guaranteed)?;
        s.serialize_field("amount_refunded", &self.amount_refunded)?;
        s.serialize_field("amount_requested", &self.amount_requested)?;
        s.serialize_field("application", &self.application)?;
        s.serialize_field("created", &self.created)?;
        s.serialize_field("customer_details", &self.customer_details)?;
        s.serialize_field("customer_presence", &self.customer_presence)?;
        s.serialize_field("description", &self.description)?;
        s.serialize_field("id", &self.id)?;
        s.serialize_field("latest_payment_attempt_record", &self.latest_payment_attempt_record)?;
        s.serialize_field("livemode", &self.livemode)?;
        s.serialize_field("metadata", &self.metadata)?;
        s.serialize_field("payment_method_details", &self.payment_method_details)?;
        s.serialize_field("processor_details", &self.processor_details)?;
        s.serialize_field("reported_by", &self.reported_by)?;
        s.serialize_field("shipping_details", &self.shipping_details)?;

        s.serialize_field("object", "payment_record")?;
        s.end()
    }
}
/// Indicates who reported the payment.
#[derive(Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum PaymentRecordReportedBy {
    Self_,
    Stripe,
    /// An unrecognized value from Stripe. Should not be used as a request parameter.
    Unknown(String),
}
impl PaymentRecordReportedBy {
    pub fn as_str(&self) -> &str {
        use PaymentRecordReportedBy::*;
        match self {
            Self_ => "self",
            Stripe => "stripe",
            Unknown(v) => v,
        }
    }
}

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

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

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

    fn into_id(self) -> Self::Id {
        self.id
    }
}
stripe_types::def_id!(PaymentRecordId);
#[derive(Clone, Eq, PartialEq)]
#[non_exhaustive]
pub enum PaymentRecordCustomerPresence {
    OffSession,
    OnSession,
    /// An unrecognized value from Stripe. Should not be used as a request parameter.
    Unknown(String),
}
impl PaymentRecordCustomerPresence {
    pub fn as_str(&self) -> &str {
        use PaymentRecordCustomerPresence::*;
        match self {
            OffSession => "off_session",
            OnSession => "on_session",
            Unknown(v) => v,
        }
    }
}

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

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

stripe_types::impl_from_val_with_from_str!(PaymentRecordCustomerPresence);
#[cfg(feature = "deserialize")]
impl<'de> serde::Deserialize<'de> for PaymentRecordCustomerPresence {
    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"))
    }
}