bandwidth-sdk 2.1.1 → 6.1.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' => 'APIMATIC 2.0'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

data/lib/bandwidth/voice_lib/voice/exceptions/{error_response_exception.rb → api_error_response_exception.rb}

@@ -4,10 +4,10 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # ErrorResponse class.
-  class ErrorResponseException < APIException
+  # ApiErrorResponse class.
+  class ApiErrorResponseException < APIException
     # TODO: Write general description for this method
-    # @return [TypeEnum]
+    # @return [String]
     attr_accessor :type
 
     # TODO: Write general description for this method

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

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # AnswerFallbackMethod.
+  class AnswerFallbackMethodEnum
+    ANSWER_FALLBACK_METHOD_ENUM = [
+      # TODO: Write general description for POST
+      POST = 'POST'.freeze,
+
+      # TODO: Write general description for GET
+      GET = 'GET'.freeze
+    ].freeze
+  end
+end

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

@@ -7,6 +7,10 @@ require 'date'
 module Bandwidth
   # ApiCallResponse Model.
   class ApiCallResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :call_id
@@ -35,6 +39,10 @@ module Bandwidth
     # @return [Float]
     attr_accessor :call_timeout
 
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :callback_timeout
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :answer_url
@@ -43,6 +51,14 @@ module Bandwidth
     # @return [AnswerMethodEnum]
     attr_accessor :answer_method
 
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :answer_fallback_url
+
+    # TODO: Write general description for this method
+    # @return [AnswerFallbackMethodEnum]
+    attr_accessor :answer_fallback_method
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :disconnect_url
@@ -59,6 +75,14 @@ module Bandwidth
     # @return [String]
     attr_accessor :password
 
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fallback_username
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fallback_password
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :tag
@@ -66,6 +90,7 @@ module Bandwidth
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
       @_hash['call_id'] = 'callId'
       @_hash['application_id'] = 'applicationId'
       @_hash['to'] = 'to'
@@ -73,17 +98,23 @@ module Bandwidth
       @_hash['start_time'] = 'startTime'
       @_hash['call_url'] = 'callUrl'
       @_hash['call_timeout'] = 'callTimeout'
+      @_hash['callback_timeout'] = 'callbackTimeout'
       @_hash['answer_url'] = 'answerUrl'
       @_hash['answer_method'] = 'answerMethod'
+      @_hash['answer_fallback_url'] = 'answerFallbackUrl'
+      @_hash['answer_fallback_method'] = 'answerFallbackMethod'
       @_hash['disconnect_url'] = 'disconnectUrl'
       @_hash['disconnect_method'] = 'disconnectMethod'
       @_hash['username'] = 'username'
       @_hash['password'] = 'password'
+      @_hash['fallback_username'] = 'fallbackUsername'
+      @_hash['fallback_password'] = 'fallbackPassword'
       @_hash['tag'] = 'tag'
       @_hash
     end
 
