File size: 12,913 Bytes
9410704 | 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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | # This file was auto-generated by Fern from our API Definition.
import typing
from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ..core.request_options import RequestOptions
from ..types.delete_workspace_webhook_response_model import DeleteWorkspaceWebhookResponseModel
from ..types.patch_workspace_webhook_response_model import PatchWorkspaceWebhookResponseModel
from ..types.webhook_hmac_settings import WebhookHmacSettings
from ..types.workspace_create_webhook_response_model import WorkspaceCreateWebhookResponseModel
from ..types.workspace_webhook_event_type import WorkspaceWebhookEventType
from ..types.workspace_webhook_list_response_model import WorkspaceWebhookListResponseModel
from .raw_client import AsyncRawWebhooksClient, RawWebhooksClient
# this is used as the default value for optional parameters
OMIT = typing.cast(typing.Any, ...)
class WebhooksClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._raw_client = RawWebhooksClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> RawWebhooksClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
RawWebhooksClient
"""
return self._raw_client
def list(
self, *, include_usages: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
) -> WorkspaceWebhookListResponseModel:
"""
List all webhooks for a workspace
Parameters
----------
include_usages : typing.Optional[bool]
Whether to include active usages of the webhook, only usable by admins
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkspaceWebhookListResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.webhooks.list(
include_usages=False,
)
"""
_response = self._raw_client.list(include_usages=include_usages, request_options=request_options)
return _response.data
def create(
self, *, settings: WebhookHmacSettings, request_options: typing.Optional[RequestOptions] = None
) -> WorkspaceCreateWebhookResponseModel:
"""
Create a new webhook for the workspace with the specified authentication type.
Parameters
----------
settings : WebhookHmacSettings
Webhook settings object containing auth_type and corresponding configuration
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkspaceCreateWebhookResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs, WebhookHmacSettings
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.webhooks.create(
settings=WebhookHmacSettings(
name="name",
webhook_url="webhook_url",
),
)
"""
_response = self._raw_client.create(settings=settings, request_options=request_options)
return _response.data
def delete(
self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DeleteWorkspaceWebhookResponseModel:
"""
Delete the specified workspace webhook
Parameters
----------
webhook_id : str
The unique ID for the webhook
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DeleteWorkspaceWebhookResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.webhooks.delete(
webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
)
"""
_response = self._raw_client.delete(webhook_id, request_options=request_options)
return _response.data
def update(
self,
webhook_id: str,
*,
is_disabled: bool,
name: str,
retry_enabled: typing.Optional[bool] = OMIT,
request_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
events: typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> PatchWorkspaceWebhookResponseModel:
"""
Update the specified workspace webhook
Parameters
----------
webhook_id : str
The unique ID for the webhook
is_disabled : bool
Whether to disable or enable the webhook
name : str
The display name of the webhook (used for display purposes only).
retry_enabled : typing.Optional[bool]
Whether to enable automatic retries for transient failures (5xx, 429, timeout)
request_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
A list of request headers to include with the webhook delivery (optional)
events : typing.Optional[typing.Sequence[WorkspaceWebhookEventType]]
The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PatchWorkspaceWebhookResponseModel
Successful Response
Examples
--------
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.webhooks.update(
webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
is_disabled=True,
name="My Callback Webhook",
)
"""
_response = self._raw_client.update(
webhook_id,
is_disabled=is_disabled,
name=name,
retry_enabled=retry_enabled,
request_headers=request_headers,
events=events,
request_options=request_options,
)
return _response.data
class AsyncWebhooksClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._raw_client = AsyncRawWebhooksClient(client_wrapper=client_wrapper)
@property
def with_raw_response(self) -> AsyncRawWebhooksClient:
"""
Retrieves a raw implementation of this client that returns raw responses.
Returns
-------
AsyncRawWebhooksClient
"""
return self._raw_client
async def list(
self, *, include_usages: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None
) -> WorkspaceWebhookListResponseModel:
"""
List all webhooks for a workspace
Parameters
----------
include_usages : typing.Optional[bool]
Whether to include active usages of the webhook, only usable by admins
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkspaceWebhookListResponseModel
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.webhooks.list(
include_usages=False,
)
asyncio.run(main())
"""
_response = await self._raw_client.list(include_usages=include_usages, request_options=request_options)
return _response.data
async def create(
self, *, settings: WebhookHmacSettings, request_options: typing.Optional[RequestOptions] = None
) -> WorkspaceCreateWebhookResponseModel:
"""
Create a new webhook for the workspace with the specified authentication type.
Parameters
----------
settings : WebhookHmacSettings
Webhook settings object containing auth_type and corresponding configuration
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
WorkspaceCreateWebhookResponseModel
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs, WebhookHmacSettings
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.webhooks.create(
settings=WebhookHmacSettings(
name="name",
webhook_url="webhook_url",
),
)
asyncio.run(main())
"""
_response = await self._raw_client.create(settings=settings, request_options=request_options)
return _response.data
async def delete(
self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DeleteWorkspaceWebhookResponseModel:
"""
Delete the specified workspace webhook
Parameters
----------
webhook_id : str
The unique ID for the webhook
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
DeleteWorkspaceWebhookResponseModel
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.webhooks.delete(
webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
)
asyncio.run(main())
"""
_response = await self._raw_client.delete(webhook_id, request_options=request_options)
return _response.data
async def update(
self,
webhook_id: str,
*,
is_disabled: bool,
name: str,
retry_enabled: typing.Optional[bool] = OMIT,
request_headers: typing.Optional[typing.Dict[str, typing.Optional[str]]] = OMIT,
events: typing.Optional[typing.Sequence[WorkspaceWebhookEventType]] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> PatchWorkspaceWebhookResponseModel:
"""
Update the specified workspace webhook
Parameters
----------
webhook_id : str
The unique ID for the webhook
is_disabled : bool
Whether to disable or enable the webhook
name : str
The display name of the webhook (used for display purposes only).
retry_enabled : typing.Optional[bool]
Whether to enable automatic retries for transient failures (5xx, 429, timeout)
request_headers : typing.Optional[typing.Dict[str, typing.Optional[str]]]
A list of request headers to include with the webhook delivery (optional)
events : typing.Optional[typing.Sequence[WorkspaceWebhookEventType]]
The complete set of workspace-level events this webhook should be subscribed to. The webhook is added to the events in the list and removed from any not in the list. Omit to leave the current event subscriptions unchanged.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PatchWorkspaceWebhookResponseModel
Successful Response
Examples
--------
import asyncio
from elevenlabs import AsyncElevenLabs
client = AsyncElevenLabs(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.webhooks.update(
webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
is_disabled=True,
name="My Callback Webhook",
)
asyncio.run(main())
"""
_response = await self._raw_client.update(
webhook_id,
is_disabled=is_disabled,
name=name,
retry_enabled=retry_enabled,
request_headers=request_headers,
events=events,
request_options=request_options,
)
return _response.data
|