vonage 7.28.0 → 8.0.0.beta

data/lib/vonage/video.rb

@@ -4,7 +4,7 @@
 module Vonage
   class Video < Namespace
     include Keys
-
+    
     self.authentication = BearerToken
 
     self.host = :video_host
@@ -30,7 +30,7 @@ module Vonage
     #
     def create_session(**params)
       request_params = params.clone
-      request_params[:archive_mode] ||= 'manual'
+      request_params[:archive_mode] ||= 'manual' 
       media_mode = request_params.delete(:media_mode) || 'routed'
 
       if media_mode == 'relayed' && request_params[:archive_mode] == 'manual'
@@ -42,7 +42,7 @@ module Vonage
       response = request('/session/create', params: camelcase(request_params), type: Post)
 
       public_response_data = {
-        session_id: response.entity.first.session_id,
+        session_id: response.entity[:session_id],
         archive_mode: request_params[:archive_mode],
         media_mode: media_mode,
         location: request_params[:location]
@@ -54,22 +54,7 @@ module Vonage
     end
 
     def generate_client_token(session_id:, scope: 'session.connect', role: 'publisher', **params)
-      valid_roles = %w[publisher subscriber moderator publisheronly]
-      raise ArgumentError, "Invalid role: #{role}" unless valid_roles.include?(role)
-
-      claims = {
-        application_id: @config.application_id,
-        scope: scope,
-        session_id: session_id,
-        role: role,
-        initial_layout_class_list: '',
-        sub: 'video',
-        acl: {
-          paths: {'/session/**' => {}}
-        }
-      }
-
-
+      claims = {session_id: session_id, application_id: @config.application_id, scope: scope, role: role}
       claims[:data] = params[:data] if params[:data]
       claims[:initial_layout_class_list] = params[:initial_layout_class_list].join(' ') if params[:initial_layout_class_list]
       claims[:exp] = params[:expire_time].to_i if params[:expire_time]
@@ -77,52 +62,30 @@ module Vonage
       JWT.generate(claims, @config.private_key)
     end
 
-    # @return [Archives]
+    # @return [Streams]
     #
-    def archives
-      @archives ||= Archives.new(@config)
+    def streams
+      @streams ||= Streams.new(@config)
     end
 
-    # @return [Broadcasts]
+    # @return [Archives]
     #
-    def broadcasts
-      @broadcasts ||= Broadcasts.new(@config)
+    def archives
+      @archives ||= Archives.new(@config)
     end
 
-    # @return [Moderation]
+    # @return [Archives]
     #
     def moderation
       @moderation ||= Moderation.new(@config)
     end
 
-    # @return [Signals]
+    # @return [Archives]
     #
     def signals
       @signals ||= Signals.new(@config)
     end
 
-    # @return [Streams]
-    #
-    def streams
-      @streams ||= Streams.new(@config)
-    end
-
-    # @return [Captions]
-    #
-    def captions
-      @captions ||= Captions.new(@config)
-    end
-
-    # @return [Renders]
-    #
-    def renders
-      @renders ||= Renders.new(@config)
-    end
-
-    # @return [WebSocket]
-    #
-    def web_socket
-      @web_socket ||= WebSocket.new(@config)
-    end
+    # TODO: add token generator
   end
 end

data/lib/vonage/voice/actions/connect.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 require 'phonelib'
 
-module Vonage
+module Vonage  
   class Voice::Actions::Connect
-    attr_accessor :endpoint, :from, :eventType, :timeout, :limit, :machineDetection, :advanced_machine_detection, :eventUrl, :eventMethod, :ringbackTone
+    attr_accessor :endpoint, :from, :eventType, :timeout, :limit, :machineDetection, :eventUrl, :eventMethod, :ringbackTone
 
     def initialize(attributes = {})
       @endpoint = attributes.fetch(:endpoint)
@@ -13,7 +13,6 @@ module Vonage
       @timeout = attributes.fetch(:timeout, nil)
       @limit = attributes.fetch(:limit, nil)
       @machineDetection = attributes.fetch(:machineDetection, nil)
-      @advanced_machine_detection = attributes.fetch(:advanced_machine_detection, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
       @ringbackTone = attributes.fetch(:ringbackTone, nil)
@@ -40,10 +39,6 @@ module Vonage
         verify_machine_detection
       end
 
-      if self.advanced_machine_detection
-        verify_advanced_machine_detection
-      end
-
       if self.eventUrl
         verify_event_url
       end
@@ -87,33 +82,10 @@ module Vonage
       raise ClientError.new("Invalid 'machineDetection' value, must be either: 'continue' or 'hangup' if defined") unless self.machineDetection == 'continue' || self.machineDetection == 'hangup'
     end
 
-    def verify_advanced_machine_detection
-      raise ClientError.new("Invalid 'advanced_machine_detection' value, must be a Hash") unless self.advanced_machine_detection.is_a?(Hash)
-      verify_advanced_machine_detection_behavior if self.advanced_machine_detection[:behavior]
-      verify_advanced_machine_detection_mode if self.advanced_machine_detection[:mode]
-      verify_advanced_machine_detection_beep_timeout if self.advanced_machine_detection[:beep_timeout]
-    end
-
-    def verify_advanced_machine_detection_behavior
-      raise ClientError.new("Invalid 'advanced_machine_detection[:behavior]' value, must be a `continue` or `hangup`") unless ['continue', 'hangup'].include?(self.advanced_machine_detection[:behavior])
-    end
-
-    def verify_advanced_machine_detection_mode
-      raise ClientError.new("Invalid 'advanced_machine_detection[:mode]' value, must be a `detect` or `detect_beep`") unless ['detect', 'detect_beep'].include?(self.advanced_machine_detection[:mode])
-    end
-
-    def verify_advanced_machine_detection_beep_timeout
-      raise ClientError.new("Invalid 'advanced_machine_detection[:beep_timeout]' value, must be between 45 and 120") unless self.advanced_machine_detection[:beep_timeout].between?(45, 120)
-    end
-
     def verify_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(self.eventUrl[0])
+      uri = URI.parse(self.eventUrl)
 
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end
@@ -213,7 +185,6 @@ module Vonage
       }
 
       hash.merge!(headers: endpoint_attrs[:headers]) if endpoint_attrs[:headers]
-      hash.merge!(standardHeaders: endpoint_attrs[:standardHeaders]) if endpoint_attrs[:standardHeaders]
 
       hash
     end
@@ -225,4 +196,4 @@ module Vonage
       }
     end
   end
