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
|
from typing_extensions import Literal, Self
from stripe._error import InvalidRequestError
from stripe._stripe_object import StripeObject
from stripe._request_options import extract_options_from_dict
from stripe._api_mode import ApiMode
from stripe._base_address import BaseAddress
from stripe._api_requestor import _APIRequestor
from stripe import _util
from urllib.parse import quote_plus
from typing import (
Any,
ClassVar,
Generic,
List,
Optional,
TypeVar,
cast,
Mapping,
)
T = TypeVar("T", bound=StripeObject)
class APIResource(StripeObject, Generic[T]):
OBJECT_NAME: ClassVar[str]
@classmethod
@_util.deprecated(
"This method is deprecated and will be removed in a future version of stripe-python. Child classes of APIResource should define their own `retrieve` and use APIResource._request directly."
)
def retrieve(cls, id, **params) -> T:
instance = cls(id, **params)
instance.refresh()
return cast(T, instance)
def refresh(self) -> Self:
return self._request_and_refresh("get", self.instance_url())
async def refresh_async(self) -> Self:
return await self._request_and_refresh_async(
"get", self.instance_url()
)
@classmethod
def class_url(cls) -> str:
if cls == APIResource:
raise NotImplementedError(
"APIResource is an abstract class. You should perform "
"actions on its subclasses (e.g. Charge, Customer)"
)
# Namespaces are separated in object names with periods (.) and in URLs
# with forward slashes (/), so replace the former with the latter.
base = cls.OBJECT_NAME.replace(".", "/")
return "/v1/%ss" % (base,)
def instance_url(self) -> str:
id = self.get("id")
if not isinstance(id, str):
raise InvalidRequestError(
"Could not determine which URL to request: %s instance "
"has invalid ID: %r, %s. ID should be of type `str` (or"
" `unicode`)" % (type(self).__name__, id, type(id)),
"id",
)
base = self.class_url()
extn = quote_plus(id)
return "%s/%s" % (base, extn)
def _request(
self,
method,
url,
params=None,
*,
base_address: BaseAddress = "api",
api_mode: ApiMode = "V1",
) -> StripeObject:
obj = StripeObject._request(
self,
method,
url,
params=params,
base_address=base_address,
)
if type(self) is type(obj):
self._refresh_from(values=obj, api_mode=api_mode)
return self
else:
return obj
async def _request_async(
self,
method,
url,
params=None,
*,
base_address: BaseAddress = "api",
api_mode: ApiMode = "V1",
) -> StripeObject:
obj = await StripeObject._request_async(
self,
method,
url,
params=params,
base_address=base_address,
)
if type(self) is type(obj):
self._refresh_from(values=obj, api_mode=api_mode)
return self
else:
return obj
def _request_and_refresh(
self,
method: Literal["get", "post", "delete"],
url: str,
params: Optional[Mapping[str, Any]] = None,
usage: Optional[List[str]] = None,
*,
base_address: BaseAddress = "api",
api_mode: ApiMode = "V1",
) -> Self:
obj = StripeObject._request(
self,
method,
url,
params=params,
base_address=base_address,
usage=usage,
)
self._refresh_from(values=obj, api_mode=api_mode)
return self
async def _request_and_refresh_async(
self,
method: Literal["get", "post", "delete"],
url: str,
params: Optional[Mapping[str, Any]] = None,
usage: Optional[List[str]] = None,
*,
base_address: BaseAddress = "api",
api_mode: ApiMode = "V1",
) -> Self:
obj = await StripeObject._request_async(
self,
method,
url,
params=params,
base_address=base_address,
usage=usage,
)
self._refresh_from(values=obj, api_mode=api_mode)
return self
@classmethod
def _static_request(
cls,
method_,
url_,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
):
request_options, request_params = extract_options_from_dict(params)
return _APIRequestor._global_instance().request(
method_,
url_,
params=request_params,
options=request_options,
base_address=base_address,
)
@classmethod
async def _static_request_async(
cls,
method_,
url_,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
):
request_options, request_params = extract_options_from_dict(params)
return await _APIRequestor._global_instance().request_async(
method_,
url_,
params=request_params,
options=request_options,
base_address=base_address,
)
@classmethod
def _static_request_stream(
cls,
method,
url,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
):
request_options, request_params = extract_options_from_dict(params)
return _APIRequestor._global_instance().request_stream(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
)
@classmethod
async def _static_request_stream_async(
cls,
method,
url,
params: Optional[Mapping[str, Any]] = None,
*,
base_address: BaseAddress = "api",
):
request_options, request_params = extract_options_from_dict(params)
return await _APIRequestor._global_instance().request_stream_async(
method,
url,
params=request_params,
options=request_options,
base_address=base_address,
)
|
