egain-api-python 0.1.1__py3-none-any.whl

egain_api_python/errors/egainerror.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass, field
+
+
+@dataclass(frozen=True)
+class EgainError(Exception):
+    """The base class for all HTTP error responses."""
+
+    message: str
+    status_code: int
+    body: str
+    headers: httpx.Headers = field(hash=False)
+    raw_response: httpx.Response = field(hash=False)
+
+    def __init__(
+        self, message: str, raw_response: httpx.Response, body: Optional[str] = None
+    ):
+        object.__setattr__(self, "message", message)
+        object.__setattr__(self, "status_code", raw_response.status_code)
+        object.__setattr__(
+            self, "body", body if body is not None else raw_response.text
+        )
+        object.__setattr__(self, "headers", raw_response.headers)
+        object.__setattr__(self, "raw_response", raw_response)
+
+    def __str__(self):
+        return self.message

egain_api_python/errors/gethealthop.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+from datetime import datetime
+from egain_api_python.errors import EgainError
+from egain_api_python.types import BaseModel
+import httpx
+from typing import Optional
+
+
+class ServiceUnavailableErrorData(BaseModel):
+    status: Optional[str] = None
+    r"""**Health Status**
+
+    The overall health status of the service. When unhealthy:
+    - Service may not process requests correctly
+    - Performance may be significantly degraded
+    - Some features may be unavailable
+    - Immediate attention is required
+
+    """
+
+    timestamp: Optional[datetime] = None
+    r"""**Health Check Timestamp**
+
+    The exact date and time when this health check was performed. This helps with:
+    - Incident timeline analysis
+    - Problem duration tracking
+    - Recovery time measurement
+    - Historical incident analysis
+
+    """
+
+    version: Optional[str] = None
+    r"""**API Version**
+
+    The current version of the Import Content API. This information is useful for:
+    - Support team identification
+    - Known issue correlation
+    - Version-specific troubleshooting
+    - Upgrade planning
+
+    """
+
+
+@dataclass(frozen=True)
+class ServiceUnavailableError(EgainError):
+    r"""## Service is Unhealthy
+
+    The Import Content service is experiencing critical issues and may not be able to process requests properly.
+
+    **Health Status Details:**
+    - **Overall Status**: Service is unhealthy and may not function correctly
+
+    **Response Information:**
+    - **Status**: Current health state (unhealthy)
+    - **Timestamp**: When health check was performed
+    - **Version**: Current API version
+    - **Issues**: List of detected health problems
+
+    """
+
+    data: ServiceUnavailableErrorData = field(hash=False)
+
+    def __init__(
+        self,
+        data: ServiceUnavailableErrorData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        object.__setattr__(self, "data", data)

egain_api_python/errors/no_response_error.py

@@ -0,0 +1,17 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class NoResponseError(Exception):
+    """Error raised when no HTTP response is received from the server."""
+
+    message: str
+
+    def __init__(self, message: str = "No response received"):
+        object.__setattr__(self, "message", message)
+        super().__init__(message)
+
+    def __str__(self):
+        return self.message

egain_api_python/errors/responsevalidationerror.py

@@ -0,0 +1,27 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+import httpx
+from typing import Optional
+from dataclasses import dataclass
+
+from egain_api_python.errors import EgainError
+
+
+@dataclass(frozen=True)
+class ResponseValidationError(EgainError):
+    """Error raised when there is a type mismatch between the response data and the expected Pydantic model."""
+
+    def __init__(
+        self,
+        message: str,
+        raw_response: httpx.Response,
+        cause: Exception,
+        body: Optional[str] = None,
+    ):
+        message = f"{message}: {cause}"
+        super().__init__(message, raw_response, body)
+
+    @property
+    def cause(self):
+        """Normally the Pydantic ValidationError"""
+        return self.__cause__

egain_api_python/errors/schemas_wserrorcommon.py

@@ -0,0 +1,51 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+from egain_api_python.errors import EgainError
+from egain_api_python.models import (
+    schemas_wserrorcommon as models_schemas_wserrorcommon,
+)
+from egain_api_python.types import BaseModel
+import httpx
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated
+
+
+class SchemasWSErrorCommonData(BaseModel):
+    code: str
+    r"""String that follow the pattern {integer}-{integer}.
+    * The first part is http status code.  The code is unique as a whole. Nothing common between 400-101 and 404-101
+
+    """
+
+    developer_message: Annotated[str, pydantic.Field(alias="developerMessage")]
+    r"""Response explaining what happened"""
+
+    details: Optional[List[models_schemas_wserrorcommon.SchemasWSErrorCommonDetail]] = (
+        None
+    )
+
+    user_message: Annotated[Optional[str], pydantic.Field(alias="userMessage")] = None
+    r"""UI friendly message only supported by some API.
+    * Client must request explicitly by passing X-egain-error-message=yes header
+
+    """
+
+
+@dataclass(frozen=True)
+class SchemasWSErrorCommon(EgainError):
+    r"""Preconditions failed"""
+
+    data: SchemasWSErrorCommonData = field(hash=False)
+
+    def __init__(
+        self,
+        data: SchemasWSErrorCommonData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        object.__setattr__(self, "data", data)

egain_api_python/errors/wserrorcommon.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from dataclasses import dataclass, field
+from egain_api_python.errors import EgainError
+from egain_api_python.models import wserrorcommon as models_wserrorcommon
+from egain_api_python.types import BaseModel
+import httpx
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated
+
+
+class WSErrorCommonData(BaseModel):
+    code: str
+    r"""A string that follows the pattern *{integer}-{integer}*.
+
+    The first *{integer}* is the http status code.  This code as a whole is unique.
+    * For example, error codes \"400-101\" and \"404-101\" are distinctly different.
+
+    """
+
+    developer_message: Annotated[str, pydantic.Field(alias="developerMessage")]
+    r"""A summary of the error."""
+
+    details: Optional[List[models_wserrorcommon.WSErrorCommonDetail]] = None
+
+    user_message: Annotated[Optional[str], pydantic.Field(alias="userMessage")] = None
+    r"""UI friendly messages are only supported by some APIs.
+    * The client must explicitly request UI friendly messages by passing the *X-egain-error-message=yes* header.
+
+    """
+
+
+@dataclass(frozen=True)
+class WSErrorCommon(EgainError):
+    r"""Bad Request"""
+
+    data: WSErrorCommonData = field(hash=False)
+
+    def __init__(
+        self,
+        data: WSErrorCommonData,
+        raw_response: httpx.Response,
+        body: Optional[str] = None,
+    ):
+        message = body or raw_response.text
+        super().__init__(message, raw_response, body)
+        object.__setattr__(self, "data", data)