bandwidth-sdk 10.4.0 → 11.0.0.pre.beta.1

data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb

@@ -0,0 +1,365 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  # If the originating call leaves the <Bridge>, then this callback is sent to the bridgeTargetCompleteUrl, and the BXML returned in it is executed on the target call. If this webhook is sent, the Bridge Complete webhook is NOT sent.
+  class BridgeTargetCompleteCallback
+    # The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
+    attr_accessor :event_type
+
+    # The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
+    attr_accessor :event_time
+
+    # The user account associated with the call.
+    attr_accessor :account_id
+
+    # The id of the application associated with the call.
+    attr_accessor :application_id
+
+    # The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
+    attr_accessor :from
+
+    # The phone number that received the call, in E.164 format (e.g. +15555555555).
+    attr_accessor :to
+
+    attr_accessor :direction
+
+    # The call id associated with the event.
+    attr_accessor :call_id
+
+    # The URL of the call associated with the event.
+    attr_accessor :call_url
+
+    # (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
+    attr_accessor :enqueued_time
+
+    # Time the call was started, in ISO 8601 format.
+    attr_accessor :start_time
+
+    # Time the call was answered, in ISO 8601 format.
+    attr_accessor :answer_time
+
+    # (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
+    attr_accessor :tag
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_type' => :'eventType',
+        :'event_time' => :'eventTime',
+        :'account_id' => :'accountId',
+        :'application_id' => :'applicationId',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'direction' => :'direction',
+        :'call_id' => :'callId',
+        :'call_url' => :'callUrl',
+        :'enqueued_time' => :'enqueuedTime',
+        :'start_time' => :'startTime',
+        :'answer_time' => :'answerTime',
+        :'tag' => :'tag'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event_type' => :'String',
+        :'event_time' => :'String',
+        :'account_id' => :'String',
+        :'application_id' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'direction' => :'CallDirectionEnum',
+        :'call_id' => :'String',
+        :'call_url' => :'String',
+        :'enqueued_time' => :'Time',
+        :'start_time' => :'Time',
+        :'answer_time' => :'Time',
+        :'tag' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'enqueued_time',
+        :'answer_time',
+        :'tag'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Bandwidth::BridgeTargetCompleteCallback` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::BridgeTargetCompleteCallback`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'event_time')
+        self.event_time = attributes[:'event_time']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'call_id')
+        self.call_id = attributes[:'call_id']
+      end
+
+      if attributes.key?(:'call_url')
+        self.call_url = attributes[:'call_url']
+      end
+
+      if attributes.key?(:'enqueued_time')
+        self.enqueued_time = attributes[:'enqueued_time']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'answer_time')
+        self.answer_time = attributes[:'answer_time']
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          event_type == o.event_type &&
+          event_time == o.event_time &&
+          account_id == o.account_id &&
+          application_id == o.application_id &&
+          from == o.from &&
+          to == o.to &&
+          direction == o.direction &&
+          call_id == o.call_id &&
+          call_url == o.call_url &&
+          enqueued_time == o.enqueued_time &&
+          start_time == o.start_time &&
+          answer_time == o.answer_time &&
+          tag == o.tag
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [event_type, event_time, account_id, application_id, from, to, direction, call_id, call_url, enqueued_time, start_time, answer_time, tag].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Bandwidth.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/bandwidth-sdk/models/bxml/bxml.rb

@@ -0,0 +1,13 @@
+module Bandwidth
+  module Bxml
+    class Bxml
+      include Bandwidth::Bxml::Root
+
+      # Initializer
+      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      def initialize(nested_verbs = [])
+        super(tag='Bxml', nested_verbs)
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb

@@ -0,0 +1,50 @@
+require 'ox'
+
+module Bandwidth
+  module Bxml
+    module NestableVerb
+      include Bandwidth::Bxml::Verb
+
+      # Initializer
+      # @param tag [String] Name of the XML element.
+      # @param content [String] XML element content. Defaults to nil.
+      # @param nested_verbs [Array] XML element children. Defaults to an empty array.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(tag, content = nil, nested_verbs = [], attributes = {})
+        @tag = tag
+        @content = content
+        @nested_verbs = nested_verbs
+        @attributes = attributes
+        @attribute_map = []
+      end
+
+      # Generate an XML element for the verb
+      # @return [Node] The XML element.
+      def generate_xml
+        root = Ox::Element.new(@tag)
+        if @content
+          root << @content
+        end
+
+        if @nested_verbs.length > 0
+          @nested_verbs.each do |verb|
+            root << verb.generate_xml
+          end
+        end
+
+        if !@attributes.empty?
+          @attributes.each do |key, value|
+            if @attribute_map.include? key.to_sym
+              root[@attribute_map[key.to_sym]] = value
+            else
+              raise NoMethodError.new("attribute '#{key}' is not a valid attribute for this verb")
+            end
+          end
+        end
+
+        return root
+      end
+
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/response.rb

