bandwidth-sdk 6.2.0 → 9.0.0

data/lib/bandwidth/voice_lib/voice/models/transcription_response.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TranscriptionResponse Model.
   class TranscriptionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [List of Transcript]
     attr_accessor :transcripts
@@ -17,8 +20,20 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        transcripts
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(transcripts = nil)
-      @transcripts = transcripts
+      @transcripts = transcripts unless transcripts == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -35,6 +50,8 @@ module Bandwidth
         end
       end
 
+      transcripts = SKIP unless hash.key?('transcripts')
+
       # Create object from extracted values.
       TranscriptionResponse.new(transcripts)
     end

data/lib/bandwidth/voice_lib/voice.rb

@@ -7,40 +7,42 @@
 require_relative 'voice/client.rb'
 
 # Models
-require_relative 'voice/models/api_call_response.rb'
-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_modify_conference_request.rb'
-require_relative 'voice/models/api_transcribe_recording_request.rb'
-require_relative 'voice/models/conference_detail.rb'
-require_relative 'voice/models/conference_member_detail.rb'
-require_relative 'voice/models/conference_recording_metadata_response.rb'
-require_relative 'voice/models/modify_call_recording_state.rb'
-require_relative 'voice/models/recording_metadata_response.rb'
+require_relative 'voice/models/create_call_request.rb'
+require_relative 'voice/models/create_call_response.rb'
+require_relative 'voice/models/call_state.rb'
+require_relative 'voice/models/modify_call_request.rb'
+require_relative 'voice/models/modify_call_recording_request.rb'
+require_relative 'voice/models/call_recording_metadata.rb'
+require_relative 'voice/models/modify_conference_request.rb'
+require_relative 'voice/models/conference_state.rb'
+require_relative 'voice/models/conference_member_state.rb'
+require_relative 'voice/models/conference_recording_metadata.rb'
+require_relative 'voice/models/machine_detection_configuration.rb'
+require_relative 'voice/models/transcribe_recording_request.rb'
+require_relative 'voice/models/transcription_response.rb'
+require_relative 'voice/models/transcription_metadata.rb'
 require_relative 'voice/models/transcript.rb'
+require_relative 'voice/models/call_callback.rb'
 require_relative 'voice/models/transcription.rb'
-require_relative 'voice/models/transcription_response.rb'
+require_relative 'voice/models/diversion.rb'
+require_relative 'voice/models/conference_callback.rb'
 require_relative 'voice/models/answer_fallback_method_enum.rb'
 require_relative 'voice/models/answer_method_enum.rb'
 require_relative 'voice/models/callback_method_enum.rb'
 require_relative 'voice/models/conference_event_method_enum.rb'
 require_relative 'voice/models/direction_enum.rb'
-require_relative 'voice/models/disconnect_cause_enum.rb'
 require_relative 'voice/models/disconnect_method_enum.rb'
+require_relative 'voice/models/fallback_method_enum.rb'
 require_relative 'voice/models/file_format_enum.rb'
+require_relative 'voice/models/mode_enum.rb'
 require_relative 'voice/models/redirect_fallback_method_enum.rb'
 require_relative 'voice/models/redirect_method_enum.rb'
 require_relative 'voice/models/state_enum.rb'
 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/status3_enum.rb'
 
 # Exceptions
-require_relative 'voice/exceptions/api_error_response_exception.rb'
+require_relative 'voice/exceptions/api_error_exception.rb'
 # Controllers
 require_relative 'voice/controllers/base_controller.rb'
 require_relative 'voice/controllers/api_controller.rb'
-require_relative 'bxml/bxml.rb'

data/lib/bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb

@@ -6,8 +6,13 @@
 
 module Bandwidth
   module WebRtc
-    def generate_bxml(device_token, sip_uri="sip:sipx.webrtc.bandwidth.com:5060")
-        return '<?xml version="1.0" encoding="UTF-8"?><Response><Transfer><SipUri uui="%s;encoding=jwt">%s</SipUri></Transfer></Response>' % [device_token, sip_uri]
+    def generate_bxml(device_token, voice_call_id, sip_uri="sip:sipx.webrtc.bandwidth.com:5060")
+        return '<?xml version="1.0" encoding="UTF-8"?><Response>' + generate_transfer_bxml_verb(device_token, voice_call_id, sip_uri) + '</Response>'
+    end
+
+    def generate_transfer_bxml_verb(device_token, voice_call_id, sip_uri="sip:sipx.webrtc.bandwidth.com:5060")
+        voice_call_id = voice_call_id.split("-", 2).last.split("-").join()
+        return '<Transfer><SipUri uui="%s;encoding=base64,%s;encoding=jwt">%s</SipUri></Transfer>' % [voice_call_id, device_token, sip_uri]
     end
   end
 end

