SWI-5799 Update SDK Based on Recent Spec Changes (#221)

band-swi[bot] · DX-Bandwidth · ckoegel · web-flow · commit 1767e341dd5f · 2024-08-12T15:51:31.000-04:00
* Generate SDK with OpenAPI Generator Version 7.7.0

* add unit tests

* fix unit test

---------

Co-authored-by: DX-Bandwidth &lt;dx@bandwidth.com&gt;
Co-authored-by: ckoegel &lt;ckoegel1006@gmail.com&gt;
diff --git a/bandwidth.yml b/bandwidth.yml
@@ -2802,6 +2802,8 @@ components:
           $ref: '#/components/schemas/mediaUrl'
         transcription:
           $ref: '#/components/schemas/recordingTranscriptionMetadata'
+        recordingName:
+          $ref: '#/components/schemas/recordingName'
     conference:
       type: object
       properties:
@@ -3041,6 +3043,8 @@ components:
           $ref: '#/components/schemas/status'
         mediaUrl:
           $ref: '#/components/schemas/mediaUrl'
+        recordingName:
+          $ref: '#/components/schemas/recordingName'
     machineDetectionConfiguration:
       type: object
       description: >-
@@ -4266,6 +4270,10 @@ components:
       type: string
       description: The call id associated with the event.
       example: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+    recordingName:
+      type: string
+      description: A name to identify this recording.
+      example: my-recording-name
     callUrl:
       type: string
       description: The URL of the call associated with the event.
diff --git a/bandwidth/models/call_recording_metadata.py b/bandwidth/models/call_recording_metadata.py
@@ -49,8 +49,9 @@ class CallRecordingMetadata(BaseModel):
     status: Optional[StrictStr] = Field(default=None, description="The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.")
     media_url: Optional[StrictStr] = Field(default=None, description="The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.", alias="mediaUrl")
     transcription: Optional[RecordingTranscriptionMetadata] = None
+    recording_name: Optional[StrictStr] = Field(default=None, description="A name to identify this recording.", alias="recordingName")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["applicationId", "accountId", "callId", "parentCallId", "recordingId", "to", "from", "transferCallerId", "transferTo", "duration", "direction", "channels", "startTime", "endTime", "fileFormat", "status", "mediaUrl", "transcription"]
+    __properties: ClassVar[List[str]] = ["applicationId", "accountId", "callId", "parentCallId", "recordingId", "to", "from", "transferCallerId", "transferTo", "duration", "direction", "channels", "startTime", "endTime", "fileFormat", "status", "mediaUrl", "transcription", "recordingName"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -140,7 +141,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "fileFormat": obj.get("fileFormat"),
             "status": obj.get("status"),
             "mediaUrl": obj.get("mediaUrl"),
-            "transcription": RecordingTranscriptionMetadata.from_dict(obj["transcription"]) if obj.get("transcription") is not None else None
+            "transcription": RecordingTranscriptionMetadata.from_dict(obj["transcription"]) if obj.get("transcription") is not None else None,
+            "recordingName": obj.get("recordingName")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():
diff --git a/bandwidth/models/conference_recording_metadata.py b/bandwidth/models/conference_recording_metadata.py
@@ -40,8 +40,9 @@ class ConferenceRecordingMetadata(BaseModel):
     file_format: Optional[FileFormatEnum] = Field(default=None, alias="fileFormat")
     status: Optional[StrictStr] = Field(default=None, description="The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.")
     media_url: Optional[StrictStr] = Field(default=None, description="The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.", alias="mediaUrl")
+    recording_name: Optional[StrictStr] = Field(default=None, description="A name to identify this recording.", alias="recordingName")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["accountId", "conferenceId", "name", "recordingId", "duration", "channels", "startTime", "endTime", "fileFormat", "status", "mediaUrl"]
+    __properties: ClassVar[List[str]] = ["accountId", "conferenceId", "name", "recordingId", "duration", "channels", "startTime", "endTime", "fileFormat", "status", "mediaUrl", "recordingName"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -116,7 +117,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "endTime": obj.get("endTime"),
             "fileFormat": obj.get("fileFormat"),
             "status": obj.get("status"),
-            "mediaUrl": obj.get("mediaUrl")
+            "mediaUrl": obj.get("mediaUrl"),
+            "recordingName": obj.get("recordingName")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():
diff --git a/docs/CallRecordingMetadata.md b/docs/CallRecordingMetadata.md
@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **status** | **str** | The current status of the process. For recording, current possible values are &#39;processing&#39;, &#39;partial&#39;, &#39;complete&#39;, &#39;deleted&#39;, and &#39;error&#39;. For transcriptions, current possible values are &#39;none&#39;, &#39;processing&#39;, &#39;available&#39;, &#39;error&#39;, &#39;timeout&#39;, &#39;file-size-too-big&#39;, and &#39;file-size-too-small&#39;. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] 
 **media_url** | **str** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] 
 **transcription** | [**RecordingTranscriptionMetadata**](RecordingTranscriptionMetadata.md) |  | [optional] 
+**recording_name** | **str** | A name to identify this recording. | [optional] 
 
 ## Example
 
diff --git a/docs/ConferenceRecordingMetadata.md b/docs/ConferenceRecordingMetadata.md
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [optional] 
 **status** | **str** | The current status of the process. For recording, current possible values are &#39;processing&#39;, &#39;partial&#39;, &#39;complete&#39;, &#39;deleted&#39;, and &#39;error&#39;. For transcriptions, current possible values are &#39;none&#39;, &#39;processing&#39;, &#39;available&#39;, &#39;error&#39;, &#39;timeout&#39;, &#39;file-size-too-big&#39;, and &#39;file-size-too-small&#39;. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] 
 **media_url** | **str** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] 
+**recording_name** | **str** | A name to identify this recording. | [optional] 
 
 ## Example
 
diff --git a/test/unit/api/test_recordings_api.py b/test/unit/api/test_recordings_api.py
@@ -93,6 +93,7 @@ def test_list_account_call_recordings(self) -> None:
         assert_that(response.data[0].transcription.status, instance_of(str))
         assert_that(response.data[0].transcription.completed_time, instance_of(datetime))
         assert_that(response.data[0].transcription.url, starts_with('http'))
+        assert_that(response.data[0].recording_name, instance_of(str))
 
     def test_list_call_recordings(self) -> None:
         """Test case for list_call_recordings
@@ -126,6 +127,7 @@ def test_list_call_recordings(self) -> None:
         assert_that(response.data[0].transcription.status, instance_of(str))
         assert_that(response.data[0].transcription.completed_time, instance_of(datetime))
         assert_that(response.data[0].transcription.url, starts_with('http'))
+        assert_that(response.data[0].recording_name, instance_of(str))
 
     @unittest.skip("skip due to prism error")
     def test_get_call_recording(self) -> None:
@@ -160,6 +162,7 @@ def test_get_call_recording(self) -> None:
         assert_that(response.data.transcription.status, instance_of(str))
         assert_that(response.data.transcription.completed_time, instance_of(datetime))
         assert_that(response.data.transcription.url, starts_with('http'))
+        assert_that(response.data.recording_name, instance_of(str))
 
     def test_download_call_recording(self) -> None:
         """Test case for download_call_recording