@@ -0,0 +1,13 @@
+module Bandwidth
+  module Bxml
+    class Response
+      include Bandwidth::Bxml::Root
+
+      # Initializer
+      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      def initialize(nested_verbs = [])
+        super(tag='Response', nested_verbs)
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/root.rb

@@ -0,0 +1,47 @@
+require 'ox'
+
+module Bandwidth
+  module Bxml
+    SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>(.*?)<\/SpeakSentence>/
+    SSML_REGEX = /&lt;([a-zA-Z\/\/].*?)&gt;/
+
+    module Root
+      # Initializer
+      # @param tag [String] Name of the XML element.
+      # @param nested_verbs [Array<Verb>] XML element children. Defaults to an empty array.
+      def initialize(tag, nested_verbs = [])
+        @tag = tag
+        @nested_verbs = nested_verbs
+      end
+
+      # Generate an XML element for the BXML response
+      # @return [Document] The XML element.
+      def generate_xml
+        xml = Ox::Document.new
+        instruct = Ox::Instruct.new(:xml)
+        instruct[:version] = '1.0'
+        instruct[:encoding] = 'UTF-8'
+        xml << instruct
+        root = Ox::Element.new(@tag)
+        @nested_verbs.each do |verb|
+          root << verb.generate_xml
+        end
+        xml << root
+        return xml
+      end
+
+      # Add a verb to the nested verbs array
+      # @param *nested_verbs [Verb] or [Array<Verb>] Verb or verbs to add to the array.
+      def add_verb(nested_verbs)
+        @nested_verbs.push(*nested_verbs)
+      end
+
+      # Return BXML representaion of this response
+      # @return [String] The XML response in string format.
+      def to_bxml
+        bxml = Ox.dump(generate_xml)
+        return bxml.gsub(SPEAK_SENTENCE_REGEX) { |text| text.gsub(SSML_REGEX, '<\1>')}
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/verb.rb

@@ -0,0 +1,51 @@
+require 'ox'
+
+module Bandwidth
+  module Bxml
+    module Verb
+      # Initializer
+      # @param tag [String] Name of the XML element.
+      # @param content [String] XML element content. Defaults to nil.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(tag, content = nil, attributes = {})
+        @tag = tag
+        @content = content
+        @attributes = attributes
+        @attribute_map = []
+      end
+
+      # Set XML attributes for the verb
+      # @param attributes [Hash] The attributes to add to the element.
+      def set_attributes(attributes)
+        @attributes = attributes
+      end
+
+      # Generate an XML element for the verb
+      # @return [Node] The XML element.
+      def generate_xml
+        root = Ox::Element.new(@tag)
+        if @content
+          root << @content
+        end
+
+        if !@attributes.empty?
+          @attributes.each do |key, value|
+            if @attribute_map.include? key.to_sym
+              root[@attribute_map[key.to_sym]] = value
+            else
+              raise NoMethodError.new("attribute '#{key}' is not a valid attribute for this verb")
+            end
+          end
+        end
+
+        return root
+      end
+
+      # Return BXML representaion of this element
+      # @return [String] The XML element in string format.
+      def to_bxml
+        return Ox.dump(generate_xml)
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb

@@ -0,0 +1,30 @@
+module Bandwidth
+  module Bxml
+    class Bridge
+      include Bandwidth::Bxml::Verb
+
+      # Initializer
+      # @param target_call [String] The callId of the call to be bridged.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(target_call, attributes = {})
+        super("Bridge", target_call, attributes)
+        
+        @attribute_map = {
+          bridge_complete_url: 'bridgeCompleteUrl',                                     # Optional [String]: URL to send the Bridge Complete event to and request new BXML. If this attribute is specified, then Verbs following the <Bridge> verb will be ignored and the BXML returned in this webhook is executed on the call. If this attribute is not specified then no webhook will be sent, and execution of the verbs following the <Bridge> verb continues. May be a relative URL. Defaults to None.
+          bridge_complete_method: 'bridgeCompleteMethod',                               # Optional [String]: The HTTP method to use for the request to bridgeCompleteUrl. GET or POST. Default value is POST.
+          bridge_complete_fallback_url: 'bridgeCompleteFallbackUrl',                    # Optional [String]: A fallback url which, if provided, will be used to retry the Bridge Complete webhook delivery in case bridgeCompleteUrl fails to respond. Defaults to None.
+          bridge_complete_fallback_method: 'bridgeCompleteFallbackMethod',              # Optional [String]: The HTTP method to use to deliver the Bridge Complete webhook to bridgeCompleteFallbackUrl. GET or POST. Default value is POST.
+          bridge_target_complete_url: 'bridgeTargetCompleteUrl',                        # Optional [String]: URL to send the Bridge Target Complete event to and request new BXML. If this attribute is specified, then the BXML returned in this webhook is executed on the target call. If this attribute is not specified then no webhook will be sent, and the target call will be hung up. May be a relative URL. Defaults to None.
+          bridge_target_complete_method: 'bridgeTargetCompleteMethod',                  # Optional [String]: The HTTP method to use for the request to bridgeTargetCompleteUrl. GET or POST. Default value is POST.
+          bridge_target_complete_fallback_url: 'bridgeTargetCompleteFallbackUrl',       # Optional [String]: A fallback url which, if provided, will be used to retry the Bridge Target Complete webhook delivery in case bridgeTargetCompleteUrl fails to respond. Defaults to None.
+          bridge_target_complete_fallback_method: 'bridgeTargetCompleteFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Bridge Target Complete webhook to bridgeTargetCompleteFallbackUrl. GET or POST. Default value is POST.
+          username: 'username',                                                         # Optional [String]: The username to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None.
+          password: 'password',                                                         # Optional [String]: The password to send in the HTTP request to bridgeCompleteUrl and to bridgeTargetCompleteUrl. Defaults to None.
+          fallback_username: 'fallbackUsername',                                        # Optional [String]: The username to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None.
+          fallback_password: 'fallbackPassword',                                        # Optional [String]: The password to send in the HTTP request to bridgeCompleteFallbackUrl and to bridgeTargetCompleteFallbackUrl. Defaults to None.
+          tag: 'tag',                                                                   # Optional [String]: A custom string that will be sent with the bridgeComplete webhook and all future webhooks of the call unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
+        }
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb

@@ -0,0 +1,31 @@
+module Bandwidth
+  module Bxml
+    class Conference
+      include Bandwidth::Bxml::Verb
+
+      # Initializer
+      # @param name [String] The name of the conference. Can contain up to 100 characters of letters, numbers, and the symbols -, _, and .
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(name, attributes = {})
+        super("Conference", name, attributes)
+        
+        @attribute_map = {
+          mute: 'mute',                                                       # Optional [Boolean]: A boolean value to indicate whether the member should be on mute in the conference. When muted, a member can hear others speak, but others cannot hear them speak. Defaults to false.
+          hold: 'hold',                                                       # Optional [Boolean]: A boolean value to indicate whether the member should be on hold in the conference. When on hold, a member cannot hear others, and they cannot be heard. Defaults to false.
+          call_ids_to_coach: 'callIdsToCoach',                                # Optional [String]: A comma-separated list of call ids to coach. When a call joins a conference with this attribute set, it will coach the listed calls. Those calls will be able to hear and be heard by the coach, but other calls in the conference will not hear the coach.
+          conference_event_url: 'conferenceEventUrl',                         # Optional [String]: URL to send Conference events to. The URL, method, username, and password are set by the BXML document that creates the conference, and all events related to that conference will be delivered to that same endpoint. If more calls join afterwards and also have this property (or any other webhook related properties like username and password), they will be ignored and the original webhook information will be used. This URL may be a relative endpoint.
+          conference_event_method: 'conferenceEventMethod',                   # Optional [String]: The HTTP method to use for the request to conferenceEventUrl. GET or POST. Default value is POST.
+          conference_event_fallback_url: 'conferenceEventFallbackUrl',        # Optional [String]: A fallback url which, if provided, will be used to retry the conference webhook deliveries in case conferenceEventUrl fails to respond.
+          conference_event_fallback_method: 'conferenceEventFallbackMethod',  # Optional [String]: The HTTP method to use to deliver the conference webhooks to conferenceEventFallbackUrl. GET or POST. Default value is POST.
+          username: 'username',                                               # Optional [String]: The username to send in the HTTP request to conferenceEventUrl.
+          password: 'password',                                               # Optional [String]: The password to send in the HTTP request to conferenceEventUrl.
+          fallback_username: 'fallbackUsername',                              # Optional [String]: The username to send in the HTTP request to conferenceEventFallbackUrl.
+          fallback_password: 'fallbackPassword',                              # Optional [String]: The password to send in the HTTP request to conferenceEventFallbackUrl.
+          tag: 'tag',                                                         # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
+          callback_timeout: 'callbackTimeout',                                # Optional [Number]: This is the timeout (in seconds) to use when delivering webhooks for the conference. If not set, it will inherit the webhook timeout from the call that creates the conference. Can be any numeric value (including decimals) between 1 and 25.
+        }
+      end
+    end
+  end
+end
+  

