bandwidth-sdk 11.3.0 → 12.0.0

data/spec/integration/recordings_api_integration_spec.rb

@@ -34,14 +34,14 @@ describe 'RecordingsApi Integration Tests' do
       )
 
       sleep(SLEEP_TIME_S * 2)
-      pause_data, pause_status_code, pause_headers = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, pause_recording)
+      _pause_data, pause_status_code = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, pause_recording)
       expect(pause_status_code).to eq(200)
 
       sleep(SLEEP_TIME_S)
-      record_data, record_status_code, record_headers = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, start_recording)
+      _record_data, record_status_code = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, start_recording)
       expect(record_status_code).to eq(200)
 
-      complete_data, complete_status_code, complete_headers = @calls_api_instance.update_call_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $complete_call_body)
+      _complete_data, complete_status_code = @calls_api_instance.update_call_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $complete_call_body)
       expect(complete_status_code).to eq(200)
 
       retries = 0
@@ -63,7 +63,7 @@ describe 'RecordingsApi Integration Tests' do
   # Get Call Recordings
   describe 'list_account_call_recordings' do
     it 'lists account call recordings' do
-      data, status_code, headers = @recordings_api_instance.list_account_call_recordings_with_http_info(BW_ACCOUNT_ID)
+      data, status_code = @recordings_api_instance.list_account_call_recordings_with_http_info(BW_ACCOUNT_ID)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Array)
@@ -76,7 +76,7 @@ describe 'RecordingsApi Integration Tests' do
   # List Call Recordings
   describe 'list_call_recordings' do
     it 'lists all recordings for a single call' do
-      data, status_code, headers = @recordings_api_instance.list_call_recordings_with_http_info(BW_ACCOUNT_ID, $manteca_call_id)
+      data, status_code = @recordings_api_instance.list_call_recordings_with_http_info(BW_ACCOUNT_ID, $manteca_call_id)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Array)
@@ -94,7 +94,7 @@ describe 'RecordingsApi Integration Tests' do
   # Get Call Recording
   describe 'get_call_recording' do
     it 'gets a call recording by id' do
-      data, status_code, headers = @recordings_api_instance.get_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      data, status_code = @recordings_api_instance.get_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
       
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::CallRecordingMetadata)
@@ -109,7 +109,7 @@ describe 'RecordingsApi Integration Tests' do
   # Download Recording
   describe 'download_call_recording' do
     it 'downloads a call recording by id' do
-      data, status_code, headers = @recordings_api_instance.download_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      data, status_code = @recordings_api_instance.download_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(String)
@@ -118,13 +118,13 @@ describe 'RecordingsApi Integration Tests' do
   
   # Create Transcription Request
   describe 'transcribe_call_recording' do
-    it 'creates a transcription request' do
+    it 'creates a recording transcription request' do
       transcribe_recording = Bandwidth::TranscribeRecording.new(
         callback_url: MANTECA_BASE_URL + '/transcriptions',
         tag: $manteca_test_id
       )
 
-      data, status_code, headers = @recordings_api_instance.transcribe_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id, transcribe_recording)
+      _data, status_code = @recordings_api_instance.transcribe_call_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id, transcribe_recording)
       expect(status_code).to eq(204)
 
       retries = 0
@@ -147,10 +147,10 @@ describe 'RecordingsApi Integration Tests' do
   # Get Transcription
   describe 'get_call_transcription' do
     it 'gets the completed call recording transcription' do
-      data, status_code, headers = @recordings_api_instance.get_call_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      data, status_code = @recordings_api_instance.get_recording_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
 
       expect(status_code).to eq(200)
-      expect(data).to be_instance_of(Bandwidth::TranscriptionList)
+      expect(data).to be_instance_of(Bandwidth::RecordingTranscriptions)
       expect(data.transcripts).to be_instance_of(Array)
       expect(data.transcripts[0]).to be_instance_of(Bandwidth::Transcription)
       expect(data.transcripts[0].text).to be_instance_of(String)
@@ -161,7 +161,7 @@ describe 'RecordingsApi Integration Tests' do
   # Delete Transcription
   describe 'delete_call_transcription' do
     it 'deletes the completed call recording transcription' do
-      data, status_code, headers = @recordings_api_instance.delete_call_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
       expect(status_code).to eq(204)
     end
   end
@@ -169,7 +169,7 @@ describe 'RecordingsApi Integration Tests' do
   # Delete Recording Media
   describe 'delete_recording_media' do
     it 'deletes the completed call recording media' do
-      data, status_code, headers = @recordings_api_instance.delete_recording_media_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_media_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
       expect(status_code).to eq(204)
     end
   end
@@ -177,7 +177,7 @@ describe 'RecordingsApi Integration Tests' do
   # Delete Recording
   describe 'delete_recording' do
     it 'deletes the completed call recording data' do
