bandwidth-sdk 11.1.1 → 11.3.0

data/docs/MessageRequest.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **application_id** | **String** | The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. |  |
 | **to** | **Array<String>** | The phone number(s) the message should be sent to in E164 format. |  |
-| **from** | **String** | One of your telephone numbers the message should come from in E164 format. |  |
+| **from** | **String** | Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message.  Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. |  |
 | **text** | **String** | The contents of the text message. Must be 2048 characters or less. | [optional] |
 | **media** | **Array<String>** | A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. | [optional] |
 | **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |

data/lib/bandwidth-sdk/models/bxml/bxml.rb

@@ -2,7 +2,7 @@ module Bandwidth
   module Bxml
     class Bxml < Bandwidth::Bxml::Root
       # Initializer
-      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      # @param nested_verbs [Verb] or [Array<Verb>] XML element children. Defaults to an empty array.
       def initialize(nested_verbs = [])
         super(tag = 'Bxml', nested_verbs)
       end

data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb

@@ -6,12 +6,12 @@ module Bandwidth
       # Initializer
       # @param tag [String] Name of the XML element.
       # @param content [String] XML element content. Defaults to nil.
-      # @param nested_verbs [Array] XML element children. Defaults to an empty array.
+      # @param nested_verbs [Verb] or [Array<Verb>] XML element children. Defaults to an empty array.
       # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
       def initialize(tag, content = nil, nested_verbs = [], attributes = {})
         @tag = tag
         @content = content
-        @nested_verbs = nested_verbs
+        @nested_verbs = Array(nested_verbs)
         @attributes = attributes
       end
 

data/lib/bandwidth-sdk/models/bxml/response.rb

@@ -2,7 +2,7 @@ module Bandwidth
   module Bxml
     class Response < Bandwidth::Bxml::Root
       # Initializer
-      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      # @param nested_verbs [Verb] or [Array<Verb>] XML element children. Defaults to an empty array.
       def initialize(nested_verbs = [])
         super(tag = 'Response', nested_verbs)
       end

data/lib/bandwidth-sdk/models/bxml/root.rb

@@ -8,10 +8,10 @@ module Bandwidth
     class Root
       # Initializer
       # @param tag [String] Name of the XML element.
-      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      # @param nested_verbs [Verb] or [Array<Verb>] XML element children. Defaults to an empty array.
       def initialize(tag, nested_verbs = [])
         @tag = tag
-        @nested_verbs = nested_verbs
+        @nested_verbs = Array(nested_verbs)
       end
 
       # Generate an XML element for the BXML response
@@ -30,12 +30,18 @@ module Bandwidth
         xml
       end
 
-      # Add a verb to the nested verbs array
+      # Add a verb or verbs to the nested verbs array
       # @param *nested_verbs [Verb] or [Array<Verb>] Verb or verbs to add to the array.
-      def add_verb(nested_verbs)
+      def add_verbs(nested_verbs)
         @nested_verbs.push(*nested_verbs)
       end
 
+      extend Gem::Deprecate
+      def add_verb(nested_verbs)
+        add_verbs(nested_verbs)
+      end
+      deprecate(:add_verb, 'add_verbs', 2024, 7)
+
       # Return BXML representaion of this response
       # @return [String] The XML response in string format.
       def to_bxml

data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb

@@ -2,7 +2,7 @@ module Bandwidth
   module Bxml
     class Gather < Bandwidth::Bxml::NestableVerb
       # Initializer
-      # @param audio_verbs [Array] XML element children. Defaults to an empty array. Valid nested audio verbs are: SpeakSentence, PlayAudio.
+      # @param audio_verbs [Verb] or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested audio verbs are: SpeakSentence, PlayAudio.
       # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
       def initialize(audio_verbs = [], attributes = {})
         super('Gather', nil, audio_verbs, attributes)
@@ -32,11 +32,17 @@ module Bandwidth
         bxml.gsub(SPEAK_SENTENCE_REGEX) { |text| text.gsub(SSML_REGEX, '<\1>') }
       end
 