-    def initialize(call_id = nil,
+    def initialize(account_id = nil,
+                   call_id = nil,
                    application_id = nil,
                    to = nil,
                    from = nil,
@@ -93,10 +124,16 @@ module Bandwidth
                    disconnect_method = nil,
                    start_time = nil,
                    call_timeout = nil,
+                   callback_timeout = nil,
+                   answer_fallback_url = nil,
+                   answer_fallback_method = nil,
                    disconnect_url = nil,
                    username = nil,
                    password = nil,
+                   fallback_username = nil,
+                   fallback_password = nil,
                    tag = nil)
+      @account_id = account_id
       @call_id = call_id
       @application_id = application_id
       @to = to
@@ -104,12 +141,17 @@ module Bandwidth
       @start_time = start_time
       @call_url = call_url
       @call_timeout = call_timeout
+      @callback_timeout = callback_timeout
       @answer_url = answer_url
       @answer_method = answer_method
+      @answer_fallback_url = answer_fallback_url
+      @answer_fallback_method = answer_fallback_method
       @disconnect_url = disconnect_url
       @disconnect_method = disconnect_method
       @username = username
       @password = password
+      @fallback_username = fallback_username
+      @fallback_password = fallback_password
       @tag = tag
     end
 
@@ -118,6 +160,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
+      account_id = hash['accountId']
       call_id = hash['callId']
       application_id = hash['applicationId']
       to = hash['to']
@@ -128,13 +171,19 @@ module Bandwidth
       disconnect_method = hash['disconnectMethod']
       start_time = APIHelper.rfc3339(hash['startTime']) if hash['startTime']
       call_timeout = hash['callTimeout']
+      callback_timeout = hash['callbackTimeout']
+      answer_fallback_url = hash['answerFallbackUrl']
+      answer_fallback_method = hash['answerFallbackMethod']
       disconnect_url = hash['disconnectUrl']
       username = hash['username']
       password = hash['password']
+      fallback_username = hash['fallbackUsername']
+      fallback_password = hash['fallbackPassword']
       tag = hash['tag']
 
       # Create object from extracted values.
-      ApiCallResponse.new(call_id,
+      ApiCallResponse.new(account_id,
+                          call_id,
                           application_id,
                           to,
                           from,
@@ -144,9 +193,14 @@ module Bandwidth
                           disconnect_method,
                           start_time,
                           call_timeout,
+                          callback_timeout,
+                          answer_fallback_url,
+                          answer_fallback_method,
                           disconnect_url,
                           username,
                           password,
+                          fallback_username,
+                          fallback_password,
                           tag)
     end
   end

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

@@ -0,0 +1,164 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # ApiCallStateResponse Model.
+  class ApiCallStateResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :call_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :parent_call_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :application_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :to
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :from
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :direction
+
+    # TODO: Write general description for this method
+    # @return [StateEnum]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :answer_time
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # TODO: Write general description for this method
+    # @return [DisconnectCauseEnum]
+    attr_accessor :disconnect_cause
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_message
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :last_update
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['call_id'] = 'callId'
+      @_hash['parent_call_id'] = 'parentCallId'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['account_id'] = 'accountId'
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['direction'] = 'direction'
+      @_hash['state'] = 'state'
+      @_hash['start_time'] = 'startTime'
+      @_hash['answer_time'] = 'answerTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['disconnect_cause'] = 'disconnectCause'
+      @_hash['error_message'] = 'errorMessage'
+      @_hash['error_id'] = 'errorId'
+      @_hash['last_update'] = 'lastUpdate'
+      @_hash
+    end
+
+    def initialize(call_id = nil,
+                   parent_call_id = nil,
+                   application_id = nil,
+                   account_id = nil,
+                   to = nil,
+                   from = nil,
+                   direction = nil,
+                   state = nil,
+                   start_time = nil,
+                   answer_time = nil,
+                   end_time = nil,
+                   disconnect_cause = nil,
+                   error_message = nil,
+                   error_id = nil,
+                   last_update = nil)
+      @call_id = call_id
+      @parent_call_id = parent_call_id
+      @application_id = application_id
+      @account_id = account_id
+      @to = to
+      @from = from
+      @direction = direction
+      @state = state
+      @start_time = start_time
+      @answer_time = answer_time
+      @end_time = end_time
+      @disconnect_cause = disconnect_cause
+      @error_message = error_message
+      @error_id = error_id
+      @last_update = last_update
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      call_id = hash['callId']
+      parent_call_id = hash['parentCallId']
+      application_id = hash['applicationId']
+      account_id = hash['accountId']
+      to = hash['to']
+      from = hash['from']
+      direction = hash['direction']
+      state = hash['state']
+      start_time = APIHelper.rfc3339(hash['startTime']) if hash['startTime']
+      answer_time = APIHelper.rfc3339(hash['answerTime']) if
+        hash['answerTime']
+      end_time = APIHelper.rfc3339(hash['endTime']) if hash['endTime']
+      disconnect_cause = hash['disconnectCause']
+      error_message = hash['errorMessage']
+      error_id = hash['errorId']
+      last_update = APIHelper.rfc3339(hash['lastUpdate']) if
+        hash['lastUpdate']
+
+      # Create object from extracted values.
+      ApiCallStateResponse.new(call_id,
+                               parent_call_id,
+                               application_id,
+                               account_id,
+                               to,
+                               from,
+                               direction,
+                               state,
+                               start_time,
+                               answer_time,
+                               end_time,
+                               disconnect_cause,
+                               error_message,
+                               error_id,
+                               last_update)
+    end
+  end
+end

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

@@ -10,60 +10,151 @@ 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
 
+    # 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
+
+    # 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
+
     # A mapping from model property names to API property names.
     def self.names
       @_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'
+      @_hash['answer_fallback_url'] = 'answerFallbackUrl'
       @_hash['username'] = 'username'
       @_hash['password'] = 'password'
+      @_hash['fallback_username'] = 'fallbackUsername'
+      @_hash['fallback_password'] = 'fallbackPassword'
       @_hash['answer_method'] = 'answerMethod'
+      @_hash['answer_fallback_method'] = 'answerFallbackMethod'
       @_hash['disconnect_url'] = 'disconnectUrl'
       @_hash['disconnect_method'] = 'disconnectMethod'
       @_hash['tag'] = 'tag'
       @_hash['application_id'] = 'applicationId'
+      @_hash['obfuscated_to'] = 'obfuscatedTo'
+      @_hash['obfuscated_from'] = 'obfuscatedFrom'
       @_hash
     end
 
@@ -71,24 +162,40 @@ module Bandwidth
                    to = nil,
                    answer_url = nil,
                    application_id = nil,
+                   uui = nil,
                    call_timeout = nil,
+                   callback_timeout = nil,
+                   answer_fallback_url = nil,
                    username = nil,
                    password = nil,
+                   fallback_username = nil,
+                   fallback_password = nil,
                    answer_method = nil,
+                   answer_fallback_method = nil,
                    disconnect_url = nil,
                    disconnect_method = nil,
-                   tag = nil)
+                   tag = nil,
+                   obfuscated_to = nil,
+                   obfuscated_from = nil)
       @from = from
       @to = to
