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
|
# -*- 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._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._setup_intent import SetupIntent
from stripe.params._setup_intent_cancel_params import (
SetupIntentCancelParams,
)
from stripe.params._setup_intent_confirm_params import (
SetupIntentConfirmParams,
)
from stripe.params._setup_intent_create_params import (
SetupIntentCreateParams,
)
from stripe.params._setup_intent_list_params import SetupIntentListParams
from stripe.params._setup_intent_retrieve_params import (
SetupIntentRetrieveParams,
)
from stripe.params._setup_intent_update_params import (
SetupIntentUpdateParams,
)
from stripe.params._setup_intent_verify_microdeposits_params import (
SetupIntentVerifyMicrodepositsParams,
)
class SetupIntentService(StripeService):
def list(
self,
params: Optional["SetupIntentListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[SetupIntent]":
"""
Returns a list of SetupIntents.
"""
return cast(
"ListObject[SetupIntent]",
self._request(
"get",
"/v1/setup_intents",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["SetupIntentListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[SetupIntent]":
"""
Returns a list of SetupIntents.
"""
return cast(
"ListObject[SetupIntent]",
await self._request_async(
"get",
"/v1/setup_intents",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["SetupIntentCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Creates a SetupIntent object.
After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
it to collect any required permissions to charge the payment method later.
"""
return cast(
"SetupIntent",
self._request(
"post",
"/v1/setup_intents",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["SetupIntentCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Creates a SetupIntent object.
After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm)
it to collect any required permissions to charge the payment method later.
"""
return cast(
"SetupIntent",
await self._request_async(
"post",
"/v1/setup_intents",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
intent: str,
params: Optional["SetupIntentRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Retrieves the details of a SetupIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://docs.stripe.com/api#setup_intent_object) object reference for more details.
"""
return cast(
"SetupIntent",
self._request(
"get",
"/v1/setup_intents/{intent}".format(
intent=sanitize_id(intent)
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
intent: str,
params: Optional["SetupIntentRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Retrieves the details of a SetupIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://docs.stripe.com/api#setup_intent_object) object reference for more details.
"""
return cast(
"SetupIntent",
await self._request_async(
"get",
"/v1/setup_intents/{intent}".format(
intent=sanitize_id(intent)
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
intent: str,
params: Optional["SetupIntentUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Updates a SetupIntent object.
"""
return cast(
"SetupIntent",
self._request(
"post",
"/v1/setup_intents/{intent}".format(
intent=sanitize_id(intent)
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
intent: str,
params: Optional["SetupIntentUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Updates a SetupIntent object.
"""
return cast(
"SetupIntent",
await self._request_async(
"post",
"/v1/setup_intents/{intent}".format(
intent=sanitize_id(intent)
),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
intent: str,
params: Optional["SetupIntentCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
"""
return cast(
"SetupIntent",
self._request(
"post",
"/v1/setup_intents/{intent}/cancel".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
intent: str,
params: Optional["SetupIntentCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead.
"""
return cast(
"SetupIntent",
await self._request_async(
"post",
"/v1/setup_intents/{intent}/cancel".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
def confirm(
self,
intent: str,
params: Optional["SetupIntentConfirmParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Confirm that your customer intends to set up the current or
provided payment method. For example, you would confirm a SetupIntent
when a customer hits the “Save” button on a payment method management
page on your website.
If the selected payment method does not require any additional
steps from the customer, the SetupIntent will transition to the
succeeded status.
Otherwise, it will transition to the requires_action status and
suggest additional actions via next_action. If setup fails,
the SetupIntent will transition to the
requires_payment_method status or the canceled status if the
confirmation limit is reached.
"""
return cast(
"SetupIntent",
self._request(
"post",
"/v1/setup_intents/{intent}/confirm".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
async def confirm_async(
self,
intent: str,
params: Optional["SetupIntentConfirmParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Confirm that your customer intends to set up the current or
provided payment method. For example, you would confirm a SetupIntent
when a customer hits the “Save” button on a payment method management
page on your website.
If the selected payment method does not require any additional
steps from the customer, the SetupIntent will transition to the
succeeded status.
Otherwise, it will transition to the requires_action status and
suggest additional actions via next_action. If setup fails,
the SetupIntent will transition to the
requires_payment_method status or the canceled status if the
confirmation limit is reached.
"""
return cast(
"SetupIntent",
await self._request_async(
"post",
"/v1/setup_intents/{intent}/confirm".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
def verify_microdeposits(
self,
intent: str,
params: Optional["SetupIntentVerifyMicrodepositsParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Verifies microdeposits on a SetupIntent object.
"""
return cast(
"SetupIntent",
self._request(
"post",
"/v1/setup_intents/{intent}/verify_microdeposits".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
async def verify_microdeposits_async(
self,
intent: str,
params: Optional["SetupIntentVerifyMicrodepositsParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "SetupIntent":
"""
Verifies microdeposits on a SetupIntent object.
"""
return cast(
"SetupIntent",
await self._request_async(
"post",
"/v1/setup_intents/{intent}/verify_microdeposits".format(
intent=sanitize_id(intent),
),
base_address="api",
params=params,
options=options,
),
)
|
