bandwidth-sdk 7.0.0 → 9.1.0

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # ParticipantSubscription Model.
   class ParticipantSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # Participant the subscriber should be subscribed to
     # @return [String]
     attr_accessor :participant_id
@@ -17,8 +20,18 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      []
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(participant_id = nil)
-      @participant_id = participant_id
+      @participant_id = participant_id unless participant_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -26,7 +39,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      participant_id = hash['participantId']
+      participant_id = hash.key?('participantId') ? hash['participantId'] : SKIP
 
       # Create object from extracted values.
       ParticipantSubscription.new(participant_id)

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # A session object
   class Session < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # Unique id of the session
     # @return [String]
     attr_accessor :id
@@ -22,10 +25,23 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        id
+        tag
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(id = nil,
                    tag = nil)
-      @id = id
-      @tag = tag
+      @id = id unless id == SKIP
+      @tag = tag unless tag == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -33,8 +49,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      id = hash['id']
-      tag = hash['tag']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
 
       # Create object from extracted values.
       Session.new(id,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # Subscriptions Model.
   class Subscriptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # Session the subscriptions are associated with
     # If this is the only field, the subscriber will be subscribed to all
     # participants in the session (including any participants that are later
@@ -25,10 +28,22 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        participants
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(session_id = nil,
                    participants = nil)
-      @session_id = session_id
-      @participants = participants
+      @session_id = session_id unless session_id == SKIP
+      @participants = participants unless participants == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -36,7 +51,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      session_id = hash['sessionId']
+      session_id = hash.key?('sessionId') ? hash['sessionId'] : SKIP
       # Parameter is an array, so we need to iterate through it
       participants = nil
       unless hash['participants'].nil?
@@ -46,6 +61,8 @@ module Bandwidth
         end
       end
 
+      participants = SKIP unless hash.key?('participants')
+
       # Create object from extracted values.
       Subscriptions.new(session_id,
                         participants)

data/lib/bandwidth.rb

@@ -9,40 +9,41 @@ require 'faraday'
 require 'certifi'
 require 'logging'
 
-require_relative 'bandwidth/api_helper.rb'
-require_relative 'bandwidth/client.rb'
+require_relative 'bandwidth/api_helper'
+require_relative 'bandwidth/client'
 
 # Utilities
-require_relative 'bandwidth/utilities/file_wrapper.rb'
-require_relative 'bandwidth/utilities/date_time_helper.rb'
+require_relative 'bandwidth/utilities/file_wrapper'
+require_relative 'bandwidth/utilities/date_time_helper'
 
 # Http
-require_relative 'bandwidth/http/api_response.rb'
-require_relative 'bandwidth/http/http_call_back.rb'
-require_relative 'bandwidth/http/http_client.rb'
-require_relative 'bandwidth/http/faraday_client.rb'
-require_relative 'bandwidth/http/http_method_enum.rb'
-require_relative 'bandwidth/http/http_request.rb'
-require_relative 'bandwidth/http/http_response.rb'
+require_relative 'bandwidth/http/api_response'
+require_relative 'bandwidth/http/http_call_back'
+require_relative 'bandwidth/http/http_client'
+require_relative 'bandwidth/http/faraday_client'
+require_relative 'bandwidth/http/http_method_enum'
+require_relative 'bandwidth/http/http_request'
+require_relative 'bandwidth/http/http_response'
 
 # Models
-require_relative 'bandwidth/models/base_model.rb'
+require_relative 'bandwidth/models/base_model'
 
 # Exceptions
-require_relative 'bandwidth/exceptions/api_exception.rb'
+require_relative 'bandwidth/exceptions/api_exception'
 
-require_relative 'bandwidth/configuration.rb'
+require_relative 'bandwidth/configuration'
 
 # Namespaces
 require_relative 'bandwidth/messaging_lib/messaging'
-require_relative 'bandwidth/http/auth/messaging_basic_auth.rb'
+require_relative 'bandwidth/http/auth/messaging_basic_auth'
 require_relative 'bandwidth/multi_factor_auth_lib/multi_factor_auth'
-require_relative 'bandwidth/http/auth/multi_factor_auth_basic_auth.rb'
+require_relative 'bandwidth/http/auth/multi_factor_auth_basic_auth'
 require_relative 'bandwidth/phone_number_lookup_lib/phone_number_lookup'
-require_relative 'bandwidth/http/auth/phone_number_lookup_basic_auth.rb'
+require_relative 'bandwidth/http/auth/phone_number_lookup_basic_auth'
 require_relative 'bandwidth/voice_lib/voice'
-require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
+require_relative 'bandwidth/http/auth/voice_basic_auth'
 require_relative 'bandwidth/web_rtc_lib/web_rtc'
+require_relative 'bandwidth/http/auth/web_rtc_basic_auth'
 require_relative 'bandwidth/http/auth/web_rtc_basic_auth.rb'
 
 # External Files

data/test/integration/test_integration.rb

@@ -3,25 +3,24 @@
 # A simple integration test against Bandwidth's APIs
 
 require 'test/unit'
+require 'securerandom'
 require_relative '../../lib/bandwidth.rb'
 
 include Bandwidth
 include Bandwidth::Voice
 include Bandwidth::Messaging
 include Bandwidth::MultiFactorAuth
+include Bandwidth::WebRtc
 
 begin
-    USERNAME = ENV.fetch("USERNAME")
-    PASSWORD = ENV.fetch("PASSWORD")
-    ACCOUNT_ID = ENV.fetch("ACCOUNT_ID")
-    VOICE_APPLICATION_ID = ENV.fetch("VOICE_APPLICATION_ID")
-    MESSAGING_APPLICATION_ID = ENV.fetch("MESSAGING_APPLICATION_ID")
-    CALLBACK_URL = ENV.fetch("CALLBACK_URL")
-    PHONE_NUMBER_OUTBOUND = ENV.fetch("PHONE_NUMBER_OUTBOUND")
-    PHONE_NUMBER_INBOUND = ENV.fetch("PHONE_NUMBER_INBOUND")
-    MFA_MESSAGING_APPLICATION_ID = ENV.fetch("MFA_MESSAGING_APPLICATION_ID")
-    MFA_VOICE_APPLICATION_ID = ENV.fetch("MFA_VOICE_APPLICATION_ID")
-    PHONE_NUMBER_MFA = ENV.fetch("PHONE_NUMBER_MFA")
+    BW_USERNAME = ENV.fetch("BW_USERNAME")
+    BW_PASSWORD = ENV.fetch("BW_PASSWORD")
+    BW_ACCOUNT_ID = ENV.fetch("BW_ACCOUNT_ID")
+    BW_VOICE_APPLICATION_ID = ENV.fetch("BW_VOICE_APPLICATION_ID")
+    BW_MESSAGING_APPLICATION_ID = ENV.fetch("BW_MESSAGING_APPLICATION_ID")
+    BASE_CALLBACK_URL = ENV.fetch("BASE_CALLBACK_URL")
+    BW_NUMBER = ENV.fetch("BW_NUMBER")
+    USER_NUMBER = ENV.fetch("USER_NUMBER")
 rescue
     puts "Environmental variables not found"
     exit(-1)
@@ -30,35 +29,35 @@ end
 class IntegrationTest < Test::Unit::TestCase
     def setup
         @bandwidth_client = Bandwidth::Client.new(
-            voice_basic_auth_user_name: USERNAME,
-            voice_basic_auth_password: PASSWORD,
-            messaging_basic_auth_user_name: USERNAME,
-            messaging_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
+            voice_basic_auth_user_name: BW_USERNAME,
+            voice_basic_auth_password: BW_PASSWORD,
+            messaging_basic_auth_user_name: BW_USERNAME,
+            messaging_basic_auth_password: BW_PASSWORD,
+            multi_factor_auth_basic_auth_user_name: BW_USERNAME,
+            multi_factor_auth_basic_auth_password: BW_PASSWORD,
+            phone_number_lookup_basic_auth_user_name: BW_USERNAME,
+            phone_number_lookup_basic_auth_password: BW_PASSWORD
         )
     end
 
     def test_create_message
         body = MessageRequest.new
-        body.application_id = MESSAGING_APPLICATION_ID
-        body.to = [PHONE_NUMBER_INBOUND]
-        body.from = PHONE_NUMBER_OUTBOUND
+        body.application_id = BW_MESSAGING_APPLICATION_ID
+        body.to = [USER_NUMBER]
+        body.from = BW_NUMBER
         body.text = "Ruby Integration"
-        response = @bandwidth_client.messaging_client.client.create_message(ACCOUNT_ID, body)
+        response = @bandwidth_client.messaging_client.client.create_message(BW_ACCOUNT_ID, body)
         assert(response.data.id.length > 0, "id value not set") #validate that _some_ id was returned
     end
 
     def test_create_message_invalid_phone_number
         body = MessageRequest.new
-        body.application_id = MESSAGING_APPLICATION_ID
+        body.application_id = BW_MESSAGING_APPLICATION_ID
         body.to = ["+1invalid"]
-        body.from = PHONE_NUMBER_OUTBOUND
+        body.from = BW_NUMBER
         body.text = "Ruby Integration"
         begin
-            @bandwidth_client.messaging_client.client.create_message(ACCOUNT_ID, body)
+            @bandwidth_client.messaging_client.client.create_message(BW_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
@@ -68,41 +67,66 @@ class IntegrationTest < Test::Unit::TestCase
 
     def test_upload_download_media
         #define constants for upload media and download media
-        media_file_name = 'ruby_integration' #future update to add special symbols
-        media_file = '12345' #todo: check a binary string
+        media_id = "text-media-id-" + SecureRandom.uuid
+        media = "Hello world"
 
         #media upload
-        @bandwidth_client.messaging_client.client.upload_media(ACCOUNT_ID, media_file_name, media_file, :content_type => "application/octet-stream", :cache_control => "no-cache")
+        @bandwidth_client.messaging_client.client.upload_media(BW_ACCOUNT_ID, media_id, media, :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
+        downloaded_media = @bandwidth_client.messaging_client.client.get_media(BW_ACCOUNT_ID, media_id).data
 
-        assert_equal(downloaded_media_file, media_file, "Downloaded media file not equal to upload")
+        assert_equal(downloaded_media, media, "Downloaded media file not equal to upload")
     end
 
     def test_create_call_and_get_call_state
         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.from = BW_NUMBER
+        body.to = USER_NUMBER
+        body.application_id = BW_VOICE_APPLICATION_ID
+        body.answer_url = BASE_CALLBACK_URL
+        response = @bandwidth_client.voice_client.client.create_call(BW_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(ACCOUNT_ID, response.data.call_id)
+        response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
+        assert(response.data.state.length > 0, "state value not set")
+    end
+
+    def test_create_call_with_amd_and_get_call_state
+        machine_detection = MachineDetectionConfiguration.new
+        machine_detection.mode = 'async'
+        machine_detection.detection_timeout = 5.0
+        machine_detection.silence_timeout = 5.0
+        machine_detection.speech_threshold = 5.0
+        machine_detection.speech_end_threshold = 5.0
+        machine_detection.delay_result = true
+        machine_detection.callback_url = BASE_CALLBACK_URL + '/machineDetection'
+        machine_detection.callback_method = 'POST'
+
+        body = CreateCallRequest.new
+        body.from = BW_NUMBER
+        body.to = USER_NUMBER
+        body.application_id = BW_VOICE_APPLICATION_ID
+        body.answer_url = BASE_CALLBACK_URL
+        body.machine_detection = machine_detection
+        response = @bandwidth_client.voice_client.client.create_call(BW_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(BW_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 = CreateCallRequest.new
-        body.from = PHONE_NUMBER_OUTBOUND
+        body.from = BW_NUMBER
         body.to = "+1invalid"
-        body.application_id = VOICE_APPLICATION_ID
-        body.answer_url = CALLBACK_URL
+        body.application_id = BW_VOICE_APPLICATION_ID
+        body.answer_url = BASE_CALLBACK_URL
 
         begin
-            @bandwidth_client.voice_client.client.create_call(ACCOUNT_ID, :body => body)
+            @bandwidth_client.voice_client.client.create_call(BW_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 ApiErrorException => e
@@ -466,38 +490,38 @@ class IntegrationTest < Test::Unit::TestCase
 
     def test_mfa_messaging
         body = TwoFactorCodeRequestSchema.new
-        body.from = PHONE_NUMBER_MFA
-        body.to = PHONE_NUMBER_INBOUND
-        body.application_id = MFA_MESSAGING_APPLICATION_ID
+        body.from = BW_NUMBER
+        body.to = USER_NUMBER
+        body.application_id = BW_MESSAGING_APPLICATION_ID
         body.scope = "scope"
         body.digits = 6
         body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
 
-        response = @bandwidth_client.multi_factor_auth_client.mfa.create_messaging_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_messaging_two_factor(BW_ACCOUNT_ID, body)
         assert(response.data.message_id.length > 0, "message id value not set")
     end
 
     def test_mfa_voice
         body = TwoFactorCodeRequestSchema.new
-        body.from = PHONE_NUMBER_MFA
-        body.to = PHONE_NUMBER_INBOUND
-        body.application_id = MFA_VOICE_APPLICATION_ID
+        body.from = BW_NUMBER
+        body.to = USER_NUMBER
+        body.application_id = BW_VOICE_APPLICATION_ID
         body.scope = "scope"
         body.digits = 6
         body.message = "Your temporary {NAME} {SCOPE} code is {CODE}"
 
-        response = @bandwidth_client.multi_factor_auth_client.mfa.create_voice_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_voice_two_factor(BW_ACCOUNT_ID, body)
         assert(response.data.call_id.length > 0, "call id value not set")
     end
 
     def test_mfa_verify
         body = TwoFactorVerifyRequestSchema.new
-        body.to = PHONE_NUMBER_INBOUND
-        body.application_id = MFA_VOICE_APPLICATION_ID
+        body.to = "+1000" + rand(1111111..9999999).to_s
+        body.application_id = BW_VOICE_APPLICATION_ID
         body.scope = "scope"
         body.code = "123456"
         body.expiration_time_in_minutes = 3
-        response = @bandwidth_client.multi_factor_auth_client.mfa.create_verify_two_factor(ACCOUNT_ID, body)
+        response = @bandwidth_client.multi_factor_auth_client.mfa.create_verify_two_factor(BW_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")
@@ -531,13 +555,14 @@ class IntegrationTest < Test::Unit::TestCase
 
     def test_ring
         ring = Bandwidth::Voice::Ring.new({
-            :duration => 5
+            :duration => 5,
+            :answer_call => false
         })
 
         response = Bandwidth::Voice::Response.new()
         response.push(ring)
 
-        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Ring duration="5"/></Response>'
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Ring duration="5" answerCall="false"/></Response>'
         actual = response.to_bxml()
         assert_equal(expected, actual)
     end
@@ -558,7 +583,7 @@ class IntegrationTest < Test::Unit::TestCase
         actual = response.to_bxml()
         assert_equal(expected, actual)
     end
-    
+
     def test_stop_gather
         stop_gather = Bandwidth::Voice::StopGather.new()
 
@@ -572,12 +597,24 @@ class IntegrationTest < Test::Unit::TestCase
 
     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)
+        body.tns = [BW_NUMBER]
+        create_response = @bandwidth_client.phone_number_lookup_client.client.create_lookup_request(BW_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)
+        get_response = @bandwidth_client.phone_number_lookup_client.client.get_lookup_request_status(BW_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -235,9 +235,11 @@ files:
 - lib/bandwidth/voice_lib/voice/exceptions/api_error_exception.rb
 - lib/bandwidth/voice_lib/voice/models/answer_fallback_method_enum.rb
 - lib/bandwidth/voice_lib/voice/models/answer_method_enum.rb
+- lib/bandwidth/voice_lib/voice/models/call_callback.rb
 - lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb
 - lib/bandwidth/voice_lib/voice/models/call_state.rb
 - lib/bandwidth/voice_lib/voice/models/callback_method_enum.rb
+- lib/bandwidth/voice_lib/voice/models/conference_callback.rb
 - lib/bandwidth/voice_lib/voice/models/conference_event_method_enum.rb
 - lib/bandwidth/voice_lib/voice/models/conference_member_state.rb
 - lib/bandwidth/voice_lib/voice/models/conference_recording_metadata.rb
@@ -246,7 +248,11 @@ files:
 - lib/bandwidth/voice_lib/voice/models/create_call_response.rb
 - lib/bandwidth/voice_lib/voice/models/direction_enum.rb
 - lib/bandwidth/voice_lib/voice/models/disconnect_method_enum.rb
+- lib/bandwidth/voice_lib/voice/models/diversion.rb
+- lib/bandwidth/voice_lib/voice/models/fallback_method_enum.rb
 - lib/bandwidth/voice_lib/voice/models/file_format_enum.rb
+- lib/bandwidth/voice_lib/voice/models/machine_detection_configuration.rb
+- lib/bandwidth/voice_lib/voice/models/mode_enum.rb
 - lib/bandwidth/voice_lib/voice/models/modify_call_recording_request.rb
 - lib/bandwidth/voice_lib/voice/models/modify_call_request.rb
 - lib/bandwidth/voice_lib/voice/models/modify_conference_request.rb
@@ -257,6 +263,7 @@ files:
 - lib/bandwidth/voice_lib/voice/models/status_enum.rb
 - lib/bandwidth/voice_lib/voice/models/transcribe_recording_request.rb
 - lib/bandwidth/voice_lib/voice/models/transcript.rb
+- lib/bandwidth/voice_lib/voice/models/transcription.rb
 - lib/bandwidth/voice_lib/voice/models/transcription_metadata.rb
 - lib/bandwidth/voice_lib/voice/models/transcription_response.rb
 - lib/bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb
@@ -298,5 +305,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: bandwidth
+summary: Bandwidth
 test_files: []