VAPI-3162-REFER by atelegu · Pull Request #211 · Bandwidth/ruby-sdk

atelegu · 2026-06-19T07:36:25Z

Adds the <Refer> BXML verb.

lib/bandwidth-sdk/models/bxml/verbs/refer.rb: new Bxml::Refer verb, takes sip_uri untyped/shared - same pattern Transfer already uses with Bxml::SipUri, no separate Refer-only SipUri type and no cross-field validation restricting which SipUri attributes are legal per verb (matches csharp-sdk#201, which dropped this as over-engineering).
Spec added at spec/unit/models/bxml/verbs/refer_spec.rb.
ReferCompleteCallback model is out of scope here - lands separately once VAPI-3440 merges. Deleted an orphaned Bandwidth::SipUri REST/JSON model (lib/bandwidth-sdk/models/sip_uri.rb) and its bandwidth.yml schema that had no remaining consumer once that callback work was descoped.

Tests: bundle exec rspec spec/unit/models/bxml/verbs/refer_spec.rb passes; no new failures in spec/unit.

bwappsec · 2026-06-19T07:36:44Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

stampercasey

Review from Claude Code — see inline comments for individual findings. Two blockers; the callback model and enums are solid.

…REFER

The referComplete callback model will land later via a separate api-specs-driven PR once VAPI-3440 merges. This also removes the top-level Bandwidth::Refer model (and its ReferCompleteMethodEnum/ ReferCallStatusEnum helpers), which duplicated Bxml::Refer at the openapi-generator layer and had no equivalent for any other BXML verb (e.g. Transfer has no top-level Bandwidth::Transfer model). Adds a spec for Bxml::Refer covering construction with a bare SipUri and correct BXML rendering.

Bandwidth::SipUri (JSON model layer) and its bandwidth.yml schema were left over from the deleted top-level Refer/ReferCompleteCallback models and had no remaining consumer. .openapi-generator/FILES still listed refer.rb, refer_call_status_enum.rb, refer_complete_callback.rb, refer_complete_method_enum.rb, and their specs after those files were already deleted.

…REFER

ckoegel · 2026-08-03T17:13:07Z

this file is autogenerated, it shouldn't have any changes

ckoegel · 2026-08-03T17:22:04Z

+        super('Refer', nil, [sip_uri], attributes)
+        @attribute_map = {


Suggested change

super('Refer', nil, [sip_uri], attributes)

@attribute_map = {

super('Refer', nil, [sip_uri], attributes)

@attribute_map = {

ckoegel · 2026-08-03T17:22:55Z

+          refer_complete_url: 'referCompleteUrl',
+          refer_complete_method: 'referCompleteMethod',
+          tag: 'tag'


can we get annotations for these, we typically copy the description from the docs page and define, their optionality and type, see the other verbs for how it looks

ckoegel · 2026-08-03T17:26:37Z

+    end
+  end
+
+  describe 'test an instance of Refer with a bare SipUri' do


this test is unnecessary

ckoegel · 2026-08-03T17:26:58Z

+      end
+    end
+  end
+end


Suggested change

end

end

ckoegel · 2026-08-03T17:51:53Z

+      # Initializer
+      # @param sip_uri [SipUri] The SIP URI to REFER the call to. Uses the same SipUri verb shared with Transfer.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(sip_uri, attributes = {})


Suggested change

def initialize(sip_uri, attributes = {})

def initialize(sip_uri = [], attributes = {})

ckoegel · 2026-08-03T17:52:41Z

+      # @param sip_uri [SipUri] The SIP URI to REFER the call to. Uses the same SipUri verb shared with Transfer.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(sip_uri, attributes = {})
+        super('Refer', nil, [sip_uri], attributes)


Suggested change

super('Refer', nil, [sip_uri], attributes)

super('Refer', nil, sip_uri, attributes)

this is casted to an array in the super constructor, no need to here

ckoegel · 2026-08-03T17:58:08Z

+          refer_complete_method: 'referCompleteMethod',
+          tag: 'tag'
+        }
+      end


Suggested change

end

end

# <description>

# @param sip_uri [SipUri] <description>

def set_sip_uri(sip_uri)

# set @nested_verbs to array of sip_uri

end

other nestable verbs have functions to update their nested verbs, we should add one here. It doesn't need to match the others in the way they append to the list, it can probably just set @nested_verbs to an array of supplied SipUri.

ckoegel · 2026-08-03T17:59:49Z

+
+  let(:sip_uri) { Bandwidth::Bxml::SipUri.new('sip:alice@atlanta.example.com') }
+
+  let(:instance) { Bandwidth::Bxml::Refer.new(sip_uri, initial_attributes) }


with the updates to how sip_uri is handled in the verb, we can make 2 instances of this and test similar to how we do for Gather with an instance and an instance_nested

…tions Default sip_uri to an empty array and drop the array-wrapping in super() (parent already casts), add YARD annotations for each attribute matching Transfer's style, add a set_sip_uri setter, and restructure the spec to use instance/instance_nested like Gather's spec. Also fixed a trailing newline drift in .openapi-generator/FILES.

VAPI-3162-REFER

3961094

atelegu requested review from a team as code owners June 19, 2026 07:36

Copilot AI mentioned this pull request Jun 19, 2026

VAPI-3162: Add ReferCompleteCallback and ReferCallStatusEnum (fixes spec parse error in #211) #212

Closed

atelegu added 3 commits June 19, 2026 14:10

VAPI-3162-REFER

63d9927

VAPI-3162-REFER

06f9afb

VAPI-3162-REFER

75fc16f

stampercasey reviewed Jun 19, 2026

View reviewed changes

atelegu and others added 9 commits June 19, 2026 19:46

VAPI-3162-REFER

51c8b79

VAPI-3162-REFER

9d29700

VAPI-3162-REFER

b54f869

VAPI-3162-REFER

539a192

VAPI-3162-REFER

d33a62a

Merge branch 'main' into VAPI-3162-REFER

be3de02

VAPI-3162-REFER

c367380

Merge remote-tracking branch 'origin/VAPI-3162-REFER' into VAPI-3162-…

cbcfb9c

…REFER

VAPI-3162-REFER

9630fe1

atelegu requested a review from stampercasey June 22, 2026 09:21

stampercasey previously approved these changes Jun 22, 2026

View reviewed changes

stampercasey dismissed their stale review via d4618a0 July 30, 2026 19:32

stampercasey added 3 commits July 30, 2026 15:40

Merge branch 'main' into VAPI-3162-REFER

09845f7

Merge remote-tracking branch 'origin/VAPI-3162-REFER' into VAPI-3162-…

f9e1687

…REFER

ckoegel reviewed Aug 3, 2026

View reviewed changes

stampercasey requested a review from ckoegel August 4, 2026 18:47

		super('Refer', nil, [sip_uri], attributes)
		@attribute_map = {

+                    end
+                  end
+                end
+              end

                
                    No newline at end of file

	def initialize(sip_uri, attributes = {})
	def initialize(sip_uri = [], attributes = {})

	super('Refer', nil, [sip_uri], attributes)
	super('Refer', nil, sip_uri, attributes)

-      end
+      end
+      # <description>
+      # @param sip_uri [SipUri] <description>
+      def set_sip_uri(sip_uri)
+        # set @nested_verbs to array of sip_uri
+      end


		let(:sip_uri) { Bandwidth::Bxml::SipUri.new('sip:alice@atlanta.example.com') }

		let(:instance) { Bandwidth::Bxml::Refer.new(sip_uri, initial_attributes) }

Uh oh!

Conversation

atelegu commented Jun 19, 2026 • edited by atlassian Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bwappsec commented Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

stampercasey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

atelegu commented Jun 19, 2026 •

edited by atlassian Bot

Loading

bwappsec commented Jun 19, 2026 •

edited

Loading