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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._payment_record import PaymentRecord
from stripe._request_options import RequestOptions
from stripe.params._payment_record_report_payment_attempt_canceled_params import (
PaymentRecordReportPaymentAttemptCanceledParams,
)
from stripe.params._payment_record_report_payment_attempt_failed_params import (
PaymentRecordReportPaymentAttemptFailedParams,
)
from stripe.params._payment_record_report_payment_attempt_guaranteed_params import (
PaymentRecordReportPaymentAttemptGuaranteedParams,
)
from stripe.params._payment_record_report_payment_attempt_informational_params import (
PaymentRecordReportPaymentAttemptInformationalParams,
)
from stripe.params._payment_record_report_payment_attempt_params import (
PaymentRecordReportPaymentAttemptParams,
)
from stripe.params._payment_record_report_payment_params import (
PaymentRecordReportPaymentParams,
)
from stripe.params._payment_record_report_refund_params import (
PaymentRecordReportRefundParams,
)
from stripe.params._payment_record_retrieve_params import (
PaymentRecordRetrieveParams,
)
class PaymentRecordService(StripeService):
def retrieve(
self,
id: str,
params: Optional["PaymentRecordRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Retrieves a Payment Record with the given ID
"""
return cast(
"PaymentRecord",
self._request(
"get",
"/v1/payment_records/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
id: str,
params: Optional["PaymentRecordRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Retrieves a Payment Record with the given ID
"""
return cast(
"PaymentRecord",
await self._request_async(
"get",
"/v1/payment_records/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
def report_payment_attempt(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report a new payment attempt on the specified Payment Record. A new payment
attempt can only be specified if all other payment attempts are canceled or failed.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_payment_attempt".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_payment_attempt_async(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report a new payment attempt on the specified Payment Record. A new payment
attempt can only be specified if all other payment attempts are canceled or failed.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_payment_attempt".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_payment_attempt_canceled(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptCanceledParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was canceled.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_payment_attempt_canceled".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_payment_attempt_canceled_async(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptCanceledParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was canceled.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_payment_attempt_canceled".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_payment_attempt_failed(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptFailedParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
failed or errored.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_payment_attempt_failed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_payment_attempt_failed_async(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptFailedParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
failed or errored.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_payment_attempt_failed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_payment_attempt_guaranteed(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptGuaranteedParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was guaranteed.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_payment_attempt_guaranteed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_payment_attempt_guaranteed_async(
self,
id: str,
params: "PaymentRecordReportPaymentAttemptGuaranteedParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was guaranteed.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_payment_attempt_guaranteed".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_payment_attempt_informational(
self,
id: str,
params: Optional[
"PaymentRecordReportPaymentAttemptInformationalParams"
] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report informational updates on the specified Payment Record.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_payment_attempt_informational".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_payment_attempt_informational_async(
self,
id: str,
params: Optional[
"PaymentRecordReportPaymentAttemptInformationalParams"
] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report informational updates on the specified Payment Record.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_payment_attempt_informational".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_refund(
self,
id: str,
params: "PaymentRecordReportRefundParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was refunded.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/{id}/report_refund".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def report_refund_async(
self,
id: str,
params: "PaymentRecordReportRefundParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report that the most recent payment attempt on the specified Payment Record
was refunded.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/{id}/report_refund".format(
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def report_payment(
self,
params: "PaymentRecordReportPaymentParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report a new Payment Record. You may report a Payment Record as it is
initialized and later report updates through the other report_* methods, or report Payment
Records in a terminal state directly, through this method.
"""
return cast(
"PaymentRecord",
self._request(
"post",
"/v1/payment_records/report_payment",
base_address="api",
params=params,
options=options,
),
)
async def report_payment_async(
self,
params: "PaymentRecordReportPaymentParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentRecord":
"""
Report a new Payment Record. You may report a Payment Record as it is
initialized and later report updates through the other report_* methods, or report Payment
Records in a terminal state directly, through this method.
"""
return cast(
"PaymentRecord",
await self._request_async(
"post",
"/v1/payment_records/report_payment",
base_address="api",
params=params,
options=options,
),
)
|
