bandwidth-sdk 11.3.0 → 12.1.0

data/spec/{api → unit/api}/mfa_api_spec.rb

@@ -41,7 +41,7 @@ describe 'MFAApi' do
         digits: digits
       )
 
-      data, status_code, headers = @mfa_api_instance.generate_messaging_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.generate_messaging_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::MessagingCodeResponse)
@@ -50,7 +50,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.generate_messaging_code(nil, {})
+        @mfa_api_instance.generate_messaging_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -75,7 +75,7 @@ describe 'MFAApi' do
         digits: digits
       )
 
-      data, status_code, headers = @mfa_api_instance.generate_voice_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.generate_voice_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::VoiceCodeResponse)
@@ -84,7 +84,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.generate_voice_code(nil, {})
+        @mfa_api_instance.generate_voice_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -108,7 +108,7 @@ describe 'MFAApi' do
         code: '12345'
       )
 
-      data, status_code, headers = @mfa_api_instance.verify_code_with_http_info(BW_ACCOUNT_ID, req_schema)
+      data, status_code = @mfa_api_instance.verify_code_with_http_info(BW_ACCOUNT_ID, req_schema)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Bandwidth::VerifyCodeResponse)
@@ -117,7 +117,7 @@ describe 'MFAApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @mfa_api_instance.verify_code(nil, {})
+        @mfa_api_instance.verify_code(nil, {})
       }.to raise_error(ArgumentError)
     end
 

data/spec/{api → unit/api}/phone_number_lookup_api_spec.rb

@@ -50,7 +50,7 @@ describe 'PhoneNumberLookupApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @phone_number_lookup_api_instance.create_lookup(nil, {})
+        @phone_number_lookup_api_instance.create_lookup(nil, {})
       }.to raise_error(ArgumentError)
     end
 
@@ -87,7 +87,7 @@ describe 'PhoneNumberLookupApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @phone_number_lookup_api_instance.get_lookup_status(nil, '')
+        @phone_number_lookup_api_instance.get_lookup_status(nil, '')
       }.to raise_error(ArgumentError)
     end
 

data/spec/{api → unit/api}/recordings_api_spec.rb

@@ -20,8 +20,8 @@ describe 'RecordingsApi' do
   let(:download_call_recording_headers_stub) { { 'content-type' => 'audio/vnd.wave', 'content-length' => "#{download_call_recording_body_stub.length}" } }
   let(:get_call_recording_headers_stub) { { 'content-type' => 'application/json' } }
   let(:get_call_recording_body_stub) { "{\"applicationId\":\"#{BW_VOICE_APPLICATION_ID}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"callId\":\"#{call_id}\",\"recordingId\":\"#{recording_id}\",\"to\":\"#{USER_NUMBER}\",\"from\":\"#{BW_NUMBER}\",\"duration\":\"#{duration}\",\"direction\":\"#{direction}\",\"channels\":#{channels},\"startTime\":\"#{start_time}\",\"endTime\":\"#{end_time}\",\"fileFormat\":\"#{file_format}\",\"status\":\"#{status}\",\"mediaUrl\":\"#{media_url}\"}" }
-  let(:get_call_transcription_headers_stub) { { 'content-type' => 'application/json' } }
-  let(:get_call_transcription_body_stub) { "{\"transcripts\":[{\"text\":\"#{text}\",\"confidence\":#{confidence}}]}" }
+  let(:get_recording_transcription_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:get_recording_transcription_body_stub) { "{\"transcripts\":[{\"text\":\"#{text}\",\"confidence\":#{confidence}}]}" }
   let(:list_account_call_recordings_headers_stub) { { 'content-type' => 'application/json' } }
   let(:list_account_call_recordings_body_stub) { "[{\"applicationId\":\"#{BW_VOICE_APPLICATION_ID}\",\"accountId\":\"#{BW_ACCOUNT_ID}\",\"callId\":\"#{call_id}\",\"recordingId\":\"#{recording_id}\",\"to\":\"#{USER_NUMBER}\",\"from\":\"#{BW_NUMBER}\",\"duration\":\"#{duration}\",\"direction\":\"#{direction}\",\"channels\":#{channels},\"startTime\":\"#{start_time}\",\"endTime\":\"#{end_time}\",\"fileFormat\":\"#{file_format}\",\"status\":\"#{status}\",\"mediaUrl\":\"#{media_url}\"}]" }
   let(:list_call_recordings_headers_stub) { { 'content-type' => 'application/json' } }
