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
|
# -*- 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._payment_method_domain import PaymentMethodDomain
from stripe._request_options import RequestOptions
from stripe.params._payment_method_domain_create_params import (
PaymentMethodDomainCreateParams,
)
from stripe.params._payment_method_domain_list_params import (
PaymentMethodDomainListParams,
)
from stripe.params._payment_method_domain_retrieve_params import (
PaymentMethodDomainRetrieveParams,
)
from stripe.params._payment_method_domain_update_params import (
PaymentMethodDomainUpdateParams,
)
from stripe.params._payment_method_domain_validate_params import (
PaymentMethodDomainValidateParams,
)
class PaymentMethodDomainService(StripeService):
def list(
self,
params: Optional["PaymentMethodDomainListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[PaymentMethodDomain]":
"""
Lists the details of existing payment method domains.
"""
return cast(
"ListObject[PaymentMethodDomain]",
self._request(
"get",
"/v1/payment_method_domains",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["PaymentMethodDomainListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[PaymentMethodDomain]":
"""
Lists the details of existing payment method domains.
"""
return cast(
"ListObject[PaymentMethodDomain]",
await self._request_async(
"get",
"/v1/payment_method_domains",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "PaymentMethodDomainCreateParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Creates a payment method domain.
"""
return cast(
"PaymentMethodDomain",
self._request(
"post",
"/v1/payment_method_domains",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "PaymentMethodDomainCreateParams",
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Creates a payment method domain.
"""
return cast(
"PaymentMethodDomain",
await self._request_async(
"post",
"/v1/payment_method_domains",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Retrieves the details of an existing payment method domain.
"""
return cast(
"PaymentMethodDomain",
self._request(
"get",
"/v1/payment_method_domains/{payment_method_domain}".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Retrieves the details of an existing payment method domain.
"""
return cast(
"PaymentMethodDomain",
await self._request_async(
"get",
"/v1/payment_method_domains/{payment_method_domain}".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Updates an existing payment method domain.
"""
return cast(
"PaymentMethodDomain",
self._request(
"post",
"/v1/payment_method_domains/{payment_method_domain}".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Updates an existing payment method domain.
"""
return cast(
"PaymentMethodDomain",
await self._request_async(
"post",
"/v1/payment_method_domains/{payment_method_domain}".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
def validate(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainValidateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
self._request(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
async def validate_async(
self,
payment_method_domain: str,
params: Optional["PaymentMethodDomainValidateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "PaymentMethodDomain":
"""
Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration).
"""
return cast(
"PaymentMethodDomain",
await self._request_async(
"post",
"/v1/payment_method_domains/{payment_method_domain}/validate".format(
payment_method_domain=sanitize_id(payment_method_domain),
),
base_address="api",
params=params,
options=options,
),
)
|
