bandwidth-sdk 6.1.0 → 8.0.0

data/lib/bandwidth/voice_lib/voice/models/{api_modify_conference_request.rb → modify_conference_request.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # ApiModifyConferenceRequest Model.
-  class ApiModifyConferenceRequest < BaseModel
+  # ModifyConferenceRequest Model.
+  class ModifyConferenceRequest < BaseModel
     # TODO: Write general description for this method
     # @return [StatusEnum]
     attr_accessor :status
@@ -93,15 +93,15 @@ module Bandwidth
       fallback_password = hash['fallbackPassword']
 
       # Create object from extracted values.
-      ApiModifyConferenceRequest.new(status,
-                                     redirect_url,
-                                     redirect_fallback_url,
-                                     redirect_method,
-                                     redirect_fallback_method,
-                                     username,
-                                     password,
-                                     fallback_username,
-                                     fallback_password)
+      ModifyConferenceRequest.new(status,
+                                  redirect_url,
+                                  redirect_fallback_url,
+                                  redirect_method,
+                                  redirect_fallback_method,
+                                  username,
+                                  password,
+                                  fallback_username,
+                                  fallback_password)
     end
   end
 end

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

@@ -7,11 +7,14 @@ module Bandwidth
   # State1.
   class State1Enum
     STATE1_ENUM = [
-      # TODO: Write general description for ACTIVE
-      ACTIVE = 'active'.freeze,
+      # TODO: Write general description for NOT_RECORDING
+      NOT_RECORDING = 'NOT_RECORDING'.freeze,
 
-      # TODO: Write general description for COMPLETED
-      COMPLETED = 'completed'.freeze
+      # TODO: Write general description for PAUSED
+      PAUSED = 'PAUSED'.freeze,
+
+      # TODO: Write general description for RECORDING
+      RECORDING = 'RECORDING'.freeze
     ].freeze
   end
 end

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

@@ -7,14 +7,11 @@ module Bandwidth
   # State.
   class StateEnum
     STATE_ENUM = [
-      # TODO: Write general description for DISCONNECTED
-      DISCONNECTED = 'DISCONNECTED'.freeze,
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'active'.freeze,
 
-      # TODO: Write general description for ANSWERED
-      ANSWERED = 'ANSWERED'.freeze,
-
-      # TODO: Write general description for INITIATED
-      INITIATED = 'INITIATED'.freeze
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze
     ].freeze
   end
 end

data/lib/bandwidth/voice_lib/voice/models/{api_transcribe_recording_request.rb → transcribe_recording_request.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # ApiTranscribeRecordingRequest Model.
-  class ApiTranscribeRecordingRequest < BaseModel
+  # TranscribeRecordingRequest Model.
+  class TranscribeRecordingRequest < BaseModel
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :callback_url
@@ -69,12 +69,12 @@ module Bandwidth
       callback_timeout = hash['callbackTimeout']
 
       # Create object from extracted values.
-      ApiTranscribeRecordingRequest.new(callback_url,
-                                        callback_method,
-                                        username,
-                                        password,
-                                        tag,
-                                        callback_timeout)
+      TranscribeRecordingRequest.new(callback_url,
+                                     callback_method,
+                                     username,
+                                     password,
+                                     tag,
+                                     callback_timeout)
     end
   end
 end

data/lib/bandwidth/voice_lib/voice/models/{transcription.rb → transcription_metadata.rb}

@@ -4,21 +4,30 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # Transcription Model.
-  class Transcription < BaseModel
+  # TranscriptionMetadata Model.
+  class TranscriptionMetadata < BaseModel
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :id
 
-    # TODO: Write general description for this method
-    # @return [Status3Enum]
+    # The current status of the transcription. Current values are 'none',
+    # 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and
+    # 'file-size-too-small'. Additional states may be added in the future, so
+    # your application must be tolerant of unknown values.
+    # @return [String]
     attr_accessor :status
 
-    # TODO: Write general description for this method
+    # The current status of the transcription. Current values are 'none',
+    # 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and
+    # 'file-size-too-small'. Additional states may be added in the future, so
+    # your application must be tolerant of unknown values.
     # @return [String]
     attr_accessor :completed_time
 
-    # TODO: Write general description for this method
+    # The current status of the transcription. Current values are 'none',
+    # 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and
+    # 'file-size-too-small'. Additional states may be added in the future, so
+    # your application must be tolerant of unknown values.
     # @return [String]
     attr_accessor :url
 
@@ -53,10 +62,10 @@ module Bandwidth
       url = hash['url']
 
       # Create object from extracted values.
-      Transcription.new(id,
-                        status,
-                        completed_time,
-                        url)
+      TranscriptionMetadata.new(id,
+                                status,
+                                completed_time,
+                                url)
     end
   end
 end

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

@@ -16,12 +16,17 @@ module Bandwidth
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       backoff_factor: 2,
+                       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                       retry_methods: %i[get put get put],
+                       environment: Environment::PRODUCTION,
                        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',
                        voice_basic_auth_password: 'TODO: Replace',
                        web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -32,12 +37,16 @@ module Bandwidth
                                         max_retries: max_retries,
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses,
+                                        retry_methods: retry_methods,
                                         environment: environment,
                                         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,
                                         voice_basic_auth_password: voice_basic_auth_password,
                                         web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,

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

@@ -498,20 +498,20 @@ module WebRtc
     # This will automatically remove any subscriptions the participant has
     # 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
 
@@ -553,20 +553,20 @@ module WebRtc
 
     # 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
 
@@ -621,13 +621,13 @@ module WebRtc
     # subscriptions. Call this function with no `Subscriptions` object to remove
     # 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 +635,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
 

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

@@ -8,10 +8,10 @@ module Bandwidth
   class DeviceApiVersionEnum
     DEVICE_API_VERSION_ENUM = [
       # TODO: Write general description for V3
-      V3 = 'v3'.freeze,
+      V3 = 'V3'.freeze,
 
       # TODO: Write general description for V2
-      V2 = 'v2'.freeze
+      V2 = 'V2'.freeze
     ].freeze
   end
 end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,21 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'bandwidth'
+require_relative '../test_helper'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include Bandwidth
+
+  # Create configuration and set any test parameters
+  CONFIG = Configuration.new
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < Bandwidth::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

data/test/integration/test_integration.rb

@@ -8,7 +8,8 @@ require_relative '../../lib/bandwidth.rb'
 include Bandwidth
 include Bandwidth::Voice
 include Bandwidth::Messaging
-include Bandwidth::TwoFactorAuth
+include Bandwidth::MultiFactorAuth
+include Bandwidth::WebRtc
 
 begin
     USERNAME = ENV.fetch("USERNAME")
@@ -34,8 +35,10 @@ class IntegrationTest < Test::Unit::TestCase
             voice_basic_auth_password: PASSWORD,
             messaging_basic_auth_user_name: USERNAME,
             messaging_basic_auth_password: PASSWORD,
-            two_factor_auth_basic_auth_user_name: USERNAME,
-            two_factor_auth_basic_auth_password: PASSWORD
+            multi_factor_auth_basic_auth_user_name: USERNAME,
+            multi_factor_auth_basic_auth_password: PASSWORD,
+            phone_number_lookup_basic_auth_user_name: USERNAME,
+            phone_number_lookup_basic_auth_password: PASSWORD
         )
     end
 
@@ -56,7 +59,7 @@ class IntegrationTest < Test::Unit::TestCase
         body.from = PHONE_NUMBER_OUTBOUND
         body.text = "Ruby Integration"
         begin
-            @bandwidth_client.messaging_client.client.create_message(ACCOUNT_ID, :body => body)
+            @bandwidth_client.messaging_client.client.create_message(ACCOUNT_ID, body)
             #workaround to make sure that if the above error is not raised, the build will fail
             assert(false, "Expected exception not raised")
         rescue MessagingException => e
@@ -70,7 +73,7 @@ class IntegrationTest < Test::Unit::TestCase
         media_file = '12345' #todo: check a binary string
 
         #media upload
-        @bandwidth_client.messaging_client.client.upload_media(ACCOUNT_ID, media_file_name, media_file.length.to_s, media_file, :content_type => "application/octet-stream", :cache_control => "no-cache")
+        @bandwidth_client.messaging_client.client.upload_media(ACCOUNT_ID, media_file_name, media_file, :content_type => "application/octet-stream", :cache_control => "no-cache")
 
         #media download
         downloaded_media_file = @bandwidth_client.messaging_client.client.get_media(ACCOUNT_ID, media_file_name).data
@@ -79,21 +82,21 @@ class IntegrationTest < Test::Unit::TestCase
     end
 
     def test_create_call_and_get_call_state
-        body = ApiCreateCallRequest.new
+        body = CreateCallRequest.new
         body.from = PHONE_NUMBER_OUTBOUND
         body.to = PHONE_NUMBER_INBOUND
         body.application_id = VOICE_APPLICATION_ID
         body.answer_url = CALLBACK_URL
-        response = @bandwidth_client.voice_client.client.create_call(ACCOUNT_ID, :body => body)
+        response = @bandwidth_client.voice_client.client.create_call(ACCOUNT_ID, body)
         assert(response.data.call_id.length > 0, "call_id value not set")
 
         #Get phone call information
-        response = @bandwidth_client.voice_client.client.get_call_state(ACCOUNT_ID, response.data.call_id)
+        response = @bandwidth_client.voice_client.client.get_call(ACCOUNT_ID, response.data.call_id)
         assert(response.data.state.length > 0, "state value not set")
     end
 
     def test_create_call_invalid_phone_number
-        body = ApiCreateCallRequest.new
+        body = CreateCallRequest.new
         body.from = PHONE_NUMBER_OUTBOUND
         body.to = "+1invalid"
         body.application_id = VOICE_APPLICATION_ID
@@ -103,7 +106,7 @@ class IntegrationTest < Test::Unit::TestCase
             @bandwidth_client.voice_client.client.create_call(ACCOUNT_ID, :body => body)
             #workaround to make sure that if the above error is not raised, the build will fail
             assert(false, "Expected exception not raised")
-        rescue ApiErrorResponseException => e
+        rescue ApiErrorException => e
             assert(e.description.length > 0, "description value not set")
         end
     end
@@ -471,7 +474,7 @@ class IntegrationTest < Test::Unit::TestCase
         body.digits = 6
         body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
 
-        response = @bandwidth_client.two_factor_auth_client.mfa.create_messaging_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_messaging_two_factor(ACCOUNT_ID, body)
         assert(response.data.message_id.length > 0, "message id value not set")
     end
 
@@ -484,7 +487,7 @@ class IntegrationTest < Test::Unit::TestCase
         body.digits = 6
         body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
 
-        response = @bandwidth_client.two_factor_auth_client.mfa.create_voice_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_voice_two_factor(ACCOUNT_ID, body)
         assert(response.data.call_id.length > 0, "call id value not set")
     end
 
@@ -495,7 +498,7 @@ class IntegrationTest < Test::Unit::TestCase
         body.scope = "scope"
         body.code = "123456"
         body.expiration_time_in_minutes = 3
-        response = @bandwidth_client.two_factor_auth_client.mfa.create_verify_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_verify_two_factor(ACCOUNT_ID, body)
         #Ruby has no check to see if variables are of type boolean
         #An explicit true/false check is required
         assert(response.data.valid == true || response.data.valid == false, "'valid' variable is not a boolean")
@@ -567,4 +570,27 @@ class IntegrationTest < Test::Unit::TestCase
         actual = response.to_bxml()
         assert_equal(expected, actual)
     end
+
+    def test_tn_lookup
+        body = OrderRequest.new
+        body.tns = [PHONE_NUMBER_OUTBOUND]
+        create_response = @bandwidth_client.phone_number_lookup_client.client.create_lookup_request(ACCOUNT_ID, body)
+        assert(create_response.data.request_id.length > 0, "request_id value not set")
+
+        request_id = create_response.data.request_id
+        get_response = @bandwidth_client.phone_number_lookup_client.client.get_lookup_request_status(ACCOUNT_ID, request_id)
+        assert(get_response.data.status.length > 0, "status value not set")
+    end
+
+    def test_webrtc_generate_bxml
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Transfer><SipUri uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt">sip:sipx.webrtc.bandwidth.com:5060</SipUri></Transfer></Response>'
+        actual = Bandwidth::WebRtc.generate_bxml('asdf', 'c-93d6f3c0-be584596-0b74-4fa2-8015-d8ede84bd1a4')
+        assert_equal(expected, actual)
+    end
+
+    def test_webrtc_generate_transfer_bxml_verb
+        expected = '<Transfer><SipUri uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt">sip:sipx.webrtc.bandwidth.com:5060</SipUri></Transfer>'
+        actual = Bandwidth::WebRtc.generate_transfer_bxml_verb('asdf', 'c-93d6f3c0-be584596-0b74-4fa2-8015-d8ede84bd1a4')
+        assert_equal(expected, actual)
+    end
 end