@@ -42,32 +42,32 @@ describe 'RecordingsApi' do
     end
   end
 
-  # Delete Transcription
-  describe 'delete_call_transcription' do
+  # Delete Recording Transcription
+  describe 'delete_recording_transcription' do
     it 'deletes the completed call recording transcription' do
       stub_request(:delete, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/recordings/#{recording_id}/transcription").
       to_return(status: 204)
 
-      data, status_code, headers = @recordings_api_instance.delete_call_transcription_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_transcription_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
 
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.delete_call_transcription(nil, '', '')
+        @recordings_api_instance.delete_recording_transcription(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
     it 'causes an ArgumentError for a missing call_id' do
       expect {
-        @recordings_api_instance.delete_call_transcription(BW_ACCOUNT_ID, nil, '')
+        @recordings_api_instance.delete_recording_transcription(BW_ACCOUNT_ID, nil, '')
       }.to raise_error(ArgumentError)
     end
 
     it 'causes an ArgumentError for a missing recording_id' do
       expect {
-        @recordings_api_instance.delete_call_transcription(BW_ACCOUNT_ID, '', nil)
+        @recordings_api_instance.delete_recording_transcription(BW_ACCOUNT_ID, '', nil)
       }.to raise_error(ArgumentError)
     end
   end
@@ -78,14 +78,14 @@ describe 'RecordingsApi' do
       stub_request(:delete, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/recordings/#{recording_id}").
       to_return(status: 204)
 
-      data, status_code, headers = @recordings_api_instance.delete_recording_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
 
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.delete_recording(nil, '', '')
+        @recordings_api_instance.delete_recording(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -108,14 +108,14 @@ describe 'RecordingsApi' do
       stub_request(:delete, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/recordings/#{recording_id}/media").
       to_return(status: 204)
 
-      data, status_code, headers = @recordings_api_instance.delete_recording_media_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
+      _data, status_code = @recordings_api_instance.delete_recording_media_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
 
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.delete_recording_media(nil, '', '')
+        @recordings_api_instance.delete_recording_media(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -147,7 +147,7 @@ describe 'RecordingsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.download_call_recording(nil, '', '')
+        @recordings_api_instance.download_call_recording(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -193,7 +193,7 @@ describe 'RecordingsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.get_call_recording(nil, '', '')
+        @recordings_api_instance.get_call_recording(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -210,16 +210,16 @@ describe 'RecordingsApi' do
     end
   end
 
-  # Get Transcription
-  describe 'get_call_transcription' do
+  # Get Recording Transcription
+  describe 'get_recording_transcription' do
     it 'gets the completed call recording transcription' do
       stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/recordings/#{recording_id}/transcription").
-      to_return(status: 200, headers: get_call_transcription_headers_stub, body: get_call_transcription_body_stub)
+      to_return(status: 200, headers: get_recording_transcription_headers_stub, body: get_recording_transcription_body_stub)
 
-      data, status_code, headers = @recordings_api_instance.get_call_transcription_with_http_info(BW_ACCOUNT_ID, call_id, recording_id)
+      data, status_code = @recordings_api_instance.get_recording_transcription_with_http_info(BW_ACCOUNT_ID, 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 eq(text)
@@ -228,19 +228,19 @@ describe 'RecordingsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.get_call_transcription(nil, '', '')
+        @recordings_api_instance.get_recording_transcription(nil, '', '')
       }.to raise_error(ArgumentError)
     end
 
     it 'causes an ArgumentError for a missing call_id' do
       expect {
-        @recordings_api_instance.get_call_transcription(BW_ACCOUNT_ID, nil, '')
+        @recordings_api_instance.get_recording_transcription(BW_ACCOUNT_ID, nil, '')
       }.to raise_error(ArgumentError)
     end
 
     it 'causes an ArgumentError for a missing recording_id' do
       expect {
-        @recordings_api_instance.get_call_transcription(BW_ACCOUNT_ID, '', nil)
+        @recordings_api_instance.get_recording_transcription(BW_ACCOUNT_ID, '', nil)
       }.to raise_error(ArgumentError)
     end
   end
@@ -251,7 +251,7 @@ describe 'RecordingsApi' do
       stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/recordings").
       to_return(status: 200, headers: list_account_call_recordings_headers_stub, body: list_account_call_recordings_body_stub)
 
-      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)
@@ -274,7 +274,7 @@ describe 'RecordingsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.list_account_call_recordings(nil)
+        @recordings_api_instance.list_account_call_recordings(nil)
       }.to raise_error(ArgumentError)
     end
   end
@@ -285,7 +285,7 @@ describe 'RecordingsApi' do
       stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/recordings").
       to_return(status: 200, headers: list_call_recordings_headers_stub, body: list_call_recordings_body_stub)
 
-      data, status_code, headers = @recordings_api_instance.list_call_recordings_with_http_info(BW_ACCOUNT_ID, call_id)
+      data, status_code = @recordings_api_instance.list_call_recordings_with_http_info(BW_ACCOUNT_ID, call_id)
 
       expect(status_code).to eq(200)
       expect(data).to be_instance_of(Array)
@@ -307,7 +307,7 @@ describe 'RecordingsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.list_call_recordings(nil, '')
+        @recordings_api_instance.list_call_recordings(nil, '')
       }.to raise_error(ArgumentError)
     end
 
@@ -329,14 +329,14 @@ describe 'RecordingsApi' do
         tag: test_id
       )
 
-      data, status_code, headers = @recordings_api_instance.transcribe_call_recording_with_http_info(BW_ACCOUNT_ID, call_id, recording_id, transcribe_recording)
+      _data, status_code = @recordings_api_instance.transcribe_call_recording_with_http_info(BW_ACCOUNT_ID, call_id, recording_id, transcribe_recording)
 
       expect(status_code).to eq(204)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.transcribe_call_recording(nil, '', '', '')
+        @recordings_api_instance.transcribe_call_recording(nil, '', '', '')
       }.to raise_error(ArgumentError)
     end
 
@@ -369,14 +369,14 @@ describe 'RecordingsApi' do
         state: Bandwidth::RecordingStateEnum::PAUSED
       )
 
-      data, status_code, headers = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, call_id, pause_recording)
+      _data, status_code = @recordings_api_instance.update_call_recording_state_with_http_info(BW_ACCOUNT_ID, call_id, pause_recording)
 
       expect(status_code).to eq(200)
     end
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @recordings_api_instance.update_call_recording_state(nil, '', {})
+        @recordings_api_instance.update_call_recording_state(nil, '', {})
       }.to raise_error(ArgumentError)
     end
 

