bandwidth-sdk 3.2.0 → 3.7.0

data/lib/bandwidth/voice_lib/bxml/verbs/bridge.rb

@@ -0,0 +1,22 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Bridge verb allows you to connect 2 calls 
+    class Bridge
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Bridge(call_id, compact_hash({
+         'bridgeCompleteUrl' => bridge_complete_url,
+         'bridgeCompleteMethod' => bridge_complete_method,
+         'bridgeTargetCompleteUrl' => bridge_target_complete_url,
+         'bridgeTargetCompleteMethod' => bridge_target_complete_method,
+         'username' => username,
+         'password' => password,
+         'tag' => tag
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/conference.rb

@@ -0,0 +1,28 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Conference verb is used to add callees to conferences 
+    class Conference
+      include XmlVerb
+
+      def to_bxml(xml)
+        if not call_ids_to_coach.nil?
+          coach_ids = call_ids_to_coach.instance_of?(String) ? call_ids_to_coach : call_ids_to_coach.join(",")
+        else
+          coach_ids = nil
+        end
+        xml.Conference(conference_name, compact_hash({
+         'mute' => mute,
+         'hold' => hold,
+         'callIdsToCoach' => coach_ids,
+         'conferenceEventUrl' => conference_event_url,
+         'conferenceEventMethod' => conference_event_method,
+         'username' => username,
+         'password' => password,
+         'tag' => tag
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/gather.rb

@@ -28,8 +28,16 @@ module Bandwidth
                s.to_bxml(xml)
              end
            end
+           def nest_verbs_list(xml, property)
+             if property
+               property.each do |verb|
+                 verb.to_bxml(xml)
+               end
+             end
+           end
           embedded_xml(xml, speak_sentence, SpeakSentence)
           embedded_xml(xml, play_audio, PlayAudio)
+          nest_verbs_list(xml, nested_verbs)
         end
       end
     end

data/lib/bandwidth/voice_lib/voice.rb

@@ -12,6 +12,7 @@ require_relative 'voice/models/api_call_state_response.rb'
 require_relative 'voice/models/api_create_call_request.rb'
 require_relative 'voice/models/api_modify_call_request.rb'
 require_relative 'voice/models/api_transcribe_recording_request.rb'
+require_relative 'voice/models/call_engine_modify_conference_request.rb'
 require_relative 'voice/models/modify_call_recording_state.rb'
 require_relative 'voice/models/recording_metadata_response.rb'
 require_relative 'voice/models/transcript.rb'
@@ -29,6 +30,7 @@ require_relative 'voice/models/state1_enum.rb'
 require_relative 'voice/models/state2_enum.rb'
 require_relative 'voice/models/status_enum.rb'
 require_relative 'voice/models/status1_enum.rb'
+require_relative 'voice/models/status2_enum.rb'
 
 # Exceptions
 require_relative 'voice/exceptions/api_error_response_exception.rb'

data/lib/bandwidth/voice_lib/voice/client.rb

@@ -22,7 +22,10 @@ module Bandwidth
                        two_factor_auth_basic_auth_user_name: 'TODO: Replace',
                        two_factor_auth_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
-                       voice_basic_auth_password: 'TODO: Replace', config: nil)
+                       voice_basic_auth_password: 'TODO: Replace',
+                       web_rtc_basic_auth_user_name: 'TODO: Replace',
+                       web_rtc_basic_auth_password: 'TODO: Replace',
+                       config: nil)
           @config = if config.nil?
                       Configuration.new(timeout: timeout,
                                         max_retries: max_retries,
@@ -34,7 +37,9 @@ module Bandwidth
                                         two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
                                         two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
-                                        voice_basic_auth_password: voice_basic_auth_password)
+                                        voice_basic_auth_password: voice_basic_auth_password,
+                                        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                        web_rtc_basic_auth_password: web_rtc_basic_auth_password)
                     else
                       config
                     end

data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb

@@ -44,20 +44,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -122,20 +121,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -203,20 +201,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -283,20 +280,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -376,20 +372,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -460,20 +455,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -536,20 +530,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -610,20 +603,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -684,20 +676,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -764,20 +755,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -848,20 +838,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -928,20 +917,99 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise ApiErrorResponseException.new(
+          'The resource specified cannot be found or does not belong to you.',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise ApiErrorResponseException.new(
+          'We don\'t support that media type. If a request body is required,' \
+          ' please send it to us as `application/json`.',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise ApiErrorResponseException.new(
+          'You\'re sending requests to this endpoint too frequently. Please' \
+          ' slow your request rate down and try again.',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ApiErrorResponseException.new(
+          'Something unexpected happened. Please try again.',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
+    # Modify the conference state
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] conference_id Required parameter: Example:
+    # @param [CallEngineModifyConferenceRequest] body Optional parameter:
+    # Example:
+    # @return [void] response from the API call
+    def modify_conference(account_id,
+                          conference_id,
+                          body: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/conferences/{conferenceId}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id,
+        'conferenceId' => conference_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise ApiErrorResponseException.new(
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise APIException.new(
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ApiErrorResponseException.new(
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404
@@ -1020,20 +1088,19 @@ module Voice
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
         raise ApiErrorResponseException.new(
-          'Something\'s not quite right... Either your request is invalid or' \
-          ' you\'re requesting it at a bad time. Please fix it' \
-          ' before trying again.',
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
           _response
         )
       elsif _response.status_code == 401
         raise APIException.new(
-          'Please authenticate yourself.',
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
           _response
         )
       elsif _response.status_code == 403
         raise ApiErrorResponseException.new(
-          'Your credentials are invalid. Please use your API credentials for' \
-          ' the Bandwidth Dashboard.',
+          'User unauthorized to perform this action.',
           _response
         )
       elsif _response.status_code == 404