bandwidth-sdk 3.12.1 → 5.0.0

data/lib/bandwidth/voice_lib/voice/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.1'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

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

@@ -10,71 +10,126 @@ module Bandwidth
     # @return [String]
     attr_accessor :from
 
-    # Format is E164
+    # Format is E164 or SIP URI
     # @return [String]
     attr_accessor :to
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
+    # @return [String]
+    attr_accessor :uui
+
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [Float]
     attr_accessor :call_timeout
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [Float]
     attr_accessor :callback_timeout
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :answer_url
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :answer_fallback_url
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :username
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :password
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :fallback_username
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :fallback_password
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [AnswerMethodEnum]
     attr_accessor :answer_method
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [AnswerFallbackMethodEnum]
     attr_accessor :answer_fallback_method
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :disconnect_url
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [DisconnectMethodEnum]
     attr_accessor :disconnect_method
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :tag
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :application_id
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :obfuscated_to
 
-    # Format is E164
+    # When calling a SIP URI, this will be sent as the 'User-To-User' header
+    # within the initial INVITE. An 'encoding' parameter must be specified as
+    # described in https://tools.ietf.org/html/rfc7433. This header cannot
+    # exceed 256 characters, including the encoding parameter.
     # @return [String]
     attr_accessor :obfuscated_from
 
@@ -83,6 +138,7 @@ module Bandwidth
       @_hash = {} if @_hash.nil?
       @_hash['from'] = 'from'
       @_hash['to'] = 'to'
+      @_hash['uui'] = 'uui'
       @_hash['call_timeout'] = 'callTimeout'
       @_hash['callback_timeout'] = 'callbackTimeout'
       @_hash['answer_url'] = 'answerUrl'
@@ -106,6 +162,7 @@ module Bandwidth
                    to = nil,
                    answer_url = nil,
                    application_id = nil,
+                   uui = nil,
                    call_timeout = nil,
                    callback_timeout = nil,
                    answer_fallback_url = nil,
@@ -122,6 +179,7 @@ module Bandwidth
                    obfuscated_from = nil)
       @from = from
       @to = to
+      @uui = uui
       @call_timeout = call_timeout
       @callback_timeout = callback_timeout
       @answer_url = answer_url
@@ -149,6 +207,7 @@ module Bandwidth
       to = hash['to']
       answer_url = hash['answerUrl']
       application_id = hash['applicationId']
+      uui = hash['uui']
       call_timeout = hash['callTimeout']
       callback_timeout = hash['callbackTimeout']
       answer_fallback_url = hash['answerFallbackUrl']
@@ -169,6 +228,7 @@ module Bandwidth
                                to,
                                answer_url,
                                application_id,
+                               uui,
                                call_timeout,
                                callback_timeout,
                                answer_fallback_url,

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

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # CallEngineModifyConferenceRequest Model.
-  class CallEngineModifyConferenceRequest < BaseModel
+  # ApiModifyConferenceRequest Model.
+  class ApiModifyConferenceRequest < BaseModel
     # TODO: Write general description for this method
     # @return [StatusEnum]
     attr_accessor :status
@@ -57,8 +57,8 @@ module Bandwidth
       @_hash
     end
 
