Resolve VCSWP-20150 (Update SDKs for new Transcribe Utterance Percl command) (#42)

* Include Transcribe Utterance feature into Python SDK

* Add new tests for the new Transcribe Utterance Feature for the python sdk

* Update CHANGELOG file

* Fix formatting of file as per PR comments

Author: amahadaya

.openapi-generator/FILES

@@ -131,6 +131,8 @@ docs/SmsAllOf.md
 docs/StartRecordCall.md
 docs/TerminateConference.md
 docs/TerminateConferenceAllOf.md
+docs/TranscribeUtterance.md
+docs/TranscribeUtteranceRecord.md
 docs/Unpark.md
 docs/UpdateCallRequest.md
 docs/UpdateCallRequestStatus.md
@@ -276,6 +278,8 @@ freeclimb/model/sms_ten_dlc_partner_campaigns_list_result_all_of.py
 freeclimb/model/start_record_call.py
 freeclimb/model/terminate_conference.py
 freeclimb/model/terminate_conference_all_of.py
+freeclimb/model/transcribe_utterance.py
+freeclimb/model/transcribe_utterance_record.py
 freeclimb/model/unpark.py
 freeclimb/model/update_call_request.py
 freeclimb/model/update_call_request_status.py
@@ -289,4 +293,6 @@ requirements.txt
 setup.cfg
 setup.py
 test/__init__.py
+test/test_transcribe_utterance.py
+test/test_transcribe_utterance_record.py
 tox.ini

CHANGELOG.md

@@ -9,13 +9,21 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="4.5.0"></a>
+
+## [4.5.0] - 2023-08-15
+
+### Added
+
+- Transcribe Utterance Feature
+
 <a name="4.4.3"></a>
 
 ## [4.4.3] - 2023-08-24
 
-### Changed 
+### Changed
 
-- Removed testing for properties with 'x-max-length-*' vendor extension
+- Removed testing for properties with 'x-max-length-\*' vendor extension
 
 ### Added
 

README.md

@@ -4,7 +4,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.4.3
+- Package version: 4.5.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
@@ -314,6 +314,8 @@ Class | Method | HTTP request | Description
  - [StartRecordCall](docs/StartRecordCall.md)
  - [TerminateConference](docs/TerminateConference.md)
  - [TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
+ - [TranscribeUtterance](docs/TranscribeUtterance.md)
+ - [TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
  - [Unpark](docs/Unpark.md)
  - [UpdateCallRequest](docs/UpdateCallRequest.md)
  - [UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)

docs/TranscribeUtterance.md

@@ -0,0 +1,16 @@
+# TranscribeUtterance
+
+The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.  `TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **str** |  | 
+**play_beep** | **bool** |  | [optional]  if omitted the server will use the default value of False
+**record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) |  | [optional] 
+**privacy_for_logging** | **bool** |  | [optional]  if omitted the server will use the default value of False
+**privacy_for_recording** | **bool** |  | [optional]  if omitted the server will use the default value of False
+**prompts** | **[bool, date, datetime, dict, float, int, list, str, none_type]** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/TranscribeUtteranceRecord.md

@@ -0,0 +1,12 @@
+# TranscribeUtteranceRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**save_recording** | **bool** |  | [optional]  if omitted the server will use the default value of False
+**max_length_sec** | **int** |  | [optional]  if omitted the server will use the default value of 60
+**rcrd_termination_silence_time_ms** | **int** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

freeclimb/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "4.4.3"
+__version__ = "4.5.0"
 
 # import ApiClient
 from freeclimb.api_client import ApiClient
@@ -158,6 +158,8 @@
 from freeclimb.model.start_record_call import StartRecordCall
 from freeclimb.model.terminate_conference import TerminateConference
 from freeclimb.model.terminate_conference_all_of import TerminateConferenceAllOf
+from freeclimb.model.transcribe_utterance import TranscribeUtterance
+from freeclimb.model.transcribe_utterance_record import TranscribeUtteranceRecord
 from freeclimb.model.unpark import Unpark
 from freeclimb.model.update_call_request import UpdateCallRequest
 from freeclimb.model.update_call_request_status import UpdateCallRequestStatus

freeclimb/api_client.py

@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.4.3/python'
+        self.user_agent = 'OpenAPI-Generator/4.5.0/python'
 
     def __enter__(self):
         return self

freeclimb/configuration.py

@@ -405,7 +405,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 4.4.3".\
+               "SDK Package Version: 4.5.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):