bandwidth-sdk 0.1.0 → 1.0.0.pre

data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb

@@ -0,0 +1,80 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # MessageRequest Model.
+  class MessageRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :application_id
+
+    # TODO: Write general description for this method
+    # @return [List of 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 :text
+
+    # TODO: Write general description for this method
+    # @return [List of String]
+    attr_accessor :media
+
+    # 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['application_id'] = 'applicationId'
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['text'] = 'text'
+      @_hash['media'] = 'media'
+      @_hash['tag'] = 'tag'
+      @_hash
+    end
+
+    def initialize(application_id = nil,
+                   to = nil,
+                   from = nil,
+                   text = nil,
+                   media = nil,
+                   tag = nil)
+      @application_id = application_id
+      @to = to
+      @from = from
+      @text = text
+      @media = media
+      @tag = tag
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      application_id = hash['applicationId']
+      to = hash['to']
+      from = hash['from']
+      text = hash['text']
+      media = hash['media']
+      tag = hash['tag']
+
+      # Create object from extracted values.
+      MessageRequest.new(application_id,
+                         to,
+                         from,
+                         text,
+                         media,
+                         tag)
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging/models/tag.rb

@@ -0,0 +1,44 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Tag Model.
+  class Tag < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    def initialize(key = nil,
+                   value = nil)
+      @key = key
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key = hash['key']
+      value = hash['value']
+
+      # Create object from extracted values.
+      Tag.new(key,
+              value)
+    end
+  end
+end

data/lib/bandwidth/models/base_model.rb

@@ -1,36 +1,36 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # Base model.
-  class BaseModel
-    # Returns a Hash representation of the current object.
-    def to_hash
-      hash = {}
-      instance_variables.each do |name|
-        value = instance_variable_get(name)
-        name = name[1..-1]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
-        if value.instance_of? Array
-          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-        elsif value.instance_of? Hash
-          hash[key] = {}
-          value.each do |k, v|
-            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
-          end
-        else
-          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
-        end
-      end
-      hash
-    end
-
-    # Returns a JSON representation of the curent object.
-    def to_json(options = {})
-      hash = to_hash.reject { |k, v| v.nil? }
-      hash.to_json(options)
-    end
-  end
-end
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash.reject { |k, v| v.nil? }
+      hash.to_json(options)
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/bxml.rb

@@ -0,0 +1,40 @@
+
+require 'builder'
+Dir[File.dirname(__FILE__) + '/verbs/*'].each {|file|
+  require_relative file
+}
+
+SSML_REGEX = /<([a-zA-Z\/\/].*?)>/
+SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>.*?<\/SpeakSentence>/
+
+module Bandwidth 
+  module Voice 
+    class Response
+      # Initializer
+      # @param verbs [Array] optional list of verbs to include into response
+      def initialize(verbs = nil)
+        @verbs = verbs || []
+      end
+
+      # Return BXML representaion of this response
+      def to_bxml()
+        xml = Builder::XmlMarkup.new()
+        xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
+        xml.Response do
+          @verbs.each {|verb| verb.to_bxml(xml)}
+        end
+        xml.target!().gsub(SPEAK_SENTENCE_REGEX){|s|s.gsub(SSML_REGEX, '<\1>')}
+      end
+
+      # Add one or more verbs to this response
+      def push(*verbs)
+        @verbs.push(*verbs)
+      end
+
+      # Add a verb to this response
+      def <<(verb)
+        @verbs << verb
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/forward.rb

@@ -0,0 +1,19 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    class Forward
+      include XmlVerb
+      def to_bxml(xml)
+        xml.Forward(compact_hash({
+         'to' => to,
+         'from' => from,
+         'callTimeout' => call_timeout,
+         'diversionTreatment' => diversion_treatment,
+         'diversionReason' => diversion_reason
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/gather.rb

@@ -0,0 +1,38 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Gather verb is used to collect digits for some period of time
+    class Gather
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Gather(compact_hash({
+          'gatherUrl' => gather_url,
+          'gatherMethod' => gather_method,
+          'terminatingDigits' => terminating_digits,
+          'tag' => tag,
+          'maxDigits' => max_digits,
+          'interDigitTimeout' => inter_digit_timeout,
+          'username' => username,
+          'password' => password,
+          'firstDigitTimeout' => first_digit_timeout,
+          'repeatCount' => repeat_count
+         })) do
+           def embedded_xml(xml, property, type)
+             if property
+               s = if property.is_a?(type)
+                     then property
+                   else type.new(property)
+                     end
+               s.to_bxml(xml)
+             end
+           end
+          embedded_xml(xml, speak_sentence, SpeakSentence)
+          embedded_xml(xml, play_audio, PlayAudio)
+        end
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/hangup.rb

@@ -0,0 +1,15 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice  
+    # The Hangup verb is used to hangup current call
+    class Hangup
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Hangup()
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/pause.rb

@@ -0,0 +1,16 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    class Pause
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Pause(compact_hash({
+         'duration' => duration
+      }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/phone_number.rb

@@ -0,0 +1,19 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    class PhoneNumber
+      include XmlVerb
+      def to_bxml(xml)
+        xml.PhoneNumber(number, compact_hash({
+          'transferAnswerUrl' => transfer_answer_url,
+          'transferAnswerMethod' => transfer_answer_method,
+          'username' => username,
+          'password' => password,
+          'tag' => tag
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/play_audio.rb

@@ -0,0 +1,18 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The PlayAudio verb is used to play an audio file in the call
+    class PlayAudio
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.PlayAudio(url, compact_hash({
+         'username' => username,
+         'password' => password
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/redirect.rb

@@ -0,0 +1,21 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Redirect verb is used to redirect the current XML execution to another URL
+    class Redirect
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Redirect(compact_hash({
+         'redirectUrl' => redirect_url,
+         'redirectMethod' => redirect_method,
+         'tag' => tag,
+         'username' => username,
+         'password' => password
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/send_dtmf.rb

@@ -0,0 +1,14 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    class SendDtmf
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.SendDtmf(dtmf)
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/speak_sentence.rb

@@ -0,0 +1,19 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The SpeakSentence verb is used to convert any text into speak for the caller
+    class SpeakSentence
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.SpeakSentence(sentence, compact_hash({
+         'voice' => voice,
+         'locale' => locale,
+         'gender' => gender
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/transfer.rb

@@ -0,0 +1,38 @@
+
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Transfer verb is used to transfer the call to another number
+    class Transfer
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Transfer(compact_hash({
+         'transferCallerId' => transfer_caller_id,
+         'callTimeout' => call_timeout,
+         'tag' => tag,
+         'transferCompleteUrl' => transfer_complete_url,
+         'transferCompleteMethod' => transfer_complete_method,
+         'username' => username,
+         'password' => password,
+         'diversionTreatment' => diversion_treatment,
+         'diversionReason' => diversion_reason
+        })) do
+          def embedded_xml(xml, property, type)
+            if property
+              s = if property.is_a?(type)
+                  then property
+                  else type.new(property)
+                  end
+              s.to_bxml(xml)
+            end
+          end
+          phone_numbers.each do |number|
+            embedded_xml(xml, number, PhoneNumber)
+          end
+        end
+      end
+    end
+  end
+end