bandwidth-sdk 7.1.0 → 9.1.1

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_request.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # ModifyCallRecordingRequest Model.
   class ModifyCallRecordingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [State1Enum]
     attr_accessor :state
@@ -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,7 +39,7 @@ 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.
       ModifyCallRecordingRequest.new(state)

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # ModifyCallRequest Model.
   class ModifyCallRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [StateEnum]
     attr_accessor :state
@@ -62,6 +65,38 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        state
+        redirect_url
+        redirect_fallback_url
+        redirect_method
+        redirect_fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+        tag
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        state
+        redirect_url
+        redirect_fallback_url
+        redirect_method
+        redirect_fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+        tag
+      ]
+    end
+
     def initialize(state = StateEnum::ACTIVE,
                    redirect_url = nil,
                    redirect_fallback_url = nil,
@@ -72,16 +107,16 @@ module Bandwidth
                    fallback_username = nil,
                    fallback_password = nil,
                    tag = nil)
-      @state = state
-      @redirect_url = redirect_url
-      @redirect_fallback_url = redirect_fallback_url
-      @redirect_method = redirect_method
-      @redirect_fallback_method = redirect_fallback_method
-      @username = username
-      @password = password
-      @fallback_username = fallback_username
-      @fallback_password = fallback_password
-      @tag = tag
+      @state = state unless state == SKIP
+      @redirect_url = redirect_url unless redirect_url == SKIP
+      @redirect_fallback_url = redirect_fallback_url unless redirect_fallback_url == SKIP
+      @redirect_method = redirect_method unless redirect_method == SKIP
+      @redirect_fallback_method = redirect_fallback_method unless redirect_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
+      @tag = tag unless tag == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -90,15 +125,20 @@ module Bandwidth
 
       # Extract variables from the hash.
       state = hash['state'] ||= StateEnum::ACTIVE
-      redirect_url = hash['redirectUrl']
-      redirect_fallback_url = hash['redirectFallbackUrl']
-      redirect_method = hash['redirectMethod']
-      redirect_fallback_method = hash['redirectFallbackMethod']
-      username = hash['username']
-      password = hash['password']
-      fallback_username = hash['fallbackUsername']
-      fallback_password = hash['fallbackPassword']
-      tag = hash['tag']
+      redirect_url = hash.key?('redirectUrl') ? hash['redirectUrl'] : SKIP
+      redirect_fallback_url =
+        hash.key?('redirectFallbackUrl') ? hash['redirectFallbackUrl'] : SKIP
+      redirect_method =
+        hash.key?('redirectMethod') ? hash['redirectMethod'] : SKIP
+      redirect_fallback_method =
+        hash.key?('redirectFallbackMethod') ? hash['redirectFallbackMethod'] : 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.
       ModifyCallRequest.new(state,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # ModifyConferenceRequest Model.
   class ModifyConferenceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [StatusEnum]
     attr_accessor :status
@@ -57,6 +60,35 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        status
+        redirect_url
+        redirect_fallback_url
+        redirect_method
+        redirect_fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        redirect_url
+        redirect_fallback_url
+        redirect_method
+        redirect_fallback_method
+        username
+        password
+        fallback_username
+        fallback_password
+      ]
+    end
+
     def initialize(status = nil,
                    redirect_url = nil,
                    redirect_fallback_url = nil,
@@ -66,15 +98,15 @@ module Bandwidth
                    password = nil,
                    fallback_username = nil,
                    fallback_password = nil)
