airweave-sdk 0.8.65__py3-none-any.whl → 0.8.66__py3-none-any.whl

airweave/sources/client.py

@@ -25,10 +25,17 @@ class SourcesClient:
 
     def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Source]:
         """
-        List all available data source connectors.
+        Retrieve all available data source connectors.
 
-        <br/><br/>
-        Returns the complete catalog of source types that Airweave can connect to.
+        Returns the complete catalog of source types that Airweave can connect to,
+        including their authentication methods, configuration requirements, and
+        supported features. Use this endpoint to discover which integrations are
+        available for your organization.
+
+        Each source includes:
+        - **Authentication methods**: How to connect (OAuth, API key, etc.)
+        - **Configuration schemas**: What settings are required or optional
+        - **Supported auth providers**: Pre-configured OAuth providers available
 
         Parameters
         ----------
@@ -45,8 +52,6 @@ class SourcesClient:
         from airweave import AirweaveSDK
 
         client = AirweaveSDK(
-            framework_name="YOUR_FRAMEWORK_NAME",
-            framework_version="YOUR_FRAMEWORK_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.sources.list()
@@ -56,7 +61,16 @@ class SourcesClient:
 
     def get(self, short_name: str, *, request_options: typing.Optional[RequestOptions] = None) -> Source:
         """
-        Get detailed information about a specific data source connector.
+        Retrieve detailed information about a specific data source connector.
+
+        Returns the complete configuration for a source type, including:
+
+        - **Authentication fields**: Schema for credentials required to connect
+        - **Configuration fields**: Schema for optional settings and customization
+        - **Supported auth providers**: Pre-configured OAuth providers available for this source
+
+        Use this endpoint before creating a source connection to understand what
+        authentication and configuration values are required.
 
         Parameters
         ----------
@@ -76,12 +90,10 @@ class SourcesClient:
         from airweave import AirweaveSDK
 
         client = AirweaveSDK(
-            framework_name="YOUR_FRAMEWORK_NAME",
-            framework_version="YOUR_FRAMEWORK_VERSION",
             api_key="YOUR_API_KEY",
         )
         client.sources.get(
-            short_name="short_name",
+            short_name="github",
         )
         """
         _response = self._raw_client.get(short_name, request_options=request_options)
@@ -105,10 +117,17 @@ class AsyncSourcesClient:
 
     async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[Source]:
         """
-        List all available data source connectors.
+        Retrieve all available data source connectors.
 
-        <br/><br/>
-        Returns the complete catalog of source types that Airweave can connect to.
+        Returns the complete catalog of source types that Airweave can connect to,
+        including their authentication methods, configuration requirements, and
+        supported features. Use this endpoint to discover which integrations are
+        available for your organization.
+
+        Each source includes:
+        - **Authentication methods**: How to connect (OAuth, API key, etc.)
+        - **Configuration schemas**: What settings are required or optional
+        - **Supported auth providers**: Pre-configured OAuth providers available
 
         Parameters
         ----------
@@ -127,8 +146,6 @@ class AsyncSourcesClient:
         from airweave import AsyncAirweaveSDK
 
         client = AsyncAirweaveSDK(
-            framework_name="YOUR_FRAMEWORK_NAME",
-            framework_version="YOUR_FRAMEWORK_VERSION",
             api_key="YOUR_API_KEY",
         )
 
@@ -144,7 +161,16 @@ class AsyncSourcesClient:
 
     async def get(self, short_name: str, *, request_options: typing.Optional[RequestOptions] = None) -> Source:
         """
-        Get detailed information about a specific data source connector.
+        Retrieve detailed information about a specific data source connector.
+
+        Returns the complete configuration for a source type, including:
+
+        - **Authentication fields**: Schema for credentials required to connect
+        - **Configuration fields**: Schema for optional settings and customization
+        - **Supported auth providers**: Pre-configured OAuth providers available for this source
+
+        Use this endpoint before creating a source connection to understand what
+        authentication and configuration values are required.
 
         Parameters
         ----------
@@ -166,15 +192,13 @@ class AsyncSourcesClient:
         from airweave import AsyncAirweaveSDK
 
         client = AsyncAirweaveSDK(
-            framework_name="YOUR_FRAMEWORK_NAME",
-            framework_version="YOUR_FRAMEWORK_VERSION",
             api_key="YOUR_API_KEY",
         )
 
 
         async def main() -> None:
             await client.sources.get(
-                short_name="short_name",
+                short_name="github",
             )
 
 

airweave/sources/raw_client.py

@@ -9,8 +9,11 @@ from ..core.http_response import AsyncHttpResponse, HttpResponse
 from ..core.jsonable_encoder import jsonable_encoder
 from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
+from ..errors.not_found_error import NotFoundError
+from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
-from ..types.http_validation_error import HttpValidationError
+from ..types.not_found_error_response import NotFoundErrorResponse
+from ..types.rate_limit_error_response import RateLimitErrorResponse
 from ..types.source import Source
 
 
@@ -20,10 +23,17 @@ class RawSourcesClient:
 
     def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[typing.List[Source]]:
         """