data/lib/bandwidth/web_rtc_lib/web_rtc/client.rb

@@ -23,8 +23,8 @@ module Bandwidth
                        base_url: 'https://www.example.com',
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
-                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                       two_factor_auth_basic_auth_password: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_password: 'TODO: Replace',
                        phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
                        phone_number_lookup_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
@@ -43,8 +43,8 @@ module Bandwidth
                                         base_url: base_url,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
-                                        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,
+                                        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
                                         phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
                                         phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,

data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb

@@ -11,9 +11,9 @@ module WebRtc
       super(config, http_call_back: http_call_back)
     end
 
-    # Create a new participant under this account
+    # Create a new participant under this account.
     # Participants are idempotent, so relevant parameters must be set in this
-    # function if desired
+    # function if desired.
     # @param [String] account_id Required parameter: Account ID
     # @param [Participant] body Optional parameter: Participant parameters
     # @return [AccountsParticipantsResponse] response from the API call
@@ -44,17 +44,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise APIException.new(
           'Bad Request',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
@@ -76,7 +77,7 @@ module WebRtc
       )
     end
 
-    # Get participant by ID
+    # Get participant by ID.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] participant_id Required parameter: Participant ID
     # @return [Participant] response from the API call
@@ -106,17 +107,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -137,7 +139,7 @@ module WebRtc
       )
     end
 
-    # Delete participant by ID
+    # Delete participant by ID.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] participant_id Required parameter: Example:
     # @return [void] response from the API call
@@ -161,17 +163,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -189,9 +192,9 @@ module WebRtc
       ApiResponse.new(_response)
     end
 
-    # Create a new session
+    # Create a new session.
     # Sessions are idempotent, so relevant parameters must be set in this
-    # function if desired
+    # function if desired.
     # @param [String] account_id Required parameter: Account ID
     # @param [Session] body Optional parameter: Session parameters
     # @return [Session] response from the API call
@@ -222,17 +225,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise APIException.new(
           'Bad Request',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
@@ -253,7 +257,7 @@ module WebRtc
       )
     end
 
-    # Get session by ID
+    # Get session by ID.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] session_id Required parameter: Session ID
     # @return [Session] response from the API call
@@ -283,17 +287,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -314,7 +319,7 @@ module WebRtc
       )
     end
 
-    # Delete session by ID
+    # Delete session by ID.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] session_id Required parameter: Session ID
     # @return [void] response from the API call
@@ -338,17 +343,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -366,7 +372,7 @@ module WebRtc
       ApiResponse.new(_response)
     end
 
-    # List participants in a session
+    # List participants in a session.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] session_id Required parameter: Session ID
     # @return [List of Participant] response from the API call
@@ -396,17 +402,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -428,8 +435,8 @@ module WebRtc
       )
     end
 
-    # Add a participant to a session
-    # Subscriptions can optionally be provided as part of this call
+    # Add a participant to a session.
+    # Subscriptions can optionally be provided as part of this call.
     # @param [String] account_id Required parameter: Account ID
     # @param [String] session_id Required parameter: Session ID
     # @param [String] participant_id Required parameter: Participant ID
@@ -466,17 +473,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -494,24 +502,24 @@ module WebRtc
       ApiResponse.new(_response)
     end
 
-    # Remove a participant from a session
+    # Remove a participant from a session.
     # This will automatically remove any subscriptions the participant has
-    # associated with this session
+    # associated with this session.
     # @param [String] account_id Required parameter: Account ID
-    # @param [String] participant_id Required parameter: Participant ID
     # @param [String] session_id Required parameter: Session ID
