Expose Response Classes for Inheritance

Author: davidvonthenen

deepgram/__init__.py

@@ -9,32 +9,37 @@
 from .client import Deepgram, DeepgramClient
 from .options import DeepgramClientOptions
 
-# live
-from .clients import LiveTranscriptionEvents
-from .clients import LiveClient, AsyncLiveClient, LiveOptions
+# listen client
+from .client import ListenClient
 
-# onprem
-from .clients import (
-    OnPremClient,
-    AsyncOnPremClient,
+# live
+from .client import LiveTranscriptionEvents
+from .client import LiveClient, AsyncLiveClient
+from .client import LiveOptions
+from .client import (
+    LiveResultResponse,
+    MetadataResponse,
+    ErrorResponse,
 )
 
 # prerecorded
-from .clients import (
-    PreRecordedClient,
-    AsyncPreRecordedClient,
-    PrerecordedOptions,
+from .client import PreRecordedClient, AsyncPreRecordedClient
+from .client import (
     PrerecordedSource,
     FileSource,
     UrlSource,
     BufferSource,
     ReadStreamSource,
+    PrerecordedOptions,
+)
+from .client import (
+    AsyncPrerecordedResponse,
+    PrerecordedResponse,
 )
 
 # manage
-from .clients import (
-    ManageClient,
-    AsyncManageClient,
+from .client import ManageClient, AsyncManageClient
+from .client import (
     ProjectOptions,
     KeyOptions,
     ScopeOptions,
@@ -44,6 +49,31 @@
     UsageFieldsOptions,
 )
 
+# manage client responses
+from .client import (
+    Message,
+    Project,
+    ProjectsResponse,
+    MembersResponse,
+    Key,
+    KeyResponse,
+    KeysResponse,
+    ScopesResponse,
+    InvitesResponse,
+    UsageRequest,
+    UsageRequestsResponse,
+    UsageSummaryResponse,
+    UsageFieldsResponse,
+    Balance,
+    BalancesResponse,
+)
+
+# onprem
+from .client import (
+    OnPremClient,
+    AsyncOnPremClient,
+)
+
 # utilities
 from .audio import Microphone
 from .audio import (

deepgram/client.py

@@ -7,19 +7,74 @@
 import logging, verboselogs
 import os
 
-from .clients.listen import (
-    ListenClient,
-    PreRecordedClient,
-    AsyncLiveClient,
-    AsyncPreRecordedClient,
-    PrerecordedOptions,
+# listen client
+from .clients import ListenClient
+
+# live
+from .clients import LiveClient, AsyncLiveClient
+from .clients import (
     LiveOptions,
     LiveTranscriptionEvents,
 )
+
+# live client responses
+from .clients import (
+    LiveResultResponse,
+    MetadataResponse,
+    ErrorResponse,
+)
+
+# prerecorded
+from .clients import PreRecordedClient, AsyncPreRecordedClient
+from .clients import (
+    PrerecordedSource,
+    FileSource,
+    UrlSource,
+    BufferSource,
+    ReadStreamSource,
+    PrerecordedOptions,
+)
+
+# prerecorded client responses
+from .clients import (
+    AsyncPrerecordedResponse,
+    PrerecordedResponse,
+)
+
+# manage client classes/input
+from .clients import ManageClient, AsyncManageClient
+from .clients import (
+    ProjectOptions,
+    KeyOptions,
+    ScopeOptions,
+    InviteOptions,
+    UsageRequestOptions,
+    UsageSummaryOptions,
+    UsageFieldsOptions,
+)
+
+# manage client responses
+from .clients import (
+    Message,
+    Project,
+    ProjectsResponse,
+    MembersResponse,
+    Key,
+    KeyResponse,
+    KeysResponse,
+    ScopesResponse,
+    InvitesResponse,
+    UsageRequest,
+    UsageRequestsResponse,
+    UsageSummaryResponse,
+    UsageFieldsResponse,
+    Balance,
+    BalancesResponse,
+)
+
+# on-prem
 from .clients.onprem.client import OnPremClient
 from .clients.onprem.v1.async_client import AsyncOnPremClient
-from .clients.manage.client import ManageClient
-from .clients.manage.v1.async_client import AsyncManageClient
 
 from .options import DeepgramClientOptions
 from .errors import DeepgramApiKeyError, DeepgramModuleError

deepgram/clients/__init__.py

@@ -2,16 +2,21 @@
 # Use of this source code is governed by a MIT license that can be found in the LICENSE file.
 # SPDX-License-Identifier: MIT
 
+# listen
+from .listen import ListenClient
+
 # live
-from .live import LiveClient
-from .live import AsyncLiveClient
+from .live import LiveClient, AsyncLiveClient
 from .live import LiveOptions
 from .live import LiveTranscriptionEvents
-from ..options import DeepgramClientOptions
+from .live import (
+    LiveResultResponse,
+    MetadataResponse,
+    ErrorResponse,
+)
 
 # prerecorded
-from .prerecorded import PreRecordedClient
-from .prerecorded import AsyncPreRecordedClient
+from .prerecorded import PreRecordedClient, AsyncPreRecordedClient
 from .prerecorded import PrerecordedOptions
 from .prerecorded import (
     PrerecordedSource,
@@ -20,16 +25,13 @@
     BufferSource,
     ReadStreamSource,
 )
-from ..options import DeepgramClientOptions
-
-# onprem
-from .onprem import OnPremClient
-from .onprem import AsyncOnPremClient
-from ..options import DeepgramClientOptions
+from .prerecorded import (
+    AsyncPrerecordedResponse,
+    PrerecordedResponse,
+)
 
 # manage
-from .manage import ManageClient
-from .manage import AsyncManageClient
+from .manage import ManageClient, AsyncManageClient
 from .manage import (
     ProjectOptions,
     KeyOptions,
@@ -39,4 +41,26 @@
     UsageSummaryOptions,
     UsageFieldsOptions,
 )
+from .manage import (
+    Message,
+    Project,
+    ProjectsResponse,
+    MembersResponse,
+    Key,
+    KeyResponse,
+    KeysResponse,
+    ScopesResponse,
+    InvitesResponse,
+    UsageRequest,
+    UsageRequestsResponse,
+    UsageSummaryResponse,
+    UsageFieldsResponse,
+    Balance,
+    BalancesResponse,
+)
+
+# onprem
+from .onprem import OnPremClient, AsyncOnPremClient
+
+# client options
 from ..options import DeepgramClientOptions

deepgram/clients/listen.py

@@ -6,22 +6,37 @@
 import logging, verboselogs
 
 from ..options import DeepgramClientOptions
+from .errors import DeepgramModuleError
 
+# live client
+# classes and input
 from .prerecorded.client import (
     PreRecordedClient,
     AsyncPreRecordedClient,
     PrerecordedOptions,
 )
+
+# responses
+from .prerecorded.client import (
+    AsyncPrerecordedResponse,
+    PrerecordedResponse,
+)
+
+# live client
+# classes and input
 from .live.client import (
     LiveClient,
     AsyncLiveClient,
     LiveOptions,
+    LiveTranscriptionEvents,
+)
+
+# responses
+from .live.client import (
     LiveResultResponse,
     MetadataResponse,
     ErrorResponse,
-    LiveTranscriptionEvents,
 )
-from .errors import DeepgramModuleError
 
 
 class ListenClient:
@@ -44,6 +59,7 @@ class ListenClient:
         asynclive: Returns an (Async) LiveClient instance for interacting with Deepgram's transcription services.
         asyncprerecorded: Returns an (Async) PreRecordedClient instance for interacting with Deepgram's prerecorded transcription services.
     """
+
     def __init__(self, config: DeepgramClientOptions):
         self.logger = logging.getLogger(__name__)
         self.logger.addHandler(logging.StreamHandler())

deepgram/clients/live/__init__.py

@@ -2,8 +2,13 @@
 # Use of this source code is governed by a MIT license that can be found in the LICENSE file.
 # SPDX-License-Identifier: MIT
 
-from .v1.client import LiveClient
-from .v1.async_client import AsyncLiveClient
+from .client import LiveClient
+from .client import AsyncLiveClient
 from .v1.options import LiveOptions
 from .enums import LiveTranscriptionEvents
 from ...options import DeepgramClientOptions
+from .client import (
+    LiveResultResponse,
+    MetadataResponse,
+    ErrorResponse,
+)

deepgram/clients/live/client.py

@@ -6,29 +6,66 @@
 from .v1.async_client import AsyncLiveClient as AsyncLiveClientLatest
 from .v1.options import LiveOptions as LiveOptionsLatest
 from .enums import LiveTranscriptionEvents
-from .v1.response import LiveResultResponse, MetadataResponse, ErrorResponse
+from .v1.response import (
+    LiveResultResponse as LiveResultResponseLatest,
+    MetadataResponse as MetadataResponseLatest,
+    ErrorResponse as ErrorResponseLatest,
+)
 
 """
 The vX/client.py points to the current supported version in the SDK.
 Older versions are supported in the SDK for backwards compatibility.
 """
 
+
+# input
 class LiveOptions(LiveOptionsLatest):
     """
     pass through for LiveOptions based on API version
     """
+
+    pass
+
+
+# responses
+class LiveResultResponse(LiveResultResponseLatest):
+    """
+    pass through for LiveResultResponse based on API version
+    """
+
+    pass
+
+
+class MetadataResponse(MetadataResponseLatest):
+    """
+    pass through for MetadataResponse based on API version
+    """
+
+    pass
+
+
+class ErrorResponse(ErrorResponseLatest):
+    """
+    pass through for ErrorResponse based on API version
+    """
+
     pass
 
+
+# clients
 class LiveClient(LiveClientLatest):
     """
     Please see LiveClientLatest for details
     """
+
     def __init__(self, config):
         super().__init__(config)
 
+
 class AsyncLiveClient(AsyncLiveClientLatest):
     """
     Please see LiveClientLatest for details
     """
+
     def __init__(self, config):
         super().__init__(config)

deepgram/clients/live/enums.py

@@ -7,10 +7,12 @@
 """
 Constants mapping to events from the Deepgram API
 """
+
+
 class LiveTranscriptionEvents(Enum):
-    Open = "open"
-    Close = "close"
+    Open = "Open"
+    Close = "Close"
     Transcript = "Results"
     Metadata = "Metadata"
-    Error = "error"
-    Warning = "warning"
+    Error = "Error"
+    Warning = "Warning"