-      data, status_code, headers = @recordings_api_instance.delete_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $recording_id)
       expect(status_code).to eq(204)
     end
   end

data/spec/integration/statistics_api_integration_spec.rb

@@ -16,7 +16,7 @@ describe 'StatisticsApi Integration Tests' do
   # Get Account Statistics
   describe 'get_statistics' do
     it 'gets account statistics' do
-      data, status_code, headers = @statistics_api_instance.get_statistics_with_http_info(BW_ACCOUNT_ID)
+      data, status_code = @statistics_api_instance.get_statistics_with_http_info(BW_ACCOUNT_ID)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::AccountStatistics)

data/spec/integration/transcriptions_api_integration_spec.rb

@@ -0,0 +1,84 @@
+require_relative '../call_utils'
+
+# Integration Tests for Bandwidth::TranscriptionsApi
+describe 'TranscriptionsApi Integration Tests' do
+  before(:all) do
+    WebMock.allow_net_connect!
+    Bandwidth.configure do |config|
+      config.username = BW_USERNAME
+      config.password = BW_PASSWORD
+    end
+    @transcriptions_api_instance = Bandwidth::TranscriptionsApi.new
+    @calls_api_instance = Bandwidth::CallsApi.new
+
+    # transcription info
+    $manteca_test_id = setup_manteca('CALL')
+    $manteca_call_id = create_manteca_call($manteca_test_id, '/bxml/idle', @calls_api_instance)
+    $transcription_id = ''
+  end
+
+  after(:all) do
+    WebMock.disable_net_connect!
+  end
+
+  # Create Call Transcription
+  describe 'create_call_transcription' do
+    it 'creates a call transcription' do
+      sleep(SLEEP_TIME_S)
+
+      start_transcription_bxml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><StartTranscription name=\"#{$manteca_call_id}\" tracks=\"inbound\"></StartTranscription><Pause duration=\"6\"/></Response>"
+      _start_data, start_status_code = @calls_api_instance.update_call_bxml_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, start_transcription_bxml)
+      expect(start_status_code).to eq(204)
+      sleep(SLEEP_TIME_S)
+
+      stop_transcription_bxml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Response><StopTranscription name=\"#{$manteca_call_id}\"></StopTranscription></Response>"
+      _stop_data, stop_status_code = @calls_api_instance.update_call_bxml_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, stop_transcription_bxml)
+      expect(stop_status_code).to eq(204)
+      sleep(SLEEP_TIME_S)
+
+      _complete_data, complete_status_code = @calls_api_instance.update_call_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $complete_call_body)
+      expect(complete_status_code).to eq(200)
+    end
+  end
+
+  # List Real Time Call Transcriptions
+  describe 'list_real_time_transcriptions' do
+    it 'lists call transcriptions' do
+      sleep(SLEEP_TIME_S * 20)
+      data, status_code, _headers = @transcriptions_api_instance.list_real_time_transcriptions_with_http_info(BW_ACCOUNT_ID, $manteca_call_id)
+      
+      expect(status_code).to eq(200)
+      expect(data).to be_instance_of(Array)
+      expect(data[0]).to be_instance_of(Bandwidth::CallTranscriptionMetadata)
+      expect(data[0].transcription_id).to be_instance_of(String)
+      expect(data[0].transcription_url).to be_instance_of(String)
+      $transcription_id = data[0].transcription_id
+    end
+  end
+
+  # Get Real Time Call Transcription
+  describe 'get_real_time_transcription' do
+    it 'gets the specified call transcription' do
+      data, status_code, _headers = @transcriptions_api_instance.get_real_time_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $transcription_id)
+      
+      expect(status_code).to eq(200)
+      expect(data).to be_instance_of(Bandwidth::CallTranscriptionResponse)
+      expect(data.account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.call_id).to eq($manteca_call_id)
+      expect(data.transcription_id).to eq($transcription_id)
+      expect(data.tracks).to be_instance_of(Array)
+      expect(data.tracks[0]).to be_instance_of(Bandwidth::CallTranscription)
+      expect(data.tracks[0].track).to eq('inbound')
+      expect(data.tracks[0].confidence).to be_instance_of(Float)
+    end
+  end
+
+  # Delete Real Time Call Transcription
+  describe 'delete_real_time_transcription' do
+    it 'deletes the specified call transcription' do
+      _data, status_code = @transcriptions_api_instance.delete_real_time_transcription_with_http_info(BW_ACCOUNT_ID, $manteca_call_id, $transcription_id)
+
+      expect(status_code).to eq(200) # This is a bug in the API, it should return 204. VAPI-1863 should fix this.
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -89,7 +89,7 @@ RSpec.configure do |config|
       config.password = BW_PASSWORD
     end
     calls_api = Bandwidth::CallsApi.new
