bandwidth-sdk 6.2.0 → 9.0.0

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

@@ -0,0 +1,256 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # CreateCallResponse Model.
+  class CreateCallResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :application_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 [DateTime]
+    attr_accessor :start_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :call_url
+
+    # TODO: Write general description for this method
+    # @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
+
+    # TODO: Write general description for this method
+    # @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
+
+    # TODO: Write general description for this method
+    # @return [DisconnectMethodEnum]
+    attr_accessor :disconnect_method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :username
+
+    # TODO: Write general description for this method
+    # @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
+
+    # 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'
+      @_hash['from'] = 'from'
+      @_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
+
+    # An array for optional fields
+    def optionals
+      %w[
+        start_time
+        call_timeout
+        callback_timeout
+        answer_fallback_url
+        answer_fallback_method
+        disconnect_url
+        username
+        password
+        fallback_username
+        fallback_password
+        tag
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        answer_fallback_url
+        answer_fallback_method
+        disconnect_url
+        disconnect_method
+        username
+        password
+        fallback_username
+        fallback_password
+        tag
+      ]
+    end
+
+    def initialize(account_id = nil,
+                   call_id = nil,
+                   application_id = nil,
+                   to = nil,
+                   from = nil,
+                   call_url = nil,
+                   answer_url = nil,
+                   answer_method = nil,
+                   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 unless account_id == SKIP
+      @call_id = call_id unless call_id == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @call_url = call_url unless call_url == SKIP
+      @call_timeout = call_timeout unless call_timeout == SKIP
+      @callback_timeout = callback_timeout unless callback_timeout == SKIP
+      @answer_url = answer_url unless answer_url == SKIP
+      @answer_method = answer_method unless answer_method == SKIP
+      @answer_fallback_url = answer_fallback_url unless answer_fallback_url == SKIP
+      @answer_fallback_method = answer_fallback_method unless answer_fallback_method == SKIP
+      @disconnect_url = disconnect_url unless disconnect_url == SKIP
+      @disconnect_method = disconnect_method unless disconnect_method == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @fallback_username = fallback_username unless fallback_username == SKIP
+      @fallback_password = fallback_password unless fallback_password == SKIP
+      @tag = tag unless tag == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      call_id = hash.key?('callId') ? hash['callId'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      call_url = hash.key?('callUrl') ? hash['callUrl'] : SKIP
+      answer_url = hash.key?('answerUrl') ? hash['answerUrl'] : SKIP
+      answer_method = hash.key?('answerMethod') ? hash['answerMethod'] : SKIP
+      disconnect_method =
+        hash.key?('disconnectMethod') ? hash['disconnectMethod'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      call_timeout = hash.key?('callTimeout') ? hash['callTimeout'] : SKIP
+      callback_timeout =
+        hash.key?('callbackTimeout') ? hash['callbackTimeout'] : SKIP
+      answer_fallback_url =
+        hash.key?('answerFallbackUrl') ? hash['answerFallbackUrl'] : SKIP
+      answer_fallback_method =
+        hash.key?('answerFallbackMethod') ? hash['answerFallbackMethod'] : SKIP
+      disconnect_url = hash.key?('disconnectUrl') ? hash['disconnectUrl'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      fallback_username =
+        hash.key?('fallbackUsername') ? hash['fallbackUsername'] : SKIP
+      fallback_password =
+        hash.key?('fallbackPassword') ? hash['fallbackPassword'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+
+      # Create object from extracted values.
+      CreateCallResponse.new(account_id,
+                             call_id,
+                             application_id,
+                             to,
+                             from,
+                             call_url,
+                             answer_url,
+                             answer_method,
+                             disconnect_method,
+                             start_time,
+                             call_timeout,
+                             callback_timeout,
+                             answer_fallback_url,
+                             answer_fallback_method,
+                             disconnect_url,
+                             username,
+                             password,
+                             fallback_username,
+                             fallback_password,
+                             tag)
+    end
+
+    def to_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Diversion Model.
+  class Diversion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :privacy
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :unknown
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :orig_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['privacy'] = 'privacy'
+      @_hash['unknown'] = 'unknown'
+      @_hash['orig_to'] = 'origTo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        reason
+        privacy
+        unknown
+        orig_to
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(reason = nil,
+                   privacy = nil,
+                   unknown = nil,
+                   orig_to = nil)
+      @reason = reason unless reason == SKIP
+      @privacy = privacy unless privacy == SKIP
+      @unknown = unknown unless unknown == SKIP
+      @orig_to = orig_to unless orig_to == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      privacy = hash.key?('privacy') ? hash['privacy'] : SKIP
+      unknown = hash.key?('unknown') ? hash['unknown'] : SKIP
+      orig_to = hash.key?('origTo') ? hash['origTo'] : SKIP
+
+      # Create object from extracted values.
+      Diversion.new(reason,
+                    privacy,
+                    unknown,
+                    orig_to)
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # FallbackMethod.
+  class FallbackMethodEnum
+    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/machine_detection_configuration.rb

@@ -0,0 +1,218 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # MachineDetectionConfiguration Model.
+  class MachineDetectionConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The machine detection mode. If set to 'async', the detection result will
+    # be sent in a 'machineDetectionComplete' callback. If set to 'sync', the
+    # 'answer' callback will wait for the machine detection to complete and will
+    # include its result. Default is 'async'.
+    # @return [ModeEnum]
+    attr_accessor :mode
+
+    # Total amount of time (in seconds) before giving up.
+    # @return [Float]
+    attr_accessor :detection_timeout
+
+    # If no speech is detected in this period, a callback with a 'silence'
+    # result is sent. Default is 10 seconds.
+    # @return [Float]
+    attr_accessor :silence_timeout
+
+    # When speech has ended and a result couldn't be determined based on the
+    # audio content itself, this value is used to determine if the speaker is a
+    # machine based on the speech duration. If the length of the speech detected
+    # is greater than or equal to this threshold, the result will be
+    # 'answering-machine'. If the length of speech detected is below this
+    # threshold, the result will be 'human'. Default is 10 seconds.
+    # @return [Float]
+    attr_accessor :speech_threshold
+
+    # Amount of silence (in seconds) before assuming the callee has finished
+    # speaking.
+    # @return [Float]
+    attr_accessor :speech_end_threshold
+
+    # If set to 'true' and if an answering machine is detected, the
+    # 'answering-machine' callback will be delayed until the machine is done
+    # speaking or until the 'detectionTimeout' is exceeded. If false, the
+    # 'answering-machine' result is sent immediately. Default is 'false'.
+    # @return [Boolean]
+    attr_accessor :delay_result
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :callback_url
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [CallbackMethodEnum]
+    attr_accessor :callback_method
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :fallback_url
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [FallbackMethodEnum]
+    attr_accessor :fallback_method
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :username
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :password
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :fallback_username
+
+    # The URL to send the 'machineDetectionComplete' callback when the detection
+    # is completed. Only for 'async' mode.
+    # @return [String]
+    attr_accessor :fallback_password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mode'] = 'mode'
+      @_hash['detection_timeout'] = 'detectionTimeout'
+      @_hash['silence_timeout'] = 'silenceTimeout'
+      @_hash['speech_threshold'] = 'speechThreshold'
+      @_hash['speech_end_threshold'] = 'speechEndThreshold'
+      @_hash['delay_result'] = 'delayResult'
+      @_hash['callback_url'] = 'callbackUrl'
+      @_hash['callback_method'] = 'callbackMethod'
+      @_hash['fallback_url'] = 'fallbackUrl'
+      @_hash['fallback_method'] = 'fallbackMethod'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash['fallback_username'] = 'fallbackUsername'
+      @_hash['fallback_password'] = 'fallbackPassword'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        mode
+        detection_timeout
+        silence_timeout
+        speech_threshold
+        speech_end_threshold
+        delay_result
+        callback_url
+        callback_method
+        fallback_url
+        fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        callback_url
+        callback_method
+        fallback_url
+        fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+      ]
+    end
+
+    def initialize(mode = nil,
+                   detection_timeout = nil,
+                   silence_timeout = nil,
+                   speech_threshold = nil,
+                   speech_end_threshold = nil,
+                   delay_result = nil,
+                   callback_url = nil,
+                   callback_method = nil,
+                   fallback_url = nil,
+                   fallback_method = nil,
+                   username = nil,
+                   password = nil,
+                   fallback_username = nil,
+                   fallback_password = nil)
+      @mode = mode unless mode == SKIP
+      @detection_timeout = detection_timeout unless detection_timeout == SKIP
+      @silence_timeout = silence_timeout unless silence_timeout == SKIP
+      @speech_threshold = speech_threshold unless speech_threshold == SKIP
+      @speech_end_threshold = speech_end_threshold unless speech_end_threshold == SKIP
+      @delay_result = delay_result unless delay_result == SKIP
+      @callback_url = callback_url unless callback_url == SKIP
+      @callback_method = callback_method unless callback_method == SKIP
+      @fallback_url = fallback_url unless fallback_url == SKIP
+      @fallback_method = fallback_method unless fallback_method == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @fallback_username = fallback_username unless fallback_username == SKIP
+      @fallback_password = fallback_password unless fallback_password == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      detection_timeout =
+        hash.key?('detectionTimeout') ? hash['detectionTimeout'] : SKIP
+      silence_timeout =
+        hash.key?('silenceTimeout') ? hash['silenceTimeout'] : SKIP
+      speech_threshold =
+        hash.key?('speechThreshold') ? hash['speechThreshold'] : SKIP
+      speech_end_threshold =
+        hash.key?('speechEndThreshold') ? hash['speechEndThreshold'] : SKIP
+      delay_result = hash.key?('delayResult') ? hash['delayResult'] : SKIP
+      callback_url = hash.key?('callbackUrl') ? hash['callbackUrl'] : SKIP
+      callback_method =
+        hash.key?('callbackMethod') ? hash['callbackMethod'] : SKIP
+      fallback_url = hash.key?('fallbackUrl') ? hash['fallbackUrl'] : SKIP
+      fallback_method =
+        hash.key?('fallbackMethod') ? hash['fallbackMethod'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      fallback_username =
+        hash.key?('fallbackUsername') ? hash['fallbackUsername'] : SKIP
+      fallback_password =
+        hash.key?('fallbackPassword') ? hash['fallbackPassword'] : SKIP
+
+      # Create object from extracted values.
+      MachineDetectionConfiguration.new(mode,
+                                  detection_timeout,
+                                  silence_timeout,
+                                  speech_threshold,
+                                  speech_end_threshold,
+                                  delay_result,
+                                  callback_url,
+                                  callback_method,
+                                  fallback_url,
+                                  fallback_method,
+                                  username,
+                                  password,
+                                  fallback_username,
+                                  fallback_password)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # The machine detection mode. If set to 'async', the detection result will be
+  # sent in a 'machineDetectionComplete' callback. If set to 'sync', the
+  # 'answer' callback will wait for the machine detection to complete and will
+  # include its result. Default is 'async'.
+  class ModeEnum
+    MODE_ENUM = [
+      # TODO: Write general description for SYNC
+      SYNC = 'sync'.freeze,
+
+      # TODO: Write general description for ASYNC
+      ASYNC = 'async'.freeze
+    ].freeze
+  end
+end

data/lib/bandwidth/voice_lib/voice/models/{modify_call_recording_state.rb → modify_call_recording_request.rb}

@@ -4,10 +4,13 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # ModifyCallRecordingState Model.
-  class ModifyCallRecordingState < BaseModel
+  # ModifyCallRecordingRequest Model.
+  class ModifyCallRecordingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
-    # @return [State2Enum]
+    # @return [State1Enum]
     attr_accessor :state
 
     # A mapping from model property names to API property names.
@@ -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(state = nil)
-      @state = state
+      @state = state unless state == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -26,10 +39,10 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      state = hash['state']
+      state = hash.key?('state') ? hash['state'] : SKIP
 
       # Create object from extracted values.
-      ModifyCallRecordingState.new(state)
+      ModifyCallRecordingRequest.new(state)
     end
   end
 end