-        List all available data source connectors.
+        Retrieve all available data source connectors.
 
-        <br/><br/>
-        Returns the complete catalog of source types that Airweave can connect to.
+        Returns the complete catalog of source types that Airweave can connect to,
+        including their authentication methods, configuration requirements, and
+        supported features. Use this endpoint to discover which integrations are
+        available for your organization.
+
+        Each source includes:
+        - **Authentication methods**: How to connect (OAuth, API key, etc.)
+        - **Configuration schemas**: What settings are required or optional
+        - **Supported auth providers**: Pre-configured OAuth providers available
 
         Parameters
         ----------
@@ -54,9 +64,20 @@ class RawSourcesClient:
                 raise UnprocessableEntityError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        HttpValidationError,
+                        typing.Optional[typing.Any],
                         parse_obj_as(
-                            type_=HttpValidationError,  # type: ignore
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        RateLimitErrorResponse,
+                        parse_obj_as(
+                            type_=RateLimitErrorResponse,  # type: ignore
                             object_=_response.json(),
                         ),
                     ),
@@ -68,7 +89,16 @@ class RawSourcesClient:
 
     def get(self, short_name: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Source]:
         """
-        Get detailed information about a specific data source connector.
+        Retrieve detailed information about a specific data source connector.
+
+        Returns the complete configuration for a source type, including:
+
+        - **Authentication fields**: Schema for credentials required to connect
+        - **Configuration fields**: Schema for optional settings and customization
+        - **Supported auth providers**: Pre-configured OAuth providers available for this source
+
+        Use this endpoint before creating a source connection to understand what
+        authentication and configuration values are required.
 
         Parameters
         ----------
@@ -98,13 +128,35 @@ class RawSourcesClient:
                     ),
                 )
                 return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFoundErrorResponse,
+                        parse_obj_as(
+                            type_=NotFoundErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             if _response.status_code == 422:
                 raise UnprocessableEntityError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        HttpValidationError,
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        RateLimitErrorResponse,
                         parse_obj_as(
-                            type_=HttpValidationError,  # type: ignore
+                            type_=RateLimitErrorResponse,  # type: ignore
                             object_=_response.json(),
                         ),
                     ),
@@ -123,10 +175,17 @@ class AsyncRawSourcesClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[typing.List[Source]]:
         """
-        List all available data source connectors.
+        Retrieve all available data source connectors.
 
-        <br/><br/>
-        Returns the complete catalog of source types that Airweave can connect to.
+        Returns the complete catalog of source types that Airweave can connect to,
+        including their authentication methods, configuration requirements, and
+        supported features. Use this endpoint to discover which integrations are
+        available for your organization.
+
+        Each source includes:
+        - **Authentication methods**: How to connect (OAuth, API key, etc.)
+        - **Configuration schemas**: What settings are required or optional
+        - **Supported auth providers**: Pre-configured OAuth providers available
 
         Parameters
         ----------
@@ -157,9 +216,20 @@ class AsyncRawSourcesClient:
                 raise UnprocessableEntityError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        HttpValidationError,
+                        typing.Optional[typing.Any],
                         parse_obj_as(
-                            type_=HttpValidationError,  # type: ignore
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        RateLimitErrorResponse,
+                        parse_obj_as(
+                            type_=RateLimitErrorResponse,  # type: ignore
                             object_=_response.json(),
                         ),
                     ),