-      # Add audio verb/s to the nested verbs array
-      # @param audio_verbs [SpeakSentence] || [PlayAudio] or [Array<SpeakSentence || PlayAudio>] Verb or verbs to add to the array.
-      def add_audio_verb(audio_verbs)
+      # Add audio verb or verbs to the nested verbs array
+      # @param audio_verbs [SpeakSentence] or [PlayAudio] or [Array<SpeakSentence || PlayAudio>] Verb or verbs to add to the array.
+      def add_audio_verbs(audio_verbs)
         @nested_verbs.push(*audio_verbs)
       end
+
+      extend Gem::Deprecate
+      def add_audio_verb(audio_verbs)
+        add_audio_verbs(audio_verbs)
+      end
+      deprecate(:add_audio_verb, 'add_audio_verbs', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb

@@ -2,7 +2,7 @@ module Bandwidth
   module Bxml
     class StartStream < Bandwidth::Bxml::NestableVerb
       # Initializer
-      # @param stream_params [Array] XML element children. Defaults to an empty array. Valid nested stream params are: StreamParam. You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.
+      # @param stream_params [Verb] or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested stream params are: StreamParam. You may specify up to 12 <StreamParam/> elements nested within a <StartStream> tag.
       # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
       def initialize(stream_params = [], attributes = {})
         super('StartStream', nil, stream_params, attributes)
@@ -18,11 +18,17 @@ module Bandwidth
         }
       end
 
-      # Add stream param/s to the nested verbs array
+      # Add stream param or params to the nested verbs array
       # @param stream_params [StreamParam] or [Array<StreamParam>] Verb or verbs to add to the array.
-      def add_stream_param(stream_params)
+      def add_stream_params(stream_params)
         @nested_verbs.push(*stream_params)
       end
+
+      extend Gem::Deprecate
+      def add_stream_param(stream_params)
+        add_stream_params(stream_params)
+      end
+      deprecate(:add_stream_param, 'add_stream_params', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb

@@ -2,7 +2,7 @@ module Bandwidth
   module Bxml
     class StartTranscription < Bandwidth::Bxml::NestableVerb
       # Initializer
-      # @param custom_params [Array] XML element children. Defaults to an empty array. Valid nested custom params are: CustomParam. You may specify up to 12 <CustomParam/> elements nested within a <StartTranscription> tag.
+      # @param custom_params [Verb] or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested custom params are: CustomParam. You may specify up to 12 <CustomParam/> elements nested within a <StartTranscription> tag.
       # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
       def initialize(custom_params = [], attributes = {})
         super('StartTranscription', nil, custom_params, attributes)
@@ -19,11 +19,17 @@ module Bandwidth
         }
       end
 
-      # Add custom param/s to the nested verbs array
+      # Add custom param or params to the nested verbs array
       # @param custom_params [CustomParam] or [Array<CustomParam>] Verb or verbs to add to the array.
-      def add_custom_param(custom_params)
+      def add_custom_params(custom_params)
         @nested_verbs.push(*custom_params)
       end