-end
+end

data/lib/vonage/voice/actions/conversation.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
-
-module Vonage
+ 
+ module Vonage 
   class Voice::Actions::Conversation
     attr_accessor :name, :musicOnHoldUrl, :startOnEnter, :endOnExit, :record, :canSpeak, :canHear, :mute
 
@@ -49,15 +49,9 @@ module Vonage
     end
 
     def verify_music_on_hold_url
-      music_on_hold_url = self.musicOnHoldUrl
-
-      unless music_on_hold_url.is_a?(Array) && music_on_hold_url.length == 1 && music_on_hold_url[0].is_a?(String)
-        raise ClientError.new("Expected 'musicOnHoldUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(music_on_hold_url[0])
+      uri = URI.parse(self.musicOnHoldUrl)
 
-      raise ClientError.new("Invalid 'musicOnHoldUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'musicOnHoldUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.musicOnHoldUrl
     end

data/lib/vonage/voice/actions/input.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Voice::Actions::Input
-    attr_accessor :type, :dtmf, :speech, :eventUrl, :eventMethod, :mode
+    attr_accessor :type, :dtmf, :speech, :eventUrl, :eventMethod
 
     def initialize(attributes = {})
       @type = attributes.fetch(:type)
@@ -11,7 +11,6 @@ module Vonage
       @speech = attributes.fetch(:speech, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
-      @mode = attributes.fetch(:mode, nil)
 
       after_initialize!
     end
@@ -34,10 +33,6 @@ module Vonage
       if self.eventMethod
         validate_event_method
       end
-
-      if self.mode
-        validate_mode
-      end
     end
 
     def validate_type
@@ -88,13 +83,9 @@ module Vonage
     end
 
     def validate_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(self.eventUrl[0])
+      uri = URI.parse(self.eventUrl)
 
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end
@@ -105,12 +96,6 @@ module Vonage
       raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
     end
 
-    def validate_mode
-      valid_modes = ['asyncronous']
-
-      raise ClientError.new("Invalid 'mode' value, must be asyncronous'") unless valid_modes.include?(self.mode)
-    end
-
     def action
       create_input!(self)
     end
@@ -127,7 +112,6 @@ module Vonage
       ncco[0].merge!(speech: builder.speech) if builder.speech
       ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
       ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
-      ncco[0].merge!(mode: builder.mode) if builder.mode
 
       ncco
     end

data/lib/vonage/voice/actions/notify.rb

@@ -22,15 +22,10 @@ module Vonage
     end
 
     def validate_event_url
-      event_url = self.eventUrl
+      uri = URI.parse(self.eventUrl[0])
 
-      unless event_url.is_a?(Array) && event_url.length == 1 && event_url[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(event_url[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Expected 'eventUrl' value to be an Array with a single string") unless self.eventUrl.is_a?(Array)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end

data/lib/vonage/voice/actions/pay.rb

@@ -0,0 +1,107 @@
+# typed: true
+# frozen_string_literal: true
+module Vonage
+  class Voice::Actions::Pay
+    attr_accessor :amount, :currency, :eventUrl, :prompts, :voice
+
+    def initialize(attributes= {})
+      @amount = attributes.fetch(:amount)
+      @currency = attributes.fetch(:currency, nil)
+      @eventUrl = attributes.fetch(:eventUrl, nil)
+      @prompts = attributes.fetch(:prompts, nil)
+      @voice = attributes.fetch(:voice, nil)
+
+      after_initialize!
+    end
+
+    def action
+      create_pay!(self)
+    end
+
+    def create_pay!(builder)
+      ncco = [
+        {
+          action: 'pay',
+          amount: builder.amount
+        }
+      ]
+
+      ncco[0].merge!(currency: builder.currency) if builder.currency
+      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
+      ncco[0].merge!(prompts: builder.prompts) if builder.prompts
+      ncco[0].merge!(voice: builder.voice) if builder.voice
+
+      ncco
+    end
+
+    private
+
+    def after_initialize!
+      verify_amount
+
+      if self.eventUrl
+        verify_event_url
+      end
+
+      if self.prompts
+        verify_prompts
+      end
+
+      if self.voice
+        verify_voice
+      end
+    end
+
+    def verify_amount
+      verify_amount_class
+      verify_amount_value
+    end
+
+    def verify_event_url
+      raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item") unless self.eventUrl.is_a?(Array)
+
+      uri = URI.parse(self.eventUrl[0])
+
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+    end
+
+    def verify_prompts
+      verify_prompts_structure
+      verify_prompts_values
+    end
+
+    def verify_voice
+      verify_voice_structure
+      verify_voice_style if self.voice[:style]
+    end
+
+    def verify_amount_class
+      raise ClientError.new("Invalid 'amount' value, must be a float") unless self.amount.is_a?(Float)
+    end
+
+    def verify_amount_value
+      raise ClientError.new("Invalid 'amount' value, must be greater than 0") unless self.amount > 0
+    end
+
+    def verify_prompts_structure
+      raise ClientError.new("Invalid 'prompt', must be an array of at least one hash") unless self.prompts.is_a?(Array) && !self.prompts.empty? && self.prompts.all?(Hash)
+    end
+
+    def verify_prompts_values
+      self.prompts.each do |prompt|
+        prompt_keys = prompt.keys
+        [:type, :text, :errors].each do |key|
+          raise ClientError.new("Invalid 'prompt', '#{key}' is required") unless prompt_keys.include?(key)
+        end
+      end
+    end
+
+    def verify_voice_structure
+      raise ClientError.new("Expected 'voice' value to be a Hash") unless self.voice.is_a?(Hash)
+    end
+
+    def verify_voice_style
+      raise ClientError.new("Expected 'style' value to be an Integer") unless self.voice[:style].is_a?(Integer)
+    end
+  end
+end

data/lib/vonage/voice/actions/record.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Voice::Actions::Record
-    attr_accessor :format, :split, :channels, :endOnSilence, :endOnKey, :timeOut, :beepStart, :eventUrl, :eventMethod, :transcription
+    attr_accessor :format, :split, :channels, :endOnSilence, :endOnKey, :timeOut, :beepStart, :eventUrl, :eventMethod
 
     def initialize(attributes = {})
       @format = attributes.fetch(:format, nil)
@@ -15,7 +15,6 @@ module Vonage
       @beepStart = attributes.fetch(:beepStart, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
-      @transcription = attributes.fetch(:transcription, nil)
 
       after_initialize!
     end
@@ -56,10 +55,6 @@ module Vonage
       if self.eventMethod
         validate_event_method
       end
-
-      if self.transcription
-        validate_transcription
-      end
     end
 
     def validate_format
@@ -95,13 +90,9 @@ module Vonage
     end
 
     def validate_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
+      uri = URI.parse(self.eventUrl)
 
-      uri = URI.parse(self.eventUrl[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
 
       self.eventUrl
     end
@@ -109,45 +100,7 @@ module Vonage
     def validate_event_method
       valid_methods = ['GET', 'POST']
 
-      raise ClientError.new("Invalid 'eventMethod' value. Must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
-    end
-
-    def validate_transcription
-      raise ClientError.new("Expected 'transcription' parameter to be a Hash") unless self.transcription.is_a?(Hash)
-
-      if self.transcription[:language]
-        raise ClientError.new("Invalid 'language' value, must be a String") unless self.transcription[:language].is_a?(String)
-      end
-
-      if self.transcription[:eventUrl]
-        event_url = self.transcription[:eventUrl]
-
-        unless event_url.is_a?(Array) && event_url.length == 1 && event_url[0].is_a?(String)
-          raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-        end
-
-        uri = URI.parse(event_url[0])
-
-        raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-      end
-
-      if self.transcription[:eventMethod]
-        event_method = self.transcription[:eventMethod]
-        raise ClientError.new("Invalid 'eventMethod' value, must be either: 'GET' or 'POST'") unless ['GET', 'POST'].include?(event_method.upcase)
-      end
-
-      if self.transcription[:sentimentAnalysis]
-        sentiment_analysis = self.transcription[:sentimentAnalysis]
-        raise ClientError.new("Invalid 'sentimentAnalysis' value, must be a Boolean") unless sentiment_analysis == true || sentiment_analysis == false
-      end
-
-      # if self.dtmf[:maxDigits]
-      #   raise ClientError.new("Expected 'maxDigits' to not be more than 22") if self.dtmf[:maxDigits] > 22
-      # end
-
-      # if self.dtmf[:submitOnHash]
-      #   raise ClientError.new("Invalid 'submitOnHash' value, must be a Boolean") unless self.dtmf[:submitOnHash] == true || self.dtmf[:submitOnHash] == false
-      # end
+      raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
     end
 
     def action
@@ -170,7 +123,6 @@ module Vonage
       ncco[0].merge!(beepStart: builder.beepStart) if builder.beepStart
       ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
       ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
-      ncco[0].merge!(transcription: builder.transcription) if builder.transcription
 
       ncco
     end

data/lib/vonage/voice/actions/stream.rb

@@ -3,16 +3,13 @@
 
 module Vonage
   class Voice::Actions::Stream
-    attr_accessor :streamUrl, :level, :bargeIn, :loop, :eventOnCompletion, :eventUrl, :eventMethod
+    attr_accessor :streamUrl, :level, :bargeIn, :loop
 
     def initialize(attributes = {})
       @streamUrl = attributes.fetch(:streamUrl)
       @level = attributes.fetch(:level, nil)
       @bargeIn = attributes.fetch(:bargeIn, nil)
       @loop = attributes.fetch(:loop, nil)
-      @eventOnCompletion = attributes.fetch(:eventOnCompletion, nil)
-      @eventUrl = attributes.fetch(:eventUrl, nil)
-      @eventMethod = attributes.fetch(:eventMethod, nil)
 
       after_initialize!
     end
@@ -31,28 +28,12 @@ module Vonage
       if self.loop
         verify_loop
       end
-
-      if self.eventOnCompletion || self.eventOnCompletion == false
-        verify_event_on_completion
-      end
-
-      if self.eventUrl
-        verify_event_url
-      end
-
-      if self.eventMethod
-        verify_event_method
-      end
     end
 
     def verify_stream_url
-      stream_url = self.streamUrl
-
-      unless stream_url.is_a?(Array) && stream_url.length == 1 && stream_url[0].is_a?(String)
-        raise ClientError.new("Expected 'streamUrl' parameter to be an Array containing a single string item")
-      end
+      raise ClientError.new("Expected 'streamUrl' parameter to be an Array containing a single string item") unless self.streamUrl.is_a?(Array)
 
-      uri = URI.parse(stream_url[0])
+      uri = URI.parse(self.streamUrl[0])
 
       raise ClientError.new("Invalid 'streamUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
     end
@@ -66,29 +47,7 @@ module Vonage
     end
 
     def verify_loop
-      raise ClientError.new("Expected 'loop' value to be either 0 or a positive integer") unless self.loop >= 0
-    end
-
-    def verify_event_on_completion
-      raise ClientError.new("Expected 'eventOnCompletion' value to be a Boolean") unless self.eventOnCompletion == true || self.eventOnCompletion == false
-    end
-
-    def verify_event_url
-      unless self.eventUrl.is_a?(Array) && self.eventUrl.length == 1 && self.eventUrl[0].is_a?(String)
-        raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item")
-      end
-
-      uri = URI.parse(self.eventUrl[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-
-      self.eventUrl
-    end
-
-    def verify_event_method
-      valid_methods = ['GET', 'POST']
-
-      raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
+      raise ClientError.new("Expected 'loop' value to be either 1 or 0") unless self.loop == 1 || self.loop == 0
     end
 
     def action
@@ -106,9 +65,6 @@ module Vonage
       ncco[0].merge!(level: builder.level) if builder.level
       ncco[0].merge!(bargeIn: builder.bargeIn) if (builder.bargeIn || builder.bargeIn == false)
       ncco[0].merge!(loop: builder.loop) if builder.loop
-      ncco[0].merge!(eventOnCompletion: builder.eventOnCompletion) if (builder.eventOnCompletion || builder.eventOnCompletion == false)
-      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
-      ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
 
       ncco
     end