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
|
# -*- 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._webhook_endpoint import WebhookEndpoint
from stripe.params._webhook_endpoint_create_params import (
WebhookEndpointCreateParams,
)
from stripe.params._webhook_endpoint_delete_params import (
WebhookEndpointDeleteParams,
)
from stripe.params._webhook_endpoint_list_params import (
WebhookEndpointListParams,
)
from stripe.params._webhook_endpoint_retrieve_params import (
WebhookEndpointRetrieveParams,
)
from stripe.params._webhook_endpoint_update_params import (
WebhookEndpointUpdateParams,
)
class WebhookEndpointService(StripeService):
def delete(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
"""
return cast(
"WebhookEndpoint",
self._request(
"delete",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
"""
return cast(
"WebhookEndpoint",
await self._request_async(
"delete",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
Retrieves the webhook endpoint with the given ID.
"""
return cast(
"WebhookEndpoint",
self._request(
"get",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
Retrieves the webhook endpoint with the given ID.
"""
return cast(
"WebhookEndpoint",
await self._request_async(
"get",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
"""
return cast(
"WebhookEndpoint",
self._request(
"post",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
webhook_endpoint: str,
params: Optional["WebhookEndpointUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
"""
return cast(
"WebhookEndpoint",
await self._request_async(
"post",
"/v1/webhook_endpoints/{webhook_endpoint}".format(
webhook_endpoint=sanitize_id(webhook_endpoint),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["WebhookEndpointListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[WebhookEndpoint]":
"""
Returns a list of your webhook endpoints.
"""
return cast(
"ListObject[WebhookEndpoint]",
self._request(
"get",
"/v1/webhook_endpoints",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["WebhookEndpointListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[WebhookEndpoint]":
"""
Returns a list of your webhook endpoints.
"""
return cast(
"ListObject[WebhookEndpoint]",
await self._request_async(
"get",
"/v1/webhook_endpoints",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "WebhookEndpointCreateParams",
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.
"""
return cast(
"WebhookEndpoint",
self._request(
"post",
"/v1/webhook_endpoints",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "WebhookEndpointCreateParams",
options: Optional["RequestOptions"] = None,
) -> "WebhookEndpoint":
"""
A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.
"""
return cast(
"WebhookEndpoint",
await self._request_async(
"post",
"/v1/webhook_endpoints",
base_address="api",
params=params,
options=options,
),
)
|
