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
|
# -*- coding: utf-8 -*-
import json
from typing import ClassVar, Optional
from typing_extensions import Literal
from stripe._stripe_object import StripeObject
# This describes the common format for the pull payload of a V2 ThinEvent
# more specific classes will add `data` and `fetch_related_objects()` as needed
# The beginning of the section generated from our OpenAPI spec
class Event(StripeObject):
"""
Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.
"""
OBJECT_NAME: ClassVar[Literal["v2.core.event"]] = "v2.core.event"
class Reason(StripeObject):
class Request(StripeObject):
id: str
"""
ID of the API request that caused the event.
"""
idempotency_key: str
"""
The idempotency key transmitted during the request.
"""
type: Literal["request"]
"""
Event reason type.
"""
request: Optional[Request]
"""
Information on the API request that instigated the event.
"""
_inner_class_types = {"request": Request}
context: Optional[str]
"""
Authentication context needed to fetch the event or related object.
"""
created: str
"""
Time at which the object was created.
"""
id: str
"""
Unique identifier for the event.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["v2.core.event"]
"""
String representing the object's type. Objects of the same type share the same value of the object field.
"""
reason: Optional[Reason]
"""
Reason for the event.
"""
type: str
"""
The type of the event.
"""
_inner_class_types = {"reason": Reason}
# The end of the section generated from our OpenAPI spec
class Reason:
id: str
idempotency_key: str
def __init__(self, d) -> None:
self.id = d["id"]
self.idempotency_key = d["idempotency_key"]
def __repr__(self) -> str:
return f"<Reason id={self.id} idempotency_key={self.idempotency_key}>"
class RelatedObject:
id: str
type: str
url: str
def __init__(self, d) -> None:
self.id = d["id"]
self.type = d["type"]
self.url = d["url"]
def __repr__(self) -> str:
return f"<RelatedObject id={self.id} type={self.type} url={self.url}>"
class ThinEvent:
"""
ThinEvent represents the json that's delivered from an Event Destination. It's a basic `dict` with no additional methods or properties. Use it to check basic information about a delivered event. If you want more details, use `stripe.v2.Event.retrieve(thin_event.id)` to fetch the full event object.
"""
id: str
"""
Unique identifier for the event.
"""
type: str
"""
The type of the event.
"""
created: str
"""
Livemode indicates if the event is from a production(true) or test(false) account.
"""
livemode: bool
"""
Time at which the object was created.
"""
context: Optional[str] = None
"""
[Optional] Authentication context needed to fetch the event or related object.
"""
related_object: Optional[RelatedObject] = None
"""
[Optional] Object containing the reference to API resource relevant to the event.
"""
reason: Optional[Reason] = None
"""
[Optional] Reason for the event.
"""
def __init__(self, payload: str) -> None:
parsed = json.loads(payload)
self.id = parsed["id"]
self.type = parsed["type"]
self.created = parsed["created"]
self.livemode = parsed.get("livemode")
self.context = parsed.get("context")
if parsed.get("related_object"):
self.related_object = RelatedObject(parsed["related_object"])
if parsed.get("reason"):
self.reason = Reason(parsed["reason"])
def __repr__(self) -> str:
return f"<ThinEvent id={self.id} type={self.type} created={self.created} context={self.context} related_object={self.related_object} reason={self.reason}>"
|
