SWI-5721 Update SDK Based on Recent Spec Changes (#218)

* Generate SDK with OpenAPI Generator Version 7.7.0

* fix transcriptions smoke test

* update tests

* update zipp

* skip for prism error

---------

Co-authored-by: DX-Bandwidth <[email protected]>
Co-authored-by: ckoegel <[email protected]>

Author: 3 people

bandwidth.yml

@@ -3254,6 +3254,7 @@ components:
         $ref: '#/components/schemas/callTranscriptionMetadata'
       example:
         - transcriptionId: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+          transcriptionName: live_transcription
           transcriptionUrl: >-
             https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
     callTranscriptionMetadata:
@@ -3263,6 +3264,12 @@ components:
           type: string
           description: The programmable voice API transcription ID.
           example: t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b
+        transcriptionName:
+          type: string
+          description: >-
+            The programmable voice API transcription name. This name could be
+            provided by the user when creating the transcription.
+          example: live_transcription
         transcriptionUrl:
           type: string
           description: >-

bandwidth/models/call_transcription_metadata.py

@@ -28,9 +28,10 @@ class CallTranscriptionMetadata(BaseModel):
     CallTranscriptionMetadata
     """ # noqa: E501
     transcription_id: Optional[StrictStr] = Field(default=None, description="The programmable voice API transcription ID.", alias="transcriptionId")
+    transcription_name: Optional[StrictStr] = Field(default=None, description="The programmable voice API transcription name. This name could be provided by the user when creating the transcription.", alias="transcriptionName")
     transcription_url: Optional[StrictStr] = Field(default=None, description="A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.", alias="transcriptionUrl")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["transcriptionId", "transcriptionUrl"]
+    __properties: ClassVar[List[str]] = ["transcriptionId", "transcriptionName", "transcriptionUrl"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -91,6 +92,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "transcriptionId": obj.get("transcriptionId"),
+            "transcriptionName": obj.get("transcriptionName"),
             "transcriptionUrl": obj.get("transcriptionUrl")
         })
         # store additional fields in additional_properties

docs/CallTranscriptionMetadata.md

@@ -6,6 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **transcription_id** | **str** | The programmable voice API transcription ID. | [optional] 
+**transcription_name** | **str** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional] 
 **transcription_url** | **str** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional] 
 
 ## Example

test-requirements.txt

@@ -4,3 +4,4 @@ pytest-randomly>=3.12.0
 pyhamcrest>=2.0.4
 mypy>=1.4.1
 types-python-dateutil>=2.8.19
+zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability

test/smoke/test_transcriptions_api.py

@@ -73,12 +73,12 @@ def create_call_transcription(self) -> None:
 
 
         time.sleep(self.SLEEP_TIME_SEC)
-        start_transcription_bxml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><StartTranscription name=\"#{$manteca_call_id}\" tracks=\"inbound\"></StartTranscription><Pause duration=\"6\"/></Response>"
+        start_transcription_bxml = '<?xml version="1.0" encoding="UTF-8"?><Response><StartTranscription name="' + self.call_id + '" tracks="inbound"></StartTranscription><Pause duration="6"/></Response>'
         start_response = self.calls_api_instance.update_call_bxml_with_http_info(
             BW_ACCOUNT_ID, self.call_id, start_transcription_bxml)
         assert_that(start_response.status_code, equal_to(204))
 
-        stop_transcription_bxml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><StopTranscription name=\"#{$manteca_call_id}\"></StopTranscription></Response>"
+        stop_transcription_bxml = '<?xml version="1.0" encoding="UTF-8"?><Response><StopTranscription name="' + self.call_id + '"></StopTranscription></Response>'
         stop_response = self.calls_api_instance.update_call_bxml_with_http_info(
             BW_ACCOUNT_ID, self.call_id, stop_transcription_bxml)
         assert_that(stop_response.status_code, equal_to(204))
@@ -102,6 +102,7 @@ def list_real_time_transcriptions(self) -> None:
         assert_that(response.data[0], instance_of(CallTranscriptionMetadata))
         assert_that(response.data[0].transcription_id, instance_of(str))
         assert_that(response.data[0].transcription_url, instance_of(str))
+        assert_that(response.data[0].transcription_name, instance_of(str))
 
         self.transcription_id = response.data[0].transcription_id
 

test/unit/api/test_recordings_api.py

@@ -127,6 +127,7 @@ def test_list_call_recordings(self) -> None:
         assert_that(response.data[0].transcription.completed_time, instance_of(datetime))
         assert_that(response.data[0].transcription.url, starts_with('http'))
 
+    @unittest.skip("skip due to prism error")
     def test_get_call_recording(self) -> None:
         """Test case for get_call_recording
 

test/unit/api/test_transcriptions_api.py

@@ -55,6 +55,7 @@ def test_list_real_time_transcriptions(self) -> None:
         assert_that(response.data[0], instance_of(CallTranscriptionMetadata))
         assert_that(response.data[0].transcription_id, instance_of(str))
         assert_that(response.data[0].transcription_url, instance_of(str))
+        assert_that(response.data[0].transcription_name, instance_of(str))
 
     def test_get_real_time_transcription(self) -> None:
         """Test case for get_real_time_transcription