# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing import List, Union
from typing_extensions import Literal, Required, TypedDict

__all__ = ["WebhookCreateParams"]


class WebhookCreateParams(TypedDict, total=False):
    api_version: str

    subscribed_events: Required[
        List[
            Union[
                Literal[
                    "batch.succeeded",
                    "batch.cancelled",
                    "batch.expired",
                    "batch.failed",
                    "interaction.requires_action",
                    "interaction.completed",
                    "interaction.failed",
                    "interaction.cancelled",
                    "video.generated",
                ],
                str,
            ]
        ]
    ]
    """Required. The events that the webhook is subscribed to. Available events:

    - batch.succeeded
    - batch.cancelled
    - batch.expired
    - batch.failed
    - interaction.requires_action
    - interaction.completed
    - interaction.failed
    - interaction.cancelled
    - video.generated
    """

    uri: Required[str]
    """Required. The URI to which webhook events will be sent."""

    webhook_id: str
    """Optional.

    The webhook_id to use for the webhook. If not specified, the server will
    generate a unique ID.
    """

    name: str
    """Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`"""

    state: Literal["enabled", "disabled", "disabled_due_to_failed_deliveries"]
    """The state of the webhook."""