@@ -173,7 +243,16 @@ class AsyncRawSourcesClient:
         self, short_name: str, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[Source]:
         """
-        Get detailed information about a specific data source connector.
+        Retrieve detailed information about a specific data source connector.
+
+        Returns the complete configuration for a source type, including:
+
+        - **Authentication fields**: Schema for credentials required to connect
+        - **Configuration fields**: Schema for optional settings and customization
+        - **Supported auth providers**: Pre-configured OAuth providers available for this source
+
+        Use this endpoint before creating a source connection to understand what
+        authentication and configuration values are required.
 
         Parameters
         ----------
@@ -203,13 +282,35 @@ class AsyncRawSourcesClient:
                     ),
                 )
                 return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        NotFoundErrorResponse,
+                        parse_obj_as(
+                            type_=NotFoundErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             if _response.status_code == 422:
                 raise UnprocessableEntityError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        HttpValidationError,
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        RateLimitErrorResponse,
                         parse_obj_as(
-                            type_=HttpValidationError,  # type: ignore
+                            type_=RateLimitErrorResponse,  # type: ignore
                             object_=_response.json(),
                         ),
                     ),

airweave/types/__init__.py

@@ -19,8 +19,6 @@ if typing.TYPE_CHECKING:
     from .auth_provider_connection_update import AuthProviderConnectionUpdate
     from .authentication_details import AuthenticationDetails
     from .authentication_method import AuthenticationMethod
-    from .background_task_status import BackgroundTaskStatus
-    from .background_task_type import BackgroundTaskType
     from .behavior_config import BehaviorConfig
     from .billing_period import BillingPeriod
     from .billing_period_status import BillingPeriodStatus
@@ -38,23 +36,21 @@ if typing.TYPE_CHECKING:
     from .checkout_session_response import CheckoutSessionResponse
     from .collection import Collection
     from .collection_status import CollectionStatus
-    from .collection_update import CollectionUpdate
     from .config_field import ConfigField
     from .config_values import ConfigValues
+    from .conflict_error_response import ConflictErrorResponse
     from .connection import Connection
     from .connection_status import ConnectionStatus
     from .cursor_config import CursorConfig
     from .customer_portal_request import CustomerPortalRequest
     from .customer_portal_response import CustomerPortalResponse
+    from .delivery_attempt import DeliveryAttempt
     from .destination import Destination
     from .destination_config import DestinationConfig
     from .destination_with_authentication_fields import DestinationWithAuthenticationFields
     from .direct_authentication import DirectAuthentication
     from .embedding_model import EmbeddingModel
     from .embedding_model_with_authentication_fields import EmbeddingModelWithAuthenticationFields
-    from .enable_endpoint_request import EnableEndpointRequest
-    from .endpoint_out import EndpointOut
-    from .endpoint_secret_out import EndpointSecretOut
     from .entity_count import EntityCount
     from .entity_count_with_definition import EntityCountWithDefinition
     from .entity_definition import EntityDefinition
@@ -64,6 +60,8 @@ if typing.TYPE_CHECKING:
     from .entity_summary import EntitySummary
     from .entity_type import EntityType
     from .entity_type_stats import EntityTypeStats
+    from .event_message import EventMessage
+    from .event_message_with_attempts import EventMessageWithAttempts
     from .event_type import EventType
     from .feature_flag import FeatureFlag
     from .fields import Fields
@@ -78,13 +76,9 @@ if typing.TYPE_CHECKING:
     from .legacy_search_request_search_method import LegacySearchRequestSearchMethod
     from .legacy_search_response import LegacySearchResponse
     from .member_response import MemberResponse
-    from .message_attempt_out import MessageAttemptOut
-    from .message_attempt_trigger_type import MessageAttemptTriggerType
-    from .message_out import MessageOut
     from .message_response import MessageResponse
-    from .message_status import MessageStatus
-    from .message_status_text import MessageStatusText
     from .minute_level_schedule_config import MinuteLevelScheduleConfig
+    from .not_found_error_response import NotFoundErrorResponse
     from .o_auth_browser_authentication import OAuthBrowserAuthentication
     from .o_auth_token_authentication import OAuthTokenAuthentication
     from .o_auth_type import OAuthType
@@ -94,7 +88,8 @@ if typing.TYPE_CHECKING:
     from .organization_metrics import OrganizationMetrics
     from .organization_with_role import OrganizationWithRole
     from .query_expansion_strategy import QueryExpansionStrategy
-    from .recover_out import RecoverOut
+    from .rate_limit_error_response import RateLimitErrorResponse
+    from .recovery_task import RecoveryTask
     from .response_type import ResponseType
     from .retrieval_strategy import RetrievalStrategy
     from .s_3_config_request import S3ConfigRequest
@@ -116,11 +111,11 @@ if typing.TYPE_CHECKING:
     from .source_rate_limit_response import SourceRateLimitResponse
     from .source_rate_limit_update_request import SourceRateLimitUpdateRequest
     from .subscription_info import SubscriptionInfo
-    from .subscription_with_attempts_out import SubscriptionWithAttemptsOut
     from .sync import Sync
     from .sync_config import SyncConfig
     from .sync_create import SyncCreate
     from .sync_details import SyncDetails
+    from .sync_event_payload import SyncEventPayload
     from .sync_job import SyncJob
     from .sync_job_details import SyncJobDetails
     from .sync_job_status import SyncJobStatus
@@ -137,7 +132,10 @@ if typing.TYPE_CHECKING:
     from .user_create import UserCreate
     from .user_organization import UserOrganization
     from .validation_error import ValidationError
+    from .validation_error_detail import ValidationErrorDetail
     from .validation_error_loc_item import ValidationErrorLocItem
+    from .validation_error_response import ValidationErrorResponse
+    from .webhook_subscription import WebhookSubscription
 _dynamic_imports: typing.Dict[str, str] = {
     "ActionCheckRequest": ".action_check_request",
     "ActionCheckResponse": ".action_check_response",
@@ -152,8 +150,6 @@ _dynamic_imports: typing.Dict[str, str] = {
     "AuthProviderConnectionUpdate": ".auth_provider_connection_update",
     "AuthenticationDetails": ".authentication_details",
     "AuthenticationMethod": ".authentication_method",
-    "BackgroundTaskStatus": ".background_task_status",
-    "BackgroundTaskType": ".background_task_type",
     "BehaviorConfig": ".behavior_config",
     "BillingPeriod": ".billing_period",
     "BillingPeriodStatus": ".billing_period_status",
@@ -167,23 +163,21 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CheckoutSessionResponse": ".checkout_session_response",
     "Collection": ".collection",
     "CollectionStatus": ".collection_status",
-    "CollectionUpdate": ".collection_update",
     "ConfigField": ".config_field",
     "ConfigValues": ".config_values",
+    "ConflictErrorResponse": ".conflict_error_response",
     "Connection": ".connection",
     "ConnectionStatus": ".connection_status",
     "CursorConfig": ".cursor_config",
     "CustomerPortalRequest": ".customer_portal_request",
     "CustomerPortalResponse": ".customer_portal_response",
+    "DeliveryAttempt": ".delivery_attempt",
     "Destination": ".destination",
     "DestinationConfig": ".destination_config",
     "DestinationWithAuthenticationFields": ".destination_with_authentication_fields",
     "DirectAuthentication": ".direct_authentication",
     "EmbeddingModel": ".embedding_model",
     "EmbeddingModelWithAuthenticationFields": ".embedding_model_with_authentication_fields",
-    "EnableEndpointRequest": ".enable_endpoint_request",
-    "EndpointOut": ".endpoint_out",
-    "EndpointSecretOut": ".endpoint_secret_out",
     "EntityCount": ".entity_count",
     "EntityCountWithDefinition": ".entity_count_with_definition",
     "EntityDefinition": ".entity_definition",
@@ -193,6 +187,8 @@ _dynamic_imports: typing.Dict[str, str] = {
     "EntitySummary": ".entity_summary",
     "EntityType": ".entity_type",
     "EntityTypeStats": ".entity_type_stats",
+    "EventMessage": ".event_message",
+    "EventMessageWithAttempts": ".event_message_with_attempts",
     "EventType": ".event_type",
     "FeatureFlag": ".feature_flag",
     "Fields": ".fields",
@@ -207,13 +203,9 @@ _dynamic_imports: typing.Dict[str, str] = {
     "LegacySearchRequestSearchMethod": ".legacy_search_request_search_method",
     "LegacySearchResponse": ".legacy_search_response",
     "MemberResponse": ".member_response",
-    "MessageAttemptOut": ".message_attempt_out",
-    "MessageAttemptTriggerType": ".message_attempt_trigger_type",
-    "MessageOut": ".message_out",
     "MessageResponse": ".message_response",
-    "MessageStatus": ".message_status",
-    "MessageStatusText": ".message_status_text",
     "MinuteLevelScheduleConfig": ".minute_level_schedule_config",
+    "NotFoundErrorResponse": ".not_found_error_response",
     "OAuthBrowserAuthentication": ".o_auth_browser_authentication",
     "OAuthTokenAuthentication": ".o_auth_token_authentication",
     "OAuthType": ".o_auth_type",
@@ -223,7 +215,8 @@ _dynamic_imports: typing.Dict[str, str] = {
     "OrganizationMetrics": ".organization_metrics",
     "OrganizationWithRole": ".organization_with_role",
     "QueryExpansionStrategy": ".query_expansion_strategy",
-    "RecoverOut": ".recover_out",
+    "RateLimitErrorResponse": ".rate_limit_error_response",
+    "RecoveryTask": ".recovery_task",
     "ResponseType": ".response_type",
     "RetrievalStrategy": ".retrieval_strategy",
     "S3ConfigRequest": ".s_3_config_request",
@@ -245,11 +238,11 @@ _dynamic_imports: typing.Dict[str, str] = {
     "SourceRateLimitResponse": ".source_rate_limit_response",
     "SourceRateLimitUpdateRequest": ".source_rate_limit_update_request",
     "SubscriptionInfo": ".subscription_info",
-    "SubscriptionWithAttemptsOut": ".subscription_with_attempts_out",
     "Sync": ".sync",
     "SyncConfig": ".sync_config",
     "SyncCreate": ".sync_create",
     "SyncDetails": ".sync_details",
+    "SyncEventPayload": ".sync_event_payload",
     "SyncJob": ".sync_job",
     "SyncJobDetails": ".sync_job_details",
     "SyncJobStatus": ".sync_job_status",
@@ -266,7 +259,10 @@ _dynamic_imports: typing.Dict[str, str] = {
     "UserCreate": ".user_create",
     "UserOrganization": ".user_organization",
     "ValidationError": ".validation_error",
+    "ValidationErrorDetail": ".validation_error_detail",
     "ValidationErrorLocItem": ".validation_error_loc_item",
+    "ValidationErrorResponse": ".validation_error_response",
+    "WebhookSubscription": ".webhook_subscription",
 }
 
 
@@ -305,8 +301,6 @@ __all__ = [
     "AuthProviderConnectionUpdate",
     "AuthenticationDetails",
     "AuthenticationMethod",
-    "BackgroundTaskStatus",
-    "BackgroundTaskType",
     "BehaviorConfig",
     "BillingPeriod",
     "BillingPeriodStatus",
@@ -320,23 +314,21 @@ __all__ = [
     "CheckoutSessionResponse",
     "Collection",
     "CollectionStatus",
-    "CollectionUpdate",
     "ConfigField",
     "ConfigValues",
+    "ConflictErrorResponse",
     "Connection",
     "ConnectionStatus",
     "CursorConfig",
     "CustomerPortalRequest",
     "CustomerPortalResponse",
+    "DeliveryAttempt",
     "Destination",
     "DestinationConfig",
     "DestinationWithAuthenticationFields",
     "DirectAuthentication",
     "EmbeddingModel",
     "EmbeddingModelWithAuthenticationFields",
-    "EnableEndpointRequest",
-    "EndpointOut",
-    "EndpointSecretOut",
     "EntityCount",
     "EntityCountWithDefinition",
     "EntityDefinition",
@@ -346,6 +338,8 @@ __all__ = [
     "EntitySummary",
     "EntityType",
     "EntityTypeStats",
+    "EventMessage",
+    "EventMessageWithAttempts",
     "EventType",
     "FeatureFlag",
     "Fields",
@@ -360,13 +354,9 @@ __all__ = [
     "LegacySearchRequestSearchMethod",
     "LegacySearchResponse",
     "MemberResponse",
-    "MessageAttemptOut",
-    "MessageAttemptTriggerType",
-    "MessageOut",
     "MessageResponse",
-    "MessageStatus",
-    "MessageStatusText",
     "MinuteLevelScheduleConfig",
+    "NotFoundErrorResponse",
     "OAuthBrowserAuthentication",
     "OAuthTokenAuthentication",
     "OAuthType",
@@ -376,7 +366,8 @@ __all__ = [
     "OrganizationMetrics",
     "OrganizationWithRole",
     "QueryExpansionStrategy",
-    "RecoverOut",
+    "RateLimitErrorResponse",
+    "RecoveryTask",
     "ResponseType",
     "RetrievalStrategy",
     "S3ConfigRequest",
@@ -398,11 +389,11 @@ __all__ = [
     "SourceRateLimitResponse",
     "SourceRateLimitUpdateRequest",
     "SubscriptionInfo",
-    "SubscriptionWithAttemptsOut",
     "Sync",
     "SyncConfig",
     "SyncCreate",
     "SyncDetails",
+    "SyncEventPayload",
     "SyncJob",
     "SyncJobDetails",
     "SyncJobStatus",
@@ -419,5 +410,8 @@ __all__ = [
     "UserCreate",
     "UserOrganization",
     "ValidationError",
+    "ValidationErrorDetail",
     "ValidationErrorLocItem",
+    "ValidationErrorResponse",
+    "WebhookSubscription",
 ]

airweave/types/{endpoint_secret_out.py → conflict_error_response.py}

@@ -6,8 +6,18 @@ import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class EndpointSecretOut(UniversalBaseModel):
-    key: str
+class ConflictErrorResponse(UniversalBaseModel):
+    """
+    Response returned when a resource conflict occurs (HTTP 409).
+
+    This typically occurs when attempting to create a resource that already exists,
+    or when an operation cannot be completed due to the current state of a resource.
+    """
+
+    detail: str = pydantic.Field()
+    """
+    Error message describing the conflict
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2