-    # cleanup_calls($active_calls, calls_api)
+    # cleanup_calls($active_calls, calls_api) # left out due to voice API issues
   }
   
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 11.3.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Bandwidth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -137,6 +137,9 @@ files:
 - docs/CallRecordingMetadata.md
 - docs/CallState.md
 - docs/CallStateEnum.md
+- docs/CallTranscription.md
+- docs/CallTranscriptionMetadata.md
+- docs/CallTranscriptionResponse.md
 - docs/CallbackMethodEnum.md
 - docs/CallsApi.md
 - docs/CodeRequest.md
@@ -211,6 +214,8 @@ files:
 - docs/RecordingAvailableCallback.md
 - docs/RecordingCompleteCallback.md
 - docs/RecordingStateEnum.md
+- docs/RecordingTranscriptionMetadata.md
+- docs/RecordingTranscriptions.md
 - docs/RecordingsApi.md
 - docs/RedirectCallback.md
 - docs/RedirectMethodEnum.md
@@ -227,6 +232,7 @@ files:
 - docs/TranscriptionAvailableCallback.md
 - docs/TranscriptionList.md
 - docs/TranscriptionMetadata.md
+- docs/TranscriptionsApi.md
 - docs/TransferAnswerCallback.md
 - docs/TransferCompleteCallback.md
 - docs/TransferDisconnectCallback.md
@@ -249,6 +255,7 @@ files:
 - lib/bandwidth-sdk/api/phone_number_lookup_api.rb
 - lib/bandwidth-sdk/api/recordings_api.rb
 - lib/bandwidth-sdk/api/statistics_api.rb
+- lib/bandwidth-sdk/api/transcriptions_api.rb
 - lib/bandwidth-sdk/api_client.rb
 - lib/bandwidth-sdk/api_error.rb
 - lib/bandwidth-sdk/configuration.rb
@@ -293,6 +300,9 @@ files:
 - lib/bandwidth-sdk/models/call_recording_metadata.rb
 - lib/bandwidth-sdk/models/call_state.rb
 - lib/bandwidth-sdk/models/call_state_enum.rb
+- lib/bandwidth-sdk/models/call_transcription.rb
+- lib/bandwidth-sdk/models/call_transcription_metadata.rb
+- lib/bandwidth-sdk/models/call_transcription_response.rb
 - lib/bandwidth-sdk/models/callback_method_enum.rb
 - lib/bandwidth-sdk/models/code_request.rb
 - lib/bandwidth-sdk/models/conference.rb
@@ -353,6 +363,8 @@ files:
 - lib/bandwidth-sdk/models/recording_available_callback.rb
 - lib/bandwidth-sdk/models/recording_complete_callback.rb
 - lib/bandwidth-sdk/models/recording_state_enum.rb
+- lib/bandwidth-sdk/models/recording_transcription_metadata.rb
+- lib/bandwidth-sdk/models/recording_transcriptions.rb
 - lib/bandwidth-sdk/models/redirect_callback.rb
 - lib/bandwidth-sdk/models/redirect_method_enum.rb
 - lib/bandwidth-sdk/models/stir_shaken.rb
@@ -385,6 +397,7 @@ files:
 - spec/api/phone_number_lookup_api_spec.rb
 - spec/api/recordings_api_spec.rb
 - spec/api/statistics_api_spec.rb
+- spec/api/transcriptions_api_spec.rb
 - spec/api_client_spec.rb
 - spec/api_error_spec.rb
 - spec/call_utils.rb
@@ -398,6 +411,7 @@ files:
 - spec/integration/phone_number_lookup_api_integration_spec.rb
 - spec/integration/recordings_api_integration_spec.rb
 - spec/integration/statistics_api_integration_spec.rb
+- spec/integration/transcriptions_api_integration_spec.rb
 - spec/models/bxml/bxml_spec.rb
 - spec/models/bxml/nestable_verb_spec.rb
 - spec/models/bxml/response_spec.rb
@@ -460,62 +474,64 @@ signing_key:
 specification_version: 4
 summary: Bandwidth Ruby SDK
 test_files:
-- spec/api/recordings_api_spec.rb
 - spec/api/mfa_api_spec.rb
-- spec/api/calls_api_spec.rb
-- spec/api/conferences_api_spec.rb
 - spec/api/statistics_api_spec.rb
+- spec/api/calls_api_spec.rb
 - spec/api/media_api_spec.rb
-- spec/api/phone_number_lookup_api_spec.rb
 - spec/api/messages_api_spec.rb