+      @uui = uui
       @call_timeout = call_timeout
+      @callback_timeout = callback_timeout
       @answer_url = answer_url
+      @answer_fallback_url = answer_fallback_url
       @username = username
       @password = password
+      @fallback_username = fallback_username
+      @fallback_password = fallback_password
       @answer_method = answer_method
+      @answer_fallback_method = answer_fallback_method
       @disconnect_url = disconnect_url
       @disconnect_method = disconnect_method
       @tag = tag
       @application_id = application_id
+      @obfuscated_to = obfuscated_to
+      @obfuscated_from = obfuscated_from
     end
 
     # Creates an instance of the object from a hash.
@@ -100,26 +207,42 @@ 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']
       username = hash['username']
       password = hash['password']
+      fallback_username = hash['fallbackUsername']
+      fallback_password = hash['fallbackPassword']
       answer_method = hash['answerMethod']
+      answer_fallback_method = hash['answerFallbackMethod']
       disconnect_url = hash['disconnectUrl']
       disconnect_method = hash['disconnectMethod']
       tag = hash['tag']
+      obfuscated_to = hash['obfuscatedTo']
+      obfuscated_from = hash['obfuscatedFrom']
 
       # Create object from extracted values.
       ApiCreateCallRequest.new(from,
                                to,
                                answer_url,
                                application_id,
+                               uui,
                                call_timeout,
+                               callback_timeout,
+                               answer_fallback_url,
                                username,
                                password,
+                               fallback_username,
+                               fallback_password,
                                answer_method,
+                               answer_fallback_method,
                                disconnect_url,
                                disconnect_method,
-                               tag)
+                               tag,
+                               obfuscated_to,
+                               obfuscated_from)
     end
   end
 end