-      @status = status
-      @redirect_url = redirect_url
-      @redirect_fallback_url = redirect_fallback_url
-      @redirect_method = redirect_method
-      @redirect_fallback_method = redirect_fallback_method
-      @username = username
-      @password = password
-      @fallback_username = fallback_username
-      @fallback_password = fallback_password
+      @status = status unless status == SKIP
+      @redirect_url = redirect_url unless redirect_url == SKIP
+      @redirect_fallback_url = redirect_fallback_url unless redirect_fallback_url == SKIP
+      @redirect_method = redirect_method unless redirect_method == SKIP
+      @redirect_fallback_method = redirect_fallback_method unless redirect_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.
@@ -82,15 +114,20 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      status = hash['status']
-      redirect_url = hash['redirectUrl']
-      redirect_fallback_url = hash['redirectFallbackUrl']
-      redirect_method = hash['redirectMethod']
-      redirect_fallback_method = hash['redirectFallbackMethod']
-      username = hash['username']
-      password = hash['password']
-      fallback_username = hash['fallbackUsername']
-      fallback_password = hash['fallbackPassword']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      redirect_url = hash.key?('redirectUrl') ? hash['redirectUrl'] : SKIP
+      redirect_fallback_url =
+        hash.key?('redirectFallbackUrl') ? hash['redirectFallbackUrl'] : SKIP
+      redirect_method =
+        hash.key?('redirectMethod') ? hash['redirectMethod'] : SKIP
+      redirect_fallback_method =
+        hash.key?('redirectFallbackMethod') ? hash['redirectFallbackMethod'] : 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.
       ModifyConferenceRequest.new(status,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # TranscribeRecordingRequest Model.
   class TranscribeRecordingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :callback_url
@@ -42,18 +45,41 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        callback_url
+        callback_method
+        username
+        password
+        tag
+        callback_timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      %w[
+        callback_method
+        username
+        password
+        tag
+        callback_timeout
+      ]
+    end
+
     def initialize(callback_url = nil,
                    callback_method = nil,
                    username = nil,
                    password = nil,
                    tag = nil,
                    callback_timeout = nil)
-      @callback_url = callback_url
-      @callback_method = callback_method
-      @username = username
-      @password = password
-      @tag = tag
-      @callback_timeout = callback_timeout
+      @callback_url = callback_url unless callback_url == SKIP
+      @callback_method = callback_method unless callback_method == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == SKIP
+      @tag = tag unless tag == SKIP
+      @callback_timeout = callback_timeout unless callback_timeout == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -61,12 +87,14 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      callback_url = hash['callbackUrl']
-      callback_method = hash['callbackMethod']
-      username = hash['username']
-      password = hash['password']
-      tag = hash['tag']
-      callback_timeout = hash['callbackTimeout']
+      callback_url = hash.key?('callbackUrl') ? hash['callbackUrl'] : SKIP
+      callback_method =
+        hash.key?('callbackMethod') ? hash['callbackMethod'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      tag = hash.key?('tag') ? hash['tag'] : SKIP
+      callback_timeout =
+        hash.key?('callbackTimeout') ? hash['callbackTimeout'] : SKIP
 
       # Create object from extracted values.
       TranscribeRecordingRequest.new(callback_url,

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

@@ -6,6 +6,9 @@
 module Bandwidth
   # Transcript Model.
   class Transcript < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :text
@@ -22,10 +25,23 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        text
+        confidence
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(text = nil,
                    confidence = nil)
-      @text = text
-      @confidence = confidence
+      @text = text unless text == SKIP
+      @confidence = confidence unless confidence == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -33,8 +49,8 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      text = hash['text']
-      confidence = hash['confidence']
+      text = hash.key?('text') ? hash['text'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
 
       # Create object from extracted values.
       Transcript.new(text,

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

@@ -0,0 +1,80 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Transcription Model.
+  class Transcription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :completed_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['url'] = 'url'
+      @_hash['status'] = 'status'
+      @_hash['completed_time'] = 'completedTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def optionals
+      %w[
+        id
+        url
+        status
+        completed_time
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   url = nil,
+                   status = nil,
+                   completed_time = nil)
+      @id = id unless id == SKIP
+      @url = url unless url == SKIP
+      @status = status unless status == SKIP
+      @completed_time = completed_time unless completed_time == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      completed_time = hash.key?('completedTime') ? hash['completedTime'] : SKIP
+
+      # Create object from extracted values.
+      Transcription.new(id,
+                        url,
+                        status,
+                        completed_time)
+    end
+  end
+end