-    def initialize(redirect_url = nil,
-                   status = nil,
+    def initialize(status = nil,
+                   redirect_url = nil,
                    redirect_fallback_url = nil,
                    redirect_method = nil,
                    redirect_fallback_method = nil,
@@ -82,8 +82,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      redirect_url = hash['redirectUrl']
       status = hash['status']
+      redirect_url = hash['redirectUrl']
       redirect_fallback_url = hash['redirectFallbackUrl']
       redirect_method = hash['redirectMethod']
       redirect_fallback_method = hash['redirectFallbackMethod']
@@ -93,15 +93,15 @@ module Bandwidth
       fallback_password = hash['fallbackPassword']
 
       # Create object from extracted values.
-      CallEngineModifyConferenceRequest.new(redirect_url,
-                                            status,
-                                            redirect_fallback_url,
-                                            redirect_method,
-                                            redirect_fallback_method,
-                                            username,
-                                            password,
-                                            fallback_username,
-                                            fallback_password)
+      ApiModifyConferenceRequest.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/state_enum.rb

@@ -8,13 +8,13 @@ module Bandwidth
   class StateEnum
     STATE_ENUM = [
       # TODO: Write general description for DISCONNECTED
-      DISCONNECTED = 'disconnected'.freeze,
+      DISCONNECTED = 'DISCONNECTED'.freeze,
 
       # TODO: Write general description for ANSWERED
-      ANSWERED = 'answered'.freeze,
+      ANSWERED = 'ANSWERED'.freeze,
 
       # TODO: Write general description for INITIATED
-      INITIATED = 'initiated'.freeze
+      INITIATED = 'INITIATED'.freeze
     ].freeze
   end
 end

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

@@ -24,7 +24,7 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/participants'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -87,8 +87,8 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/participants/{participantId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -148,8 +148,8 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/participants/{participantId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -202,7 +202,7 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -264,8 +264,8 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -325,8 +325,8 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -377,8 +377,8 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -445,9 +445,9 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -509,9 +509,9 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -564,9 +564,9 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -634,9 +634,9 @@ module WebRtc
       _query_builder << '/accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true },
-        'participantId' => { 'value' => participant_id, 'encode' => true },
-        'sessionId' => { 'value' => session_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'participantId' => { 'value' => participant_id, 'encode' => false },
+        'sessionId' => { 'value' => session_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 

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

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.1'
+        'user-agent' => 'ruby-sdk'
       }
     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/test_helper.rb

@@ -0,0 +1,94 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'tempfile'
+require 'open-uri'
+
+class TestHelper
+
+  @cache = Hash.new
+
+  # Class method to compare the received headers with the expected headers.
+  # @param [Hash] A hash of expected headers (keys in lower case).
+  # @param [Hash] A hash of received headers.
+  # @param [Boolean, optional] A flag which determines if we allow extra headers.
+  def self.match_headers(expected_headers,
+                         received_headers,
+                         allow_extra: true)
+    return false if ((received_headers.length < expected_headers.length) ||
+                    ((allow_extra == false) && (received_headers.length > expected_headers.length)))
+
+    received_headers = Hash[received_headers.map{|k, v| [k.to_s.downcase, v]}]
+    expected_headers.each do |e_key, e_value|
+      return false unless received_headers.key?(e_key)
+      return false if ((e_value != nil) &&
+                       (e_value != received_headers[e_key]))
+    end
+
+    return true
+  end
+
+  # Class method to compare the received body with the expected body.
+  # @param [Dynamic] The expected body.
+  # @param [Dynamic] The received body.
+  # @param [Boolean, optional] A flag which determines if we check values in dictionaries.
+  # @param [Boolean, optional] A flag which determines if we check the order of array elements.
+  # @param [Boolean, optional] A flag which determines if we check the count of array elements.
+  def self.match_body(expected_body,
+                      received_body,
+                      check_values: false,
+                      check_order: false,
+                      check_count: false)
+    if expected_body.instance_of? Hash
+      return false unless received_body.instance_of? Hash
+      for key in expected_body.keys           
+        return false unless received_body.keys.include? key
+        if check_values or expected_body[key].instance_of? Hash
+          return false unless TestHelper.match_body(expected_body[key], 
+                                                    received_body[key], 
+                                                    check_values: check_values, 
+                                                    check_order: check_order, 
+                                                    check_count: check_count)
+        end
+      end
+    elsif expected_body.instance_of? Array
+      return False unless received_body.instance_of? Array
+      if check_count == true && (expected_body.length != received_body.length)
+        return false
+      else
+        previous_matches = Array.new
+        expected_body.each.with_index do |expected_element, i|
+          matches = (received_body.map.with_index do |received_element, j|
+                      j if TestHelper.match_body(expected_element, 
+                                                 received_element, 
+                                                 check_values: check_values, 
+                                                 check_order: check_order, 
+                                                 check_count: check_count)
+                    end).compact
+          return false if matches.length == 0
+          if check_order == true
+            return false if (i != 0 && matches.map{|x| previous_matches.map{|y| y > x}.all?}.all?)
+            previous_matches = matches
+          end
+        end
+      end
+    elsif expected_body != received_body
+      return false
+    end
+    return true
+  end  
+  
+  # Class method which takes a URL, downloads the file (if not already downloaded 
+  # for this test session) and returns the path of the file.
+  # @param [String] The URL of the required file.
+  def self.get_file(url)
+    unless @cache.keys.include? url  
+      @cache[url] = Tempfile.new('APIMatic')
+      @cache[url].binmode
+      @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
+    end
+    return @cache[url].path
+  end
+end