fix(speak): correct TTS warning event field names to match API response (#653)

* fix(speak): correct TTS warning event field names to match API response

Changed SpeakV1WarningEvent field names from `code`/`description` to
`warn_code`/`warn_msg` to match the actual field names returned by the
Deepgram API. This fixes Pydantic validation errors that were causing
TTS WebSocket connections to crash instead of calling the on_warning
callback when receiving 429 rate limit warnings.

Updated all related tests to use the correct field names.

Fixes #617

* fix(speak): update docstring and test scenarios for warn_code field

- Change docstring from 'Error code' to 'Warning code' to accurately reflect warning events
- Fix test scenarios to consistently use warn_msg/warn_code field names

Author: lukeocodes

src/deepgram/extensions/types/sockets/speak_v1_warning_event.py

@@ -13,12 +13,12 @@ class SpeakV1WarningEvent(UniversalBaseModel):
 
     type: typing.Literal["Warning"]
     """Message type identifier"""
-    
-    description: str
+
+    warn_msg: str
     """A description of what went wrong"""
-    
-    code: str
-    """Error code identifying the type of error"""
+
+    warn_code: str
+    """Warning code identifying the type of warning"""
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

tests/unit/test_speak_v1_models.py

@@ -157,58 +157,58 @@ def test_valid_warning_event(self):
         """Test creating a valid warning event."""
         event = SpeakV1WarningEvent(
             type="Warning",
-            description="Audio quality may be degraded",
-            code="AUDIO_QUALITY_WARNING"
+            warn_msg="Audio quality may be degraded",
+            warn_code="AUDIO_QUALITY_WARNING"
         )
-        
+
         assert event.type == "Warning"
-        assert event.description == "Audio quality may be degraded"
-        assert event.code == "AUDIO_QUALITY_WARNING"
+        assert event.warn_msg == "Audio quality may be degraded"
+        assert event.warn_code == "AUDIO_QUALITY_WARNING"
 
     def test_warning_event_serialization(self):
         """Test warning event serialization."""
         event = SpeakV1WarningEvent(
             type="Warning",
-            description="Audio quality may be degraded",
-            code="AUDIO_QUALITY_WARNING"
+            warn_msg="Audio quality may be degraded",
+            warn_code="AUDIO_QUALITY_WARNING"
         )
-        
+
         # Test dict conversion
         event_dict = event.model_dump()
         assert event_dict["type"] == "Warning"
-        assert event_dict["description"] == "Audio quality may be degraded"
-        assert event_dict["code"] == "AUDIO_QUALITY_WARNING"
-        
+        assert event_dict["warn_msg"] == "Audio quality may be degraded"
+        assert event_dict["warn_code"] == "AUDIO_QUALITY_WARNING"
+
         # Test JSON serialization
         json_str = event.model_dump_json()
         assert '"type":"Warning"' in json_str
-        assert '"description":"Audio quality may be degraded"' in json_str
+        assert '"warn_msg":"Audio quality may be degraded"' in json_str
 
     def test_warning_event_missing_required_fields(self):
         """Test warning event with missing required fields."""
-        # Missing description
+        # Missing warn_msg
         with pytest.raises(ValidationError) as exc_info:
             SpeakV1WarningEvent(
                 type="Warning",
-                code="AUDIO_QUALITY_WARNING"
+                warn_code="AUDIO_QUALITY_WARNING"
             )
-        assert "description" in str(exc_info.value)
-        
-        # Missing code
+        assert "warn_msg" in str(exc_info.value)
+
+        # Missing warn_code
         with pytest.raises(ValidationError) as exc_info:
             SpeakV1WarningEvent(
                 type="Warning",
-                description="Audio quality may be degraded"
+                warn_msg="Audio quality may be degraded"
             )
-        assert "code" in str(exc_info.value)
+        assert "warn_code" in str(exc_info.value)
 
     def test_warning_event_wrong_type(self):
         """Test warning event with wrong type field."""
         with pytest.raises(ValidationError) as exc_info:
             SpeakV1WarningEvent(
                 type="Error",  # Wrong type
-                description="Audio quality may be degraded",
-                code="AUDIO_QUALITY_WARNING"
+                warn_msg="Audio quality may be degraded",
+                warn_code="AUDIO_QUALITY_WARNING"
             )
         assert "Input should be 'Warning'" in str(exc_info.value)
 
@@ -435,28 +435,28 @@ def test_warning_event_comprehensive(self):
         # Test common warning scenarios
         warning_scenarios = [
             {
-                "description": "Audio quality may be degraded due to low bitrate",
-                "code": "AUDIO_QUALITY_WARNING"
+                "warn_msg": "Audio quality may be degraded due to low bitrate",
+                "warn_code": "AUDIO_QUALITY_WARNING"
             },
             {
-                "description": "Rate limit approaching",
-                "code": "RATE_LIMIT_WARNING"
+                "warn_msg": "Rate limit approaching",
+                "warn_code": "RATE_LIMIT_WARNING"
             },
             {
-                "description": "Model switching to fallback version",
-                "code": "MODEL_FALLBACK_WARNING"
+                "warn_msg": "Model switching to fallback version",
+                "warn_code": "MODEL_FALLBACK_WARNING"
             },
             {
-                "description": "Connection quality poor",
-                "code": "CONNECTION_WARNING"
+                "warn_msg": "Connection quality poor",
+                "warn_code": "CONNECTION_WARNING"
             }
         ]
-        
+
         for scenario in warning_scenarios:
             event = SpeakV1WarningEvent(
                 type="Warning",
-                description=scenario["description"],
-                code=scenario["code"]
+                warn_msg=scenario["warn_msg"],
+                warn_code=scenario["warn_code"]
             )
-            assert event.description == scenario["description"]
-            assert event.code == scenario["code"]
+            assert event.warn_msg == scenario["warn_msg"]
+            assert event.warn_code == scenario["warn_code"]