data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb

@@ -0,0 +1,22 @@
+module Bandwidth
+  module Bxml
+    class Forward
+      include Bandwidth::Bxml::Verb
+
+      # Initializer
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(attributes = {})
+        super("Forward", nil, attributes)
+        
+        @attribute_map = {
+          to: 'to',                                   # [String]: The phone number destination of the call.
+          from: 'from',                               # Optional [String]: The phone number that the recipient will receive the call from.
+          call_timeout: 'callTimeout',                # Optional [Number]: The number of seconds to wait before timing out the call.
+          diversion_treatment: 'diversionTreatment',  # Optional [String]: Can be any of the following: - none: No diversion headers are sent on the outbound leg of the transferred call. - propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg. - stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None.
+          diversion_reason: 'diversionReason',        # Optional [String]: Can be any of the following values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away. This parameter is considered only when diversionTreatment is set to stack. Defaults to None.
+          uui: 'uui',                                 # Optional [String]: The value of the User-To-User header to send within the outbound INVITE when forwarding to a SIP URI. Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.
+        }
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb

@@ -0,0 +1,44 @@
+module Bandwidth
+  module Bxml
+    class Gather
+      include Bandwidth::Bxml::NestableVerb
+
+      # Initializer
+      # @param audio_verbs [Array] XML element children. Defaults to an empty array. Valid nested audio verbs are: SpeakSentence, PlayAudio.
+      # @param attributes [Hash] The attributes to add to the element. Defaults to an empty hash.
+      def initialize(audio_verbs = [], attributes = {})
+        super("Gather", nil, audio_verbs, attributes)
+
+        @attribute_map = {
+          gather_url: 'gatherUrl',                        # Optional [String]: URL to send Gather event to and request new BXML. May be a relative URL.
+          gather_method: 'gatherMethod',                  # Optional [String]: The HTTP method to use for the request to gather_url. GET or POST. Default value is POST.
+          gather_fallback_url: 'gatherFallbackUrl',       # Optional [String]: A fallback url which, if provided, will be used to retry the Gather event callback delivery in case gather_url fails to respond.
+          gather_fallback_method: 'gatherFallbackMethod', # Optional [String]: The HTTP method to use to deliver the Gather event callback to gather_fallback_url. GET or POST. Default value is POST.
+          username: 'username',                           # Optional [String]: The username to send in the HTTP request to gather_url.
+          password: 'password',                           # Optional [String]: The password to send in the HTTP request to gather_url.
+          fallback_username: 'fallbackUsername',          # Optional [String]: The username to send in the HTTP request to gather_fallback_url.
+          fallback_password: 'fallbackPassword',          # Optional [String]: The password to send in the HTTP request to gather_fallback_url.
+          tag: 'tag',                                     # Optional [String]: A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters.
+          terminating_digits: 'terminatingDigits',        # Optional [String]: When any of these digits are pressed, it will terminate the Gather. Default value is "", which disables this feature.
+          max_digits: 'maxDigits',                        # Optional [Number]: Max number of digits to collect. Default value is 50. Range: decimal values between 1 - 50.
+          inter_digit_timeout: 'interDigitTimeout',       # Optional [Number]: Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60.
+          first_digit_timeout: 'firstDigitTimeout',       # Optional [Number]: Time (in seconds) to pause after any audio from nested <SpeakSentence> or <PlayAudio> verb is played (in seconds) before terminating the Gather. Default value is 5. Range: decimal values between 0 - 60.
+          repeat_count: 'repeat_count',                   # Optional [Number]: The number of times the audio prompt should be played if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. The delay between repetitions will be equal to first_digit_timeout. Default value is 1. repeat_count * number of verbs must not be greater than 20.
+        }
+      end
+
+      # Return BXML representaion of this response
+      # @return [String] The XML response in string format.
+      def to_bxml
+        bxml = Ox.dump(generate_xml)
+        return bxml.gsub(SPEAK_SENTENCE_REGEX) { |text| text.gsub(SSML_REGEX, '<\1>')}
+      end
+
+      # Add audio verb/s to the nested verbs array
+      # @param audio_verbs [SpeakSentence] || [PlayAudio] or [Array<SpeakSentence || PlayAudio>] Verb or verbs to add to the array.
+      def add_audio_verb(audio_verbs)
+        @nested_verbs.push(*audio_verbs)
+      end
+    end
+  end
+end