+
+      extend Gem::Deprecate
+      def add_custom_param(custom_params)
+        add_custom_params(custom_params)
+      end
+      deprecate(:add_custom_param, 'add_custom_params', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb

@@ -2,14 +2,15 @@ module Bandwidth
   module Bxml
     class Transfer < Bandwidth::Bxml::NestableVerb
       # Initializer
-      # @param transfer_to [Array] XML element children. Defaults to an empty array. Valid nested transfer verbs are: PhoneNumber, SipUri.
+      # @param transfer_to [Verb] or [Array<Verb>] XML element children. Defaults to an empty array. Valid nested transfer verbs are: PhoneNumber, SipUri.
       # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
       def initialize(transfer_to = [], attributes = {})
         super('Transfer', nil, transfer_to, attributes)
         
         @attribute_map = {
           transfer_caller_id: 'transferCallerId',                               # Optional [String]: The caller ID to use when the call is transferred, if different. Must be in E.164 format (e.g. +15555555555) or be one of the following strings Restricted, Anonymous, Private, or Unavailable. Leave as default to pass along the number of the remote party. Defaults to None.
-          call_timeout: 'callTimeout',                                          # Optional [Number]:The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None.
+          transfer_caller_display_name: 'transferCallerDisplayName',            # Optional [String]: The caller display name to use when the call is transferred. May not exceed 256 characters nor contain control characters such as new lines. Defaults to None.
+          call_timeout: 'callTimeout',                                          # Optional [Number]: The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Range: decimal values between 1 - 300. Default value is 30 seconds. Defaults to None.
           transfer_complete_url: 'transferCompleteUrl',                         # Optional [String]: URL to send the Transfer Complete event to and request new BXML. Optional but recommended. See below for further details. May be a relative URL. Defaults to None.
           transfer_complete_method: 'transferCompleteMethod',                   # Optional [String]: The HTTP method to use for the request to transferCompleteUrl. GET or POST. Default value is POST. Defaults to None.
           transfer_complete_fallback_url: 'transferCompleteFallbackUrl',        # Optional [String]: A fallback url which, if provided, will be used to retry the Transfer Complete callback delivery in case transferCompleteUrl fails to respond. Defaults to None.
@@ -24,11 +25,17 @@ module Bandwidth
         }
       end
 
-      # Add transfer recipient/s to the nested verbs array
-      # @param recipients [PhoneNumber] || [SipUri] or [Array<PhoneNumber || SipUri>] Verb or verbs to add to the array.
-      def add_transfer_recipient(recipients)
+      # Add transfer recipient or recipients to the nested verbs array
+      # @param recipients [PhoneNumber] or [SipUri] or [Array<PhoneNumber || SipUri>] Verb or verbs to add to the array.
+      def add_transfer_recipients(recipients)
         @nested_verbs.push(*recipients)
       end
+
+      extend Gem::Deprecate
+      def add_transfer_recipient(recipients)
+        add_transfer_recipients(recipients)
+      end
+      deprecate(:add_transfer_recipient, 'add_transfer_recipients', 2024, 7)
     end
   end
 end

data/lib/bandwidth-sdk/models/message_request.rb

@@ -21,7 +21,7 @@ module Bandwidth
     # The phone number(s) the message should be sent to in E164 format.
     attr_accessor :to
 
-    # One of your telephone numbers the message should come from in E164 format.
+    # Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message.  Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter.
     attr_accessor :from
 
     # The contents of the text message. Must be 2048 characters or less.

data/lib/bandwidth-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.0
 =end
 
 module Bandwidth
-  VERSION = '11.1.1'
+  VERSION = '11.3.0'
 end

data/spec/models/bxml/bxml_spec.rb

@@ -1,6 +1,7 @@
 # Unit tests for Bandwidth::Bxml::Bxml
 describe 'Bandwidth::Bxml::Bxml' do
   let(:instance) { Bandwidth::Bxml::Bxml.new }
+  let(:pause_recording) { Bandwidth::Bxml::PauseRecording.new }
 
   describe 'test an instance of Bxml' do
     it 'validates instance of Bxml' do
@@ -8,6 +9,30 @@ describe 'Bandwidth::Bxml::Bxml' do
       expect(instance).to be_a(Bandwidth::Bxml::Root)
     end
 
+    it 'test initializing with a single nested verb' do
+      instance = Bandwidth::Bxml::Bxml.new(pause_recording)
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Bxml>\n  <PauseRecording/>\n</Bxml>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test initializing with multiple nested verbs' do
+      instance = Bandwidth::Bxml::Bxml.new([pause_recording, pause_recording])
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Bxml>\n  <PauseRecording/>\n  <PauseRecording/>\n</Bxml>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test adding a single verb to the Bxml instance' do
+      instance.add_verbs(pause_recording)
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Bxml>\n  <PauseRecording/>\n</Bxml>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test adding multiple verbs to the Bxml instance' do
+      instance.add_verbs([pause_recording, pause_recording])
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Bxml>\n  <PauseRecording/>\n  <PauseRecording/>\n</Bxml>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
     it 'test the to_bxml method of the Bxml instance' do
       expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Bxml/>\n"
       expect(instance.to_bxml).to eq(expected)

data/spec/models/bxml/response_spec.rb

@@ -1,6 +1,7 @@
 # Unit tests for Bandwidth::Bxml::Response
 describe 'Bandwidth::Bxml::Response' do
   let(:instance) { Bandwidth::Bxml::Response.new }
+  let(:pause_recording) { Bandwidth::Bxml::PauseRecording.new }
 
   describe 'test an instance of Response' do
     it 'validates instance of Response' do
@@ -8,6 +9,30 @@ describe 'Bandwidth::Bxml::Response' do
       expect(instance).to be_a(Bandwidth::Bxml::Root)
     end
 
+    it 'test initializing with a single nested verb' do
+      instance = Bandwidth::Bxml::Response.new(pause_recording)
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n  <PauseRecording/>\n</Response>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test initializing with multiple nested verbs' do
+      instance = Bandwidth::Bxml::Response.new([pause_recording, pause_recording])
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n  <PauseRecording/>\n  <PauseRecording/>\n</Response>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test adding a single verb to the Response instance' do
+      instance.add_verbs(pause_recording)
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n  <PauseRecording/>\n</Response>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
+    it 'test adding multiple verbs to the Response instance' do
+      instance.add_verbs([pause_recording, pause_recording])
+      expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response>\n  <PauseRecording/>\n  <PauseRecording/>\n</Response>\n"
+      expect(instance.to_bxml).to eq(expected)
+    end
+
     it 'test the to_bxml method of the Response instance' do
       expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Response/>\n"
       expect(instance.to_bxml).to eq(expected)

data/spec/models/bxml/verbs/gather_spec.rb

@@ -42,7 +42,7 @@ describe 'Bandwidth::Bxml::Gather' do
   let (:speak_sentence) { Bandwidth::Bxml::SpeakSentence.new('<lang xml:lang="es-MX">Hola</lang>ruby speak sentence <emphasis>SSML test</emphasis>') }
 
   let(:instance) { Bandwidth::Bxml::Gather.new([], initial_attributes) }
-  let(:instance_nested) { Bandwidth::Bxml::Gather.new([play_audio], initial_attributes) }
+  let(:instance_nested) { Bandwidth::Bxml::Gather.new(play_audio, initial_attributes) }
 
   describe 'test an instance of Gather' do
     it 'validates instance of Gather' do
@@ -75,11 +75,11 @@ describe 'Bandwidth::Bxml::Gather' do
 
     it 'tests the add_verb method of the nested Gather instance' do
       expected_single = "\n<Gather gatherUrl=\"https://initial.com\" gatherMethod=\"POST\" gatherFallbackUrl=\"https://initial.com\" gatherFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" terminatingDigits=\"5\" maxDigits=\"5\" interDigitTimeout=\"5\" firstDigitTimeout=\"5\" repeatCount=\"5\">\n  <PlayAudio>https://audio.url/audio1.wav</PlayAudio>\n  <SpeakSentence><lang xml:lang=\"es-MX\">Hola</lang>ruby speak sentence <emphasis>SSML test</emphasis></SpeakSentence>\n</Gather>\n"
-      instance_nested.add_audio_verb(speak_sentence)
+      instance_nested.add_audio_verbs(speak_sentence)
       expect(instance_nested.to_bxml).to eq(expected_single)
 
       expected_multiple = "\n<Gather gatherUrl=\"https://initial.com\" gatherMethod=\"POST\" gatherFallbackUrl=\"https://initial.com\" gatherFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" terminatingDigits=\"5\" maxDigits=\"5\" interDigitTimeout=\"5\" firstDigitTimeout=\"5\" repeatCount=\"5\">\n  <PlayAudio>https://audio.url/audio1.wav</PlayAudio>\n  <SpeakSentence><lang xml:lang=\"es-MX\">Hola</lang>ruby speak sentence <emphasis>SSML test</emphasis></SpeakSentence>\n  <SpeakSentence><lang xml:lang=\"es-MX\">Hola</lang>ruby speak sentence <emphasis>SSML test</emphasis></SpeakSentence>\n  <PlayAudio>https://audio.url/audio1.wav</PlayAudio>\n</Gather>\n"
-      instance_nested.add_audio_verb([speak_sentence, play_audio])
+      instance_nested.add_audio_verbs([speak_sentence, play_audio])
       expect(instance_nested.to_bxml).to eq(expected_multiple)
     end
   end

data/spec/models/bxml/verbs/start_stream_spec.rb

@@ -28,7 +28,7 @@ describe 'Bandwidth::Bxml::StartStream' do
   let (:stream_param_2) { Bandwidth::Bxml::StreamParam.new({ name: 'stream_param_name_2', value: 'stream_param_value_2' }) }
 
   let(:instance) { Bandwidth::Bxml::StartStream.new([], initial_attributes) }
-  let(:instance_nested) { Bandwidth::Bxml::StartStream.new([stream_param_1], initial_attributes) }
+  let(:instance_nested) { Bandwidth::Bxml::StartStream.new(stream_param_1, initial_attributes) }
 
   describe 'test an instance of StartStream' do
     it 'validates instance of StartStream' do
@@ -61,11 +61,11 @@ describe 'Bandwidth::Bxml::StartStream' do
 
     it 'tests the add_stream_param method of the nested StartStream instance' do
       expected_single = "\n<StartStream name=\"initial_name\" tracks=\"inbound\" destination=\"https://initial.com\" streamEventUrl=\"https://initial.com\" streamEventMethod=\"POST\" username=\"initial_username\" password=\"initial_password\">\n  <StreamParam name=\"stream_param_name_1\" value=\"stream_param_value_1\"/>\n  <StreamParam name=\"stream_param_name_2\" value=\"stream_param_value_2\"/>\n</StartStream>\n"
-      instance_nested.add_stream_param(stream_param_2)
+      instance_nested.add_stream_params(stream_param_2)
       expect(instance_nested.to_bxml).to eq(expected_single)
 
       expected_multiple = "\n<StartStream name=\"initial_name\" tracks=\"inbound\" destination=\"https://initial.com\" streamEventUrl=\"https://initial.com\" streamEventMethod=\"POST\" username=\"initial_username\" password=\"initial_password\">\n  <StreamParam name=\"stream_param_name_1\" value=\"stream_param_value_1\"/>\n  <StreamParam name=\"stream_param_name_2\" value=\"stream_param_value_2\"/>\n  <StreamParam name=\"stream_param_name_2\" value=\"stream_param_value_2\"/>\n  <StreamParam name=\"stream_param_name_2\" value=\"stream_param_value_2\"/>\n</StartStream>\n"
-      instance_nested.add_stream_param([stream_param_2, stream_param_2])
+      instance_nested.add_stream_params([stream_param_2, stream_param_2])
       expect(instance_nested.to_bxml).to eq(expected_multiple)
     end
   end

data/spec/models/bxml/verbs/start_transcription_spec.rb

@@ -30,7 +30,7 @@ describe 'Bandwidth::Bxml::StartTranscription' do
   let (:custom_param_2) { Bandwidth::Bxml::CustomParam.new({ name: 'custom_param_name_2', value: 'custom_param_value_2' }) }
 
   let(:instance) { Bandwidth::Bxml::StartTranscription.new([], initial_attributes) }
-  let(:instance_nested) { Bandwidth::Bxml::StartTranscription.new([custom_param_1], initial_attributes) }
+  let(:instance_nested) { Bandwidth::Bxml::StartTranscription.new(custom_param_1, initial_attributes) }
 
   describe 'test an instance of StartTranscription' do
     it 'validates instance of StartTranscription' do
@@ -63,11 +63,11 @@ describe 'Bandwidth::Bxml::StartTranscription' do
 
     it 'tests the add_custom_param method of the nested StartTranscription instance' do
       expected_single = "\n<StartTranscription name=\"initial_name\" tracks=\"inbound\" transcriptionEventUrl=\"https://initial.com\" transcriptionEventMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" destination=\"https://initial.com\" stabilized=\"true\">\n  <CustomParam name=\"custom_param_name_1\" value=\"custom_param_value_1\"/>\n  <CustomParam name=\"custom_param_name_2\" value=\"custom_param_value_2\"/>\n</StartTranscription>\n"
-      instance_nested.add_custom_param(custom_param_2)
+      instance_nested.add_custom_params(custom_param_2)
       expect(instance_nested.to_bxml).to eq(expected_single)
 
       expected_multiple = "\n<StartTranscription name=\"initial_name\" tracks=\"inbound\" transcriptionEventUrl=\"https://initial.com\" transcriptionEventMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" destination=\"https://initial.com\" stabilized=\"true\">\n  <CustomParam name=\"custom_param_name_1\" value=\"custom_param_value_1\"/>\n  <CustomParam name=\"custom_param_name_2\" value=\"custom_param_value_2\"/>\n  <CustomParam name=\"custom_param_name_2\" value=\"custom_param_value_2\"/>\n  <CustomParam name=\"custom_param_name_2\" value=\"custom_param_value_2\"/>\n</StartTranscription>\n"
-      instance_nested.add_custom_param([custom_param_2, custom_param_2])
+      instance_nested.add_custom_params([custom_param_2, custom_param_2])
       expect(instance_nested.to_bxml).to eq(expected_multiple)
     end
   end

data/spec/models/bxml/verbs/transfer_spec.rb

@@ -3,6 +3,7 @@ describe 'Bandwidth::Bxml::Transfer' do
   let(:initial_attributes) {
     {
       transfer_caller_id: '+19195551234',
+      transfer_caller_display_name: 'initial_caller',
       call_timeout: 5,
       transfer_complete_url: 'https://initial.com',
       transfer_complete_method: 'POST',
@@ -21,6 +22,7 @@ describe 'Bandwidth::Bxml::Transfer' do
   let(:new_attributes) {
     {
       transfer_caller_id: '+19195554321',
+      transfer_caller_display_name: 'new_caller',
       call_timeout: 10,
       transfer_complete_url: 'https://new.com',
       transfer_complete_method: 'POST',
@@ -40,7 +42,7 @@ describe 'Bandwidth::Bxml::Transfer' do
   let(:sip_uri) { Bandwidth::Bxml::SipUri.new('sip:1-999-123-4567@voip-provider.example.net') }
 
   let(:instance) { Bandwidth::Bxml::Transfer.new([], initial_attributes) }
-  let(:instance_nested) { Bandwidth::Bxml::Transfer.new([phone_number], initial_attributes) }
+  let(:instance_nested) { Bandwidth::Bxml::Transfer.new(phone_number, initial_attributes) }
 
   describe 'test an instance of Transfer' do
     it 'validates instance of Transfer' do
@@ -49,13 +51,13 @@ describe 'Bandwidth::Bxml::Transfer' do
     end
 
     it 'tests the to_bxml method of the Transfer instance' do
-      expected = "\n<Transfer transferCallerId=\"+19195551234\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\"/>\n"
+      expected = "\n<Transfer transferCallerId=\"+19195551234\" transferCallerDisplayName=\"initial_caller\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\"/>\n"
       expect(instance.to_bxml).to eq(expected)
     end
 
     it 'tests the set_attributes method of the Transfer instance' do
       instance.set_attributes(new_attributes)
-      expected = "\n<Transfer transferCallerId=\"+19195554321\" callTimeout=\"10\" transferCompleteUrl=\"https://new.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://new.com\" transferCompleteFallbackMethod=\"POST\" username=\"new_username\" password=\"new_password\" fallbackUsername=\"new_fallback_username\" fallbackPassword=\"new_fallback_password\" tag=\"new_tag\" diversionTreatment=\"stack\" diversionReason=\"no-answer\"/>\n"
+      expected = "\n<Transfer transferCallerId=\"+19195554321\" transferCallerDisplayName=\"new_caller\" callTimeout=\"10\" transferCompleteUrl=\"https://new.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://new.com\" transferCompleteFallbackMethod=\"POST\" username=\"new_username\" password=\"new_password\" fallbackUsername=\"new_fallback_username\" fallbackPassword=\"new_fallback_password\" tag=\"new_tag\" diversionTreatment=\"stack\" diversionReason=\"no-answer\"/>\n"
       expect(instance.to_bxml).to eq(expected)
     end
   end
@@ -67,17 +69,17 @@ describe 'Bandwidth::Bxml::Transfer' do
     end
 
     it 'tests the to_bxml method of the nested Transfer instance' do
-      expected = "\n<Transfer transferCallerId=\"+19195551234\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n</Transfer>\n"
+      expected = "\n<Transfer transferCallerId=\"+19195551234\" transferCallerDisplayName=\"initial_caller\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n</Transfer>\n"
       expect(instance_nested.to_bxml).to eq(expected)
     end
 
     it 'tests the add_verb method of the nested Transfer instance' do
-      expected_single = "\n<Transfer transferCallerId=\"+19195551234\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n</Transfer>\n"
-      instance_nested.add_transfer_recipient(sip_uri)
+      expected_single = "\n<Transfer transferCallerId=\"+19195551234\" transferCallerDisplayName=\"initial_caller\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n</Transfer>\n"
+      instance_nested.add_transfer_recipients(sip_uri)
       expect(instance_nested.to_bxml).to eq(expected_single)
 
-      expected_multiple = "\n<Transfer transferCallerId=\"+19195551234\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n  <PhoneNumber>+19195551234</PhoneNumber>\n</Transfer>\n"
-      instance_nested.add_transfer_recipient([sip_uri, phone_number])
+      expected_multiple = "\n<Transfer transferCallerId=\"+19195551234\" transferCallerDisplayName=\"initial_caller\" callTimeout=\"5\" transferCompleteUrl=\"https://initial.com\" transferCompleteMethod=\"POST\" transferCompleteFallbackUrl=\"https://initial.com\" transferCompleteFallbackMethod=\"POST\" username=\"initial_username\" password=\"initial_password\" fallbackUsername=\"initial_fallback_username\" fallbackPassword=\"initial_fallback_password\" tag=\"initial_tag\" diversionTreatment=\"propagate\" diversionReason=\"user-busy\">\n  <PhoneNumber>+19195551234</PhoneNumber>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n  <SipUri>sip:1-999-123-4567@voip-provider.example.net</SipUri>\n  <PhoneNumber>+19195551234</PhoneNumber>\n</Transfer>\n"
+      instance_nested.add_transfer_recipients([sip_uri, phone_number])
       expect(instance_nested.to_bxml).to eq(expected_multiple)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 11.1.1
+  version: 11.3.0
 platform: ruby
 authors:
 - Bandwidth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -461,61 +461,61 @@ specification_version: 4
 summary: Bandwidth Ruby SDK
 test_files:
 - spec/api/recordings_api_spec.rb
-- spec/api/phone_number_lookup_api_spec.rb
-- spec/api/messages_api_spec.rb
-- spec/api/statistics_api_spec.rb
-- spec/api/calls_api_spec.rb
-- spec/api/media_api_spec.rb
 - spec/api/mfa_api_spec.rb
+- spec/api/calls_api_spec.rb
 - spec/api/conferences_api_spec.rb
+- spec/api/statistics_api_spec.rb
+- spec/api/media_api_spec.rb
+- spec/api/phone_number_lookup_api_spec.rb
+- spec/api/messages_api_spec.rb
 - spec/api_client_spec.rb
 - spec/api_error_spec.rb
 - spec/call_utils.rb
 - spec/configuration_spec.rb
 - spec/fixtures/ruby_cat.jpeg
 - spec/integration/mfa_api_integration_spec.rb
-- spec/integration/media_api_integration_spec.rb
-- spec/integration/messages_api_integration_spec.rb
 - spec/integration/calls_api_integration_spec.rb
+- spec/integration/recordings_api_integration_spec.rb
 - spec/integration/conferences_api_integration_spec.rb
+- spec/integration/messages_api_integration_spec.rb
 - spec/integration/phone_number_lookup_api_integration_spec.rb
-- spec/integration/recordings_api_integration_spec.rb
+- spec/integration/media_api_integration_spec.rb
 - spec/integration/statistics_api_integration_spec.rb
 - spec/models/deferred_result_spec.rb
 - spec/models/verify_code_request_spec.rb
 - spec/models/call_state_enum_spec.rb
 - spec/models/call_state_spec.rb
-- spec/models/message_spec.rb
+- spec/models/bxml/bxml_spec.rb
 - spec/models/bxml/response_spec.rb
-- spec/models/bxml/verbs/play_audio_spec.rb
-- spec/models/bxml/verbs/redirect_spec.rb
-- spec/models/bxml/verbs/forward_spec.rb
-- spec/models/bxml/verbs/bridge_spec.rb
-- spec/models/bxml/verbs/pause_recording_spec.rb
-- spec/models/bxml/verbs/stop_gather_spec.rb
-- spec/models/bxml/verbs/conference_spec.rb
-- spec/models/bxml/verbs/sip_uri_spec.rb
-- spec/models/bxml/verbs/resume_recording_spec.rb
-- spec/models/bxml/verbs/tag_spec.rb
+- spec/models/bxml/verb_spec.rb
+- spec/models/bxml/verbs/stop_stream_spec.rb
+- spec/models/bxml/verbs/start_recording_spec.rb
+- spec/models/bxml/verbs/send_dtmf_spec.rb
 - spec/models/bxml/verbs/speak_sentence_spec.rb
+- spec/models/bxml/verbs/custom_param_spec.rb
 - spec/models/bxml/verbs/start_stream_spec.rb
-- spec/models/bxml/verbs/transfer_spec.rb
 - spec/models/bxml/verbs/start_transcription_spec.rb
-- spec/models/bxml/verbs/hangup_spec.rb
+- spec/models/bxml/verbs/pause_recording_spec.rb
+- spec/models/bxml/verbs/phone_number_spec.rb
+- spec/models/bxml/verbs/stream_param_spec.rb
+- spec/models/bxml/verbs/bridge_spec.rb
 - spec/models/bxml/verbs/record_spec.rb
-- spec/models/bxml/verbs/stop_stream_spec.rb
+- spec/models/bxml/verbs/pause_spec.rb
+- spec/models/bxml/verbs/play_audio_spec.rb
+- spec/models/bxml/verbs/stop_recording_spec.rb
+- spec/models/bxml/verbs/forward_spec.rb
 - spec/models/bxml/verbs/stop_transcription_spec.rb
-- spec/models/bxml/verbs/send_dtmf_spec.rb
-- spec/models/bxml/verbs/custom_param_spec.rb
-- spec/models/bxml/verbs/gather_spec.rb
 - spec/models/bxml/verbs/ring_spec.rb
-- spec/models/bxml/verbs/stop_recording_spec.rb
+- spec/models/bxml/verbs/tag_spec.rb
+- spec/models/bxml/verbs/sip_uri_spec.rb
+- spec/models/bxml/verbs/redirect_spec.rb
+- spec/models/bxml/verbs/conference_spec.rb
+- spec/models/bxml/verbs/stop_gather_spec.rb
+- spec/models/bxml/verbs/gather_spec.rb
+- spec/models/bxml/verbs/resume_recording_spec.rb
 - spec/models/bxml/verbs/start_gather_spec.rb
-- spec/models/bxml/verbs/stream_param_spec.rb
-- spec/models/bxml/verbs/start_recording_spec.rb
-- spec/models/bxml/verbs/phone_number_spec.rb
-- spec/models/bxml/verbs/pause_spec.rb
+- spec/models/bxml/verbs/transfer_spec.rb
+- spec/models/bxml/verbs/hangup_spec.rb
 - spec/models/bxml/nestable_verb_spec.rb
-- spec/models/bxml/bxml_spec.rb
-- spec/models/bxml/verb_spec.rb
+- spec/models/message_spec.rb
 - spec/spec_helper.rb