make data models accessible from top level

Author: maxkahan

.github/workflows/build.yml

@@ -24,7 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python: ["3.9", "3.10", "3.11", "3.12"]
         os: ["ubuntu-latest"]
     steps:
       - name: Clone repo

README.md

@@ -405,13 +405,12 @@ verify_signature(TOKEN, SIGNATURE_SECRET) # Returns a boolean
 
 ## Messages API
 
-
 ### How to Construct a Message
 
-In order to send a message, you must construct a message object of the correct type. These are all found under `vonage_messages.models`.
+In order to send a message, you must construct a message object of the correct type.
 
 ```python
-from vonage_messages.models import Sms
+from vonage_messages import Sms
 
 message = Sms(
     from_='Vonage APIs',
@@ -435,7 +434,7 @@ Some message types have submodels with additional fields. In this case, import t
 e.g.
 
 ```python
-from vonage_messages.models import MessengerImage, MessengerOptions, MessengerResource
+from vonage_messages import MessengerImage, MessengerOptions, MessengerResource
 
 messenger = MessengerImage(
     to='1234567890',
@@ -451,7 +450,7 @@ To send a message, access the `Messages.send` method via the main Vonage object,
 
 ```python
 from vonage import Auth, Vonage
-from vonage_messages.models import Sms
+from vonage_messages import Sms
 
 vonage_client = Vonage(Auth(application_id='my-application-id', private_key='my-private-key'))
 
@@ -970,12 +969,10 @@ response = vonage_client.verify_legacy.request_network_unblock('23410')
 
 ## Video API
 
-You will use the custom Pydantic data models to make most of the API calls in this package. They are accessed from the `vonage_video.models` package.
-
 ### Generate a Client Token
 
 ```python
-from vonage_video.models import TokenOptions
+from vonage_video import TokenOptions
 
 token_options = TokenOptions(session_id='your_session_id', role='publisher')
 client_token = vonage_client.video.generate_client_token(token_options)
@@ -984,7 +981,7 @@ client_token = vonage_client.video.generate_client_token(token_options)
 ### Create a Session
 
 ```python
-from vonage_video.models import SessionOptions
+from vonage_video import SessionOptions
 
 session_options = SessionOptions(media_mode='routed')
 video_session = vonage_client.video.create_session(session_options)
@@ -1005,7 +1002,7 @@ stream_info = vonage_client.video.get_stream(session_id='your_session_id', strea
 ### Change Stream Layout
 
 ```python
-from vonage_video.models import StreamLayoutOptions
+from vonage_video import StreamLayoutOptions
 
 layout_options = StreamLayoutOptions(type='bestFit')
 updated_streams = vonage_client.video.change_stream_layout(session_id='your_session_id', stream_layout_options=layout_options)
@@ -1014,7 +1011,7 @@ updated_streams = vonage_client.video.change_stream_layout(session_id='your_sess
 ### Send a Signal
 
 ```python
-from vonage_video.models import SignalData
+from vonage_video import SignalData
 
 signal_data = SignalData(type='chat', data='Hello, World!')
 vonage_client.video.send_signal(session_id='your_session_id', data=signal_data)
@@ -1047,7 +1044,7 @@ vonage_client.video.disable_mute_all_streams(session_id='your_session_id')
 ### Start Captions
 
 ```python
-from vonage_video.models import CaptionsOptions
+from vonage_video import CaptionsOptions
 
 captions_options = CaptionsOptions(language='en-US')
 captions_data = vonage_client.video.start_captions(captions_options)
@@ -1056,7 +1053,7 @@ captions_data = vonage_client.video.start_captions(captions_options)
 ### Stop Captions
 
 ```python
-from vonage_video.models import CaptionsData
+from vonage_video import CaptionsData
 
 captions_data = CaptionsData(captions_id='your_captions_id')
 vonage_client.video.stop_captions(captions_data)
@@ -1065,7 +1062,7 @@ vonage_client.video.stop_captions(captions_data)
 ### Start Audio Connector
 
 ```python
-from vonage_video.models import AudioConnectorOptions
+from vonage_video import AudioConnectorOptions
 
 audio_connector_options = AudioConnectorOptions(session_id='your_session_id', token='your_token', url='https://example.com')
 audio_connector_data = vonage_client.video.start_audio_connector(audio_connector_options)
@@ -1074,7 +1071,7 @@ audio_connector_data = vonage_client.video.start_audio_connector(audio_connector
 ### Start Experience Composer
 
 ```python
-from vonage_video.models import ExperienceComposerOptions
+from vonage_video import ExperienceComposerOptions
 
 experience_composer_options = ExperienceComposerOptions(session_id='your_session_id', token='your_token', url='https://example.com')
 experience_composer = vonage_client.video.start_experience_composer(experience_composer_options)
@@ -1083,7 +1080,7 @@ experience_composer = vonage_client.video.start_experience_composer(experience_c
 ### List Experience Composers
 
 ```python
-from vonage_video.models import ListExperienceComposersFilter
+from vonage_video import ListExperienceComposersFilter
 
 filter = ListExperienceComposersFilter(page_size=10)
 experience_composers, count, next_page_offset = vonage_client.video.list_experience_composers(filter)
@@ -1105,7 +1102,7 @@ vonage_client.video.stop_experience_composer(experience_composer_id='experience_
 ### List Archives
 
 ```python
-from vonage_video.models import ListArchivesFilter
+from vonage_video import ListArchivesFilter
 
 filter = ListArchivesFilter(offset=2)
 archives, count, next_page_offset = vonage_client.video.list_archives(filter)
@@ -1115,7 +1112,7 @@ print(archives)
 ### Start Archive
 
 ```python
-from vonage_video.models import CreateArchiveRequest
+from vonage_video import CreateArchiveRequest
 
 archive_options = CreateArchiveRequest(session_id='your_session_id', name='My Archive')
 archive = vonage_client.video.start_archive(archive_options)
@@ -1137,7 +1134,7 @@ vonage_client.video.delete_archive(archive_id='your_archive_id')
 ### Add Stream to Archive
 
 ```python
-from vonage_video.models import AddStreamRequest
+from vonage_video import AddStreamRequest
 
 add_stream_request = AddStreamRequest(stream_id='your_stream_id')
 vonage_client.video.add_stream_to_archive(archive_id='your_archive_id', params=add_stream_request)
@@ -1159,7 +1156,7 @@ print(archive)
 ### Change Archive Layout
 
 ```python
-from vonage_video.models import ComposedLayout
+from vonage_video import ComposedLayout
 
 layout = ComposedLayout(type='bestFit')
 archive = vonage_client.video.change_archive_layout(archive_id='your_archive_id', layout=layout)
@@ -1169,7 +1166,7 @@ print(archive)
 ### List Broadcasts
 
 ```python
-from vonage_video.models import ListBroadcastsFilter
+from vonage_video import ListBroadcastsFilter
 
 filter = ListBroadcastsFilter(page_size=10)
 broadcasts, count, next_page_offset = vonage_client.video.list_broadcasts(filter)
@@ -1179,7 +1176,7 @@ print(broadcasts)
 ### Start Broadcast
 
 ```python
-from vonage_video.models import CreateBroadcastRequest, BroadcastOutputSettings, BroadcastHls, BroadcastRtmp
+from vonage_video import CreateBroadcastRequest, BroadcastOutputSettings, BroadcastHls, BroadcastRtmp
 
 broadcast_options = CreateBroadcastRequest(session_id='your_session_id', outputs=BroadcastOutputSettings(
     hls=BroadcastHls(dvr=True, low_latency=False),
@@ -1213,7 +1210,7 @@ print(broadcast)
 ### Change Broadcast Layout
 
 ```python
-from vonage_video.models import ComposedLayout
+from vonage_video import ComposedLayout
 
 layout = ComposedLayout(type='bestFit')
 broadcast = vonage_client.video.change_broadcast_layout(broadcast_id='your_broadcast_id', layout=layout)
@@ -1223,7 +1220,7 @@ print(broadcast)
 ### Add Stream to Broadcast
 
 ```python
-from vonage_video.models import AddStreamRequest
+from vonage_video import AddStreamRequest
 
 add_stream_request = AddStreamRequest(stream_id='your_stream_id')
 vonage_client.video.add_stream_to_broadcast(broadcast_id='your_broadcast_id', params=add_stream_request)
@@ -1238,7 +1235,7 @@ vonage_client.video.remove_stream_from_broadcast(broadcast_id='your_broadcast_id
 ### Initiate SIP Call
 
 ```python
-from vonage_video.models import InitiateSipRequest, SipOptions, SipAuth
+from vonage_video import InitiateSipRequest, SipOptions, SipAuth
 
 sip_request_params = InitiateSipRequest(
     session_id='your_session_id',
@@ -1281,7 +1278,7 @@ vonage_client.video.play_dtmf(session_id=session_id, digits=digits, connection_i
 To create a call, you must pass an instance of the `CreateCallRequest` model to the `create_call` method. If supplying an NCCO, import the NCCO actions you want to use and pass them in as a list to the `ncco` model field.
 
 ```python
-from vonage_voice.models import CreateCallRequest, Talk
+from vonage_voice import CreateCallRequest, Talk
 
 ncco = [Talk(text='Hello world', loop=3, language='en-GB')]
 
@@ -1303,7 +1300,7 @@ print(response.model_dump())
 calls, next_record_index = vonage_client.voice.list_calls()
 
 # Specify filtering options
-from vonage_voice.models import ListCallsFilter
+from vonage_voice import ListCallsFilter
 
 call_filter = ListCallsFilter(
     status='completed',
@@ -1364,7 +1361,7 @@ vonage_client.voice.unearmuff('UUID')
 ### Play Audio Into a Call
 
 ```python
-from vonage_voice.models import AudioStreamOptions
+from vonage_voice import AudioStreamOptions
 
 # Only the `stream_url` option is required
 options = AudioStreamOptions(
@@ -1382,7 +1379,7 @@ vonage_client.voice.stop_audio_stream('UUID')
 ### Play TTS Into a Call
 
 ```python
-from vonage_voice.models import TtsStreamOptions
+from vonage_voice import TtsStreamOptions
 
 # Only the `text` field is required
 options = TtsStreamOptions(

messages/CHANGES.md

@@ -1,3 +1,6 @@
+# 1.4.0
+- Make all models originally accessed by `vonage_messages.models.***` available at the top level of the package, i.e. `vonage_messages.***`
+
 # 1.3.0
 - Add support for API key/secret header authentication
 - Updated dependency versions

messages/README.md

@@ -8,10 +8,10 @@ It is recommended to use this as part of the main `vonage` package. The examples
 
 ### How to Construct a Message
 
-In order to send a message, you must construct a message object of the correct type. These are all found under `vonage_messages.models`.
+In order to send a message, you must construct a message object of the correct type.
 
 ```python
-from vonage_messages.models import Sms
+from vonage_messages import Sms
 
 message = Sms(
     from_='Vonage APIs',
@@ -35,7 +35,7 @@ Some message types have submodels with additional fields. In this case, import t
 e.g.
 
 ```python
-from vonage_messages.models import MessengerImage, MessengerOptions, MessengerResource
+from vonage_messages import MessengerImage, MessengerOptions, MessengerResource
 
 messenger = MessengerImage(
     to='1234567890',
@@ -51,7 +51,7 @@ To send a message, access the `Messages.send` method via the main Vonage object,
 
 ```python
 from vonage import Auth, Vonage
-from vonage_messages.models import Sms
+from vonage_messages import Sms
 
 vonage_client = Vonage(Auth(application_id='my-application-id', private_key='my-private-key'))
 

messages/src/vonage_messages/__init__.py

@@ -1,5 +1,6 @@
-from . import models
+from . import models  # Import models to access the module directly
 from .messages import Messages
+from .models import *  # Need this to directly expose data models
 from .responses import SendMessageResponse
 
 __all__ = ['models', 'Messages', 'SendMessageResponse']

messages/src/vonage_messages/_version.py

@@ -1 +1 @@
-__version__ = '1.3.0'
+__version__ = '1.4.0'

messages/tests/test_messages.py

@@ -2,17 +2,15 @@
 
 import responses
 from pytest import raises
-from vonage_http_client.auth import Auth
-from vonage_http_client.errors import HttpRequestError
-from vonage_http_client.http_client import HttpClient, HttpClientOptions
-from vonage_messages.messages import Messages
-from vonage_messages.models import Sms
-from vonage_messages.models.messenger import (
+from vonage_http_client import Auth, HttpClient, HttpClientOptions, HttpRequestError
+from vonage_messages import (
+    Messages,
     MessengerImage,
     MessengerOptions,
     MessengerResource,
+    SendMessageResponse,
+    Sms,
 )
-from vonage_messages.responses import SendMessageResponse
 
 from testutils import build_response, get_mock_api_key_auth, get_mock_jwt_auth
 

pants.ci.toml

@@ -2,4 +2,4 @@
 colors = true
 
 [python]
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']

pants.toml

@@ -27,20 +27,20 @@ interpreter_constraints = ['==3.12.*']
 args = ['-vv', '--no-header']
 
 [coverage-py]
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']
 report = ['html', 'console']
 
 [black]
 args = ['--line-length=90', '--skip-string-normalization']
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']
 
 [isort]
 args = ['--profile=black', '--line-length=90']
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']
 
 [docformatter]
 args = ['--wrap-summaries=90', '--wrap-descriptions=90']
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']
 
 [autoflake]
-interpreter_constraints = ['>=3.8']
+interpreter_constraints = ['>=3.9']

video/CHANGES.md

@@ -1,3 +1,6 @@
+# 1.2.0
+- Make all models originally accessed by `vonage_video.models.***` available at the top level of the package, i.e. `vonage_video.***`
+
 # 1.1.0
 - Add new `max_bitrate` field for archives