+    # @param [String] participant_id Required parameter: Participant ID
     # @return [void] response from the API call
     def remove_participant_from_session(account_id,
-                                        participant_id,
-                                        session_id)
+                                        session_id,
+                                        participant_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'accountId' => { 'value' => account_id, 'encode' => false },
-        'participantId' => { 'value' => participant_id, 'encode' => false },
-        'sessionId' => { 'value' => session_id, 'encode' => false }
+        'sessionId' => { 'value' => session_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -523,17 +531,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -551,22 +560,22 @@ module WebRtc
       ApiResponse.new(_response)
     end
 
-    # Get a participant's subscriptions
+    # Get a participant's subscriptions.
     # @param [String] account_id Required parameter: Account ID
-    # @param [String] participant_id Required parameter: Participant ID
     # @param [String] session_id Required parameter: Session ID
+    # @param [String] participant_id Required parameter: Participant ID
     # @return [Subscriptions] response from the API call
     def get_participant_subscriptions(account_id,
-                                      participant_id,
-                                      session_id)
+                                      session_id,
+                                      participant_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'accountId' => { 'value' => account_id, 'encode' => false },
-        'participantId' => { 'value' => participant_id, 'encode' => false },
-        'sessionId' => { 'value' => session_id, 'encode' => false }
+        'sessionId' => { 'value' => session_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -584,17 +593,18 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 401
+      case _response.status_code
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response
@@ -615,19 +625,19 @@ module WebRtc
       )
     end
 
-    # Update a participant's subscriptions
+    # Update a participant's subscriptions.
     # This is a full update that will replace the participant's subscriptions.
     # First call `getParticipantSubscriptions` if you need the current
     # subscriptions. Call this function with no `Subscriptions` object to remove
-    # all subscriptions
+    # all subscriptions.
     # @param [String] account_id Required parameter: Account ID
-    # @param [String] participant_id Required parameter: Participant ID
     # @param [String] session_id Required parameter: Session ID
+    # @param [String] participant_id Required parameter: Participant ID
     # @param [Subscriptions] body Optional parameter: Initial state
     # @return [void] response from the API call
     def update_participant_subscriptions(account_id,
-                                         participant_id,
                                          session_id,
+                                         participant_id,
                                          body: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::WEBRTCDEFAULT)
@@ -635,8 +645,8 @@ module WebRtc
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'accountId' => { 'value' => account_id, 'encode' => false },
-        'participantId' => { 'value' => participant_id, 'encode' => false },
-        'sessionId' => { 'value' => session_id, 'encode' => false }
+        'sessionId' => { 'value' => session_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -655,22 +665,23 @@ module WebRtc
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise APIException.new(
           'Bad Request',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise APIException.new(
           'Unauthorized',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise APIException.new(
           'Access Denied',
           _response
         )
-      elsif _response.status_code == 404
+      when 404
         raise APIException.new(
           'Not Found',
           _response

data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/base_controller.rb

@@ -19,14 +19,12 @@ module Bandwidth
 
     def validate_parameters(args)
       args.each do |_name, value|
-        if value.nil?
-          raise ArgumentError, "Required parameter #{_name} cannot be nil."
-        end
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
       end
     end
 
     def execute_request(request, binary: false)
-      @http_call_back.on_before_request(request) if @http_call_back
+      @http_call_back&.on_before_request(request)
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
@@ -36,7 +34,7 @@ module Bandwidth
                  else
                    config.http_client.execute_as_string(request)
                  end
-      @http_call_back.on_after_response(response) if @http_call_back
+      @http_call_back&.on_after_response(response)
 
       response
     end

data/lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # Error class.
   class ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [Integer]
     attr_accessor :code
@@ -27,8 +30,8 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @code = hash['code']
-      @message = hash['message']
+      @code = hash.key?('code') ? hash['code'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
     end
   end
 end

data/lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # AccountsParticipantsResponse Model.
   class AccountsParticipantsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # A participant object
     # @return [Participant]
     attr_accessor :participant
@@ -24,10 +27,23 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        participant
+        token
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(participant = nil,
                    token = nil)
-      @participant = participant
-      @token = token
+      @participant = participant unless participant == SKIP
+      @token = token unless token == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -35,9 +51,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      participant = Participant.from_hash(hash['participant']) if
-        hash['participant']
-      token = hash['token']
+      participant = Participant.from_hash(hash['participant']) if hash['participant']
+      token = hash.key?('token') ? hash['token'] : SKIP
 
       # Create object from extracted values.
       AccountsParticipantsResponse.new(participant,