data/spec/{api → unit/api}/statistics_api_spec.rb

@@ -38,7 +38,7 @@ describe 'StatisticsApi' do
 
     it 'causes an ArgumentError for a missing account_id' do
       expect {
-        resp = @statistics_api_instance.get_statistics(nil)
+        @statistics_api_instance.get_statistics(nil)
       }.to raise_error(ArgumentError)
     end
   end

data/spec/unit/api/transcriptions_api_spec.rb

@@ -0,0 +1,130 @@
+# Unit tests for Bandwidth::TranscriptionsApi
+describe 'TranscriptionsApi' do
+  # transcription info
+  let(:call_id) { 'c-3f758f24-40c0bd9f-0a8e-4ab6-88d4-c88a2e961c7d' }
+  let(:transcription_id) { 't-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b' }
+  let(:transcription_url) { "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/transcriptions/#{transcription_id}" }
+  let(:detected_language) { 'en-US' }
+  let(:track) { 'inbound' }
+  let(:text) { 'Hello World! This is an example.' }
+  let(:confidence) { 0.9 }
+
+  # stubs
+  let(:list_real_time_transcriptions_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:list_real_time_transcriptions_body_stub) { "[{\"transcriptionId\":\"#{transcription_id}\",\"transcriptionUrl\":\"#{transcription_url}\"}]" }
+  let(:get_real_time_transcription_headers_stub) { { 'content-type' => 'application/json' } }
+  let(:get_real_time_transcription_body_stub) { "{\"accountId\":\"#{BW_ACCOUNT_ID}\",\"callId\":\"#{call_id}\",\"transcriptionId\":\"#{transcription_id}\",\"tracks\":[{\"detectedLanguage\":\"#{detected_language}\",\"track\":\"#{track}\",\"text\":\"#{text}\",\"confidence\":#{confidence}}]}" }
+
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.debugging = true
+    end
+    @transcriptions_api_instance = Bandwidth::TranscriptionsApi.new
+  end
+
+  describe 'test an instance of TranscriptionsApi' do
+    it 'should create an instance of TranscriptionsApi' do
+      expect(@transcriptions_api_instance).to be_instance_of(Bandwidth::TranscriptionsApi)
+    end
+  end
+
+  # Delete Call Transcription
+  describe 'delete_real_time_transcription' do
+    it 'deletes the specified call transcription' do
+      stub_request(:delete, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/transcriptions/#{transcription_id}").
+      to_return(status: 204)
+
+      _data, status_code = @transcriptions_api_instance.delete_real_time_transcription_with_http_info(BW_ACCOUNT_ID, call_id, transcription_id)
+
+      expect(status_code).to eq(204)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        @transcriptions_api_instance.delete_real_time_transcription(nil, '', '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @transcriptions_api_instance.delete_real_time_transcription(BW_ACCOUNT_ID, nil, '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing transcription_id' do
+      expect {
+        @transcriptions_api_instance.delete_real_time_transcription(BW_ACCOUNT_ID, '', nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # List Call Transcriptions
+  describe 'list_real_time_transcriptions' do
+    it 'lists call transcriptions' do
+      stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/transcriptions").
+      to_return(status: 200, headers: list_real_time_transcriptions_headers_stub, body: list_real_time_transcriptions_body_stub)
+
+      data, status_code, headers = @transcriptions_api_instance.list_real_time_transcriptions_with_http_info(BW_ACCOUNT_ID, call_id)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(list_real_time_transcriptions_headers_stub)
+      expect(data).to be_instance_of(Array)
+      expect(data[0]).to be_instance_of(Bandwidth::CallTranscriptionMetadata)
+      expect(data[0].transcription_id).to eq(transcription_id)
+      expect(data[0].transcription_url).to eq(transcription_url)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        @transcriptions_api_instance.list_real_time_transcriptions(nil, '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @transcriptions_api_instance.list_real_time_transcriptions(BW_ACCOUNT_ID, nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  # Get Call Transcription
+  describe 'get_real_time_transcription' do
+    it 'gets the specified call transcription' do
+      stub_request(:get, "https://voice.bandwidth.com/api/v2/accounts/#{BW_ACCOUNT_ID}/calls/#{call_id}/transcriptions/#{transcription_id}").
+      to_return(status: 200, headers: get_real_time_transcription_headers_stub, body: get_real_time_transcription_body_stub)
+
+      data, status_code, headers = @transcriptions_api_instance.get_real_time_transcription_with_http_info(BW_ACCOUNT_ID, call_id, transcription_id)
+
+      expect(status_code).to eq(200)
+      expect(headers).to eq(get_real_time_transcription_headers_stub)
+      expect(data).to be_instance_of(Bandwidth::CallTranscriptionResponse)
+      expect(data.account_id).to eq(BW_ACCOUNT_ID)
+      expect(data.call_id).to eq(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].detected_language).to eq(detected_language)
+      expect(data.tracks[0].track).to eq(track)
+      expect(data.tracks[0].text).to eq(text)
+      expect(data.tracks[0].confidence).to eq(confidence)
+    end
+
+    it 'causes an ArgumentError for a missing account_id' do
+      expect {
+        @transcriptions_api_instance.get_real_time_transcription(nil, '', '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing call_id' do
+      expect {
+        @transcriptions_api_instance.get_real_time_transcription(BW_ACCOUNT_ID, nil, '')
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'causes an ArgumentError for a missing transcription_id' do
+      expect {
+        @transcriptions_api_instance.get_real_time_transcription(BW_ACCOUNT_ID, '', nil)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/{api_client_spec.rb → unit/client/api_client_spec.rb}

@@ -111,7 +111,7 @@ describe Bandwidth::ApiClient do
         auth_names: ['Basic'],
         return_type: nil
       }
-      data, status_code, headers = api_client.call_api(:POST, 'path', opts)
+      data, status_code = api_client.call_api(:POST, 'path', opts)
 
       expect(status_code).to eq(204)
       expect(data).to be nil
@@ -130,7 +130,7 @@ describe Bandwidth::ApiClient do
         auth_names: ['Basic'],
         return_type: nil
       }
-      data, status_code, headers = api_client.call_api(:POST, 'path', opts)
+      data, status_code = api_client.call_api(:POST, 'path', opts)
 
       expect(status_code).to eq(204)
       expect(data).to be nil