+- spec/api/recordings_api_spec.rb
+- spec/api/transcriptions_api_spec.rb
+- spec/api/phone_number_lookup_api_spec.rb
+- spec/api/conferences_api_spec.rb
 - spec/api_client_spec.rb
 - spec/api_error_spec.rb
 - spec/call_utils.rb
 - spec/configuration_spec.rb
 - spec/fixtures/ruby_cat.jpeg
-- spec/integration/mfa_api_integration_spec.rb
-- spec/integration/calls_api_integration_spec.rb
 - spec/integration/recordings_api_integration_spec.rb
-- spec/integration/conferences_api_integration_spec.rb
 - spec/integration/messages_api_integration_spec.rb
+- spec/integration/conferences_api_integration_spec.rb
+- spec/integration/mfa_api_integration_spec.rb
 - spec/integration/phone_number_lookup_api_integration_spec.rb
+- spec/integration/calls_api_integration_spec.rb
+- spec/integration/transcriptions_api_integration_spec.rb
 - spec/integration/media_api_integration_spec.rb
 - spec/integration/statistics_api_integration_spec.rb
-- spec/models/deferred_result_spec.rb
-- spec/models/verify_code_request_spec.rb
+- spec/models/message_spec.rb
 - spec/models/call_state_enum_spec.rb
+- spec/models/verify_code_request_spec.rb
+- spec/models/deferred_result_spec.rb
 - spec/models/call_state_spec.rb
 - spec/models/bxml/bxml_spec.rb
-- spec/models/bxml/response_spec.rb
+- spec/models/bxml/nestable_verb_spec.rb
 - spec/models/bxml/verb_spec.rb
-- spec/models/bxml/verbs/stop_stream_spec.rb
-- spec/models/bxml/verbs/start_recording_spec.rb
-- spec/models/bxml/verbs/send_dtmf_spec.rb
+- spec/models/bxml/verbs/conference_spec.rb
+- spec/models/bxml/verbs/stream_param_spec.rb
 - spec/models/bxml/verbs/speak_sentence_spec.rb
-- spec/models/bxml/verbs/custom_param_spec.rb
+- spec/models/bxml/verbs/stop_recording_spec.rb
+- spec/models/bxml/verbs/resume_recording_spec.rb
 - spec/models/bxml/verbs/start_stream_spec.rb
+- spec/models/bxml/verbs/start_gather_spec.rb
+- spec/models/bxml/verbs/redirect_spec.rb
+- spec/models/bxml/verbs/sip_uri_spec.rb
+- spec/models/bxml/verbs/ring_spec.rb
+- spec/models/bxml/verbs/custom_param_spec.rb
+- spec/models/bxml/verbs/send_dtmf_spec.rb
 - spec/models/bxml/verbs/start_transcription_spec.rb
-- spec/models/bxml/verbs/pause_recording_spec.rb
+- spec/models/bxml/verbs/gather_spec.rb
 - spec/models/bxml/verbs/phone_number_spec.rb
-- spec/models/bxml/verbs/stream_param_spec.rb
 - spec/models/bxml/verbs/bridge_spec.rb
-- spec/models/bxml/verbs/record_spec.rb
+- spec/models/bxml/verbs/transfer_spec.rb
 - spec/models/bxml/verbs/pause_spec.rb
-- spec/models/bxml/verbs/play_audio_spec.rb
-- spec/models/bxml/verbs/stop_recording_spec.rb
-- spec/models/bxml/verbs/forward_spec.rb
+- spec/models/bxml/verbs/start_recording_spec.rb
+- spec/models/bxml/verbs/stop_gather_spec.rb
 - spec/models/bxml/verbs/stop_transcription_spec.rb
-- spec/models/bxml/verbs/ring_spec.rb
+- spec/models/bxml/verbs/play_audio_spec.rb
 - spec/models/bxml/verbs/tag_spec.rb
-- spec/models/bxml/verbs/sip_uri_spec.rb
-- spec/models/bxml/verbs/redirect_spec.rb
-- spec/models/bxml/verbs/conference_spec.rb
-- spec/models/bxml/verbs/stop_gather_spec.rb
-- spec/models/bxml/verbs/gather_spec.rb
-- spec/models/bxml/verbs/resume_recording_spec.rb
-- spec/models/bxml/verbs/start_gather_spec.rb
-- spec/models/bxml/verbs/transfer_spec.rb
 - spec/models/bxml/verbs/hangup_spec.rb
-- spec/models/bxml/nestable_verb_spec.rb
-- spec/models/message_spec.rb
+- spec/models/bxml/verbs/forward_spec.rb
+- spec/models/bxml/verbs/pause_recording_spec.rb
+- spec/models/bxml/verbs/stop_stream_spec.rb
+- spec/models/bxml/verbs/record_spec.rb
+- spec/models/bxml/response_spec.rb
 - spec/spec_helper.rb