vonage 7.18.0 → 8.0.0.beta

data/lib/vonage/video/archives.rb

@@ -0,0 +1,187 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Archives < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of archives for a specified Vonage application.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [optional, Integer] :offset
+    #
+    # @param [optional, Integer] :count
+    #
+    # @param [optional, String] :session_id
+    #
+    # TODO: add auto_advance option
+    #
+    # @return [ListResponse]
+    #
+    # @see TODO: add docs link
+    #
+    def list(application_id: @config.application_id, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive', params: params, response_class: Video::ListResponse)
+    end
+
+    # Return information for specified archive.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def info(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id)
+    end
+
+    # Create a new archive.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [optional, String] :hasAudio
+    #
+    # @param [optional, String] :hasVideo
+    #
+    # @param [optional, String] :name
+    #
+    # @param [optional, String] :outputMode
+    #
+    # @param [optional, String] :resolution
+    #
+    # @param [optional, String] :streamMode
+    #
+    # @param [optional, String] :multiArchiveTag
+    #
+    # @param [optional, Hash] :layout
+    #
+    # @option layout [optional, String] :type
+    #
+    # @option layout [optional, String] :stylesheet
+    #
+    # @option layout [optional, String] :screenshareType
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def start(application_id: @config.application_id, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if session_id is nil
+
+      request('/v2/project/' + application_id + '/archive', params: params, type: Post)
+    end
+
+    # Stop recording a specified archive.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def stop(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/stop', type: Post)
+    end
+
+    # Delete a specified archive.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def delete(application_id: @config.application_id, archive_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id, type: Delete)
+    end
+
+    # Add a stream to a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] add_stream The ID of the stream to be added
+    #
+    # @param [optional, Boolean] has_audio
+    #
+    # @param [optional, Boolean] has_video
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def add_stream(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if add_stream is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/streams', params: camelcase(params), type: Patch)
+    end
+
+    # Remove a stream from a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] remove_stream The ID of the stream to be removed
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def remove_stream(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: raise error if remove_stream is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/streams', params: camelcase(params), type: Patch)
+    end
+
+    # Change the layout of a composed archive while it is being recorded.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [optional, String] type
+    #
+    # @param [optional, String] stylesheet
+    #
+    # @param [optional, String] screenshare_type
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def change_layout(application_id: @config.application_id, archive_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
+    end
+  end
+end

data/lib/vonage/video/list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Video::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.calls.each { |item| yield item }
+  end
+end

data/lib/vonage/video/moderation.rb

@@ -0,0 +1,73 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Moderation < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Force a client to disconnect from a session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :connection_id The connection ID of the specific participant to be disconnected from the session.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def force_disconnect(application_id: @config.application_id, session_id:, connection_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
+    end
+
+    # Force mute a specific publisher stream in a session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :stream_id The stream ID of the specific stream to be muted.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def mute_single_stream(application_id: @config.application_id, session_id:, stream_id:)
+      application_id ||= @config.application_id
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
+    end
+
+    # Force mute all publisher stream for a specific session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :active
+    #
+    # @param [required, Array<String>] :excludedStreamIds 
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def mute_multiple_streams(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO: camelcase params
+      
+      request('/v2/project/' + application_id + '/session/' + session_id + '/mute', params: params, type: Post)
+    end
+
+    # TODO: add disable_force_mute ??
+  end
+end
+  

data/lib/vonage/video/signals.rb

@@ -0,0 +1,55 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Signals < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Send a signal to a specific participant in an active Vonage Video session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :connection_id The connection ID of the specific participant.
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def send_to_one(application_id: @config.application_id, session_id:, connection_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/connection/' + connection_id + '/signal', params: params, type: Post)
+    end
+
+    # Send a signal to all participants in an active Vonage Video session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def send_to_all(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/signal', params: params, type: Post)
+    end
+  end
+end
+  

data/lib/vonage/video/streams.rb

@@ -0,0 +1,76 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Streams < Namespace
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of streams for a specified session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # TODO: add auto_advance option
+    #
+    # @return [ListResponse]
+    #
+    # @see TODO: add docs link
+    #
+    def list(application_id: @config.application_id, session_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream', response_class: Video::ListResponse)
+    end
+
+    # Get information about a specified stream.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :stream_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def info(application_id: @config.application_id, session_id:, stream_id:)
+      # TODO: raise error if application_id is nil
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream/' + stream_id)
+    end
+
+    # Change the layout for a list of specified streams.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [optional, Array<Hash>] :items An array of hashes representing streams and the layout classes for those streams
+    #
+    # @option items [required, String] :id The stream ID
+    #
+    # @option items [required, Array<String>] :layoutClassList Array of CSS class names as strings
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def change_layout(application_id: @config.application_id, session_id:, **params)
+      # TODO: raise error if application_id is nil
+      # TODO camelcase layout_class_list
+      # if params[:items]
+      #   params[:items] = params[:items].map {|item| camelcase(item)}
+      # end
+
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream', params: params, type: Put)
+    end
+  end
+end
+  

data/lib/vonage/video.rb

@@ -0,0 +1,91 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video < Namespace
+    include Keys
+    
+    self.authentication = BearerToken
+
+    self.host = :video_host
+
+    # Generate a new session.
+    #
+    # @example
+    #   session = client.video.create_session({
+    #     archive_mode: 'always',
+    #     location: '10.1.200.30',
+    #     media_mode: 'routed'
+    #   })
+    #
+    # @params [optional, String] :archive_mode (either 'always' or 'manual')
+    #
+    # @param [optional, String] :location
+    #
+    # @params [optional, String] :media_mode (either 'routed' or 'relayed')
+    #
+    # @return [Response]
+    #
+    # @see TODO: Add document link here
+    #
+    def create_session(**params)
+      request_params = params.clone
+      request_params[:archive_mode] ||= 'manual' 
+      media_mode = request_params.delete(:media_mode) || 'routed'
+
+      if media_mode == 'relayed' && request_params[:archive_mode] == 'manual'
+        request_params['p2p.preference'] = 'enabled'
+      else
+        request_params['p2p.preference'] = 'disabled'
+      end
+
+      response = request('/session/create', params: camelcase(request_params), type: Post)
+
+      public_response_data = {
+        session_id: response.entity[:session_id],
+        archive_mode: request_params[:archive_mode],
+        media_mode: media_mode,
+        location: request_params[:location]
+      }
+
+      entity = Entity.new(public_response_data)
+
+      response.class.new(entity, response.http_response)
+    end
+
+    def generate_client_token(session_id:, scope: 'session.connect', role: 'publisher', **params)
+      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]
+
+      JWT.generate(claims, @config.private_key)
+    end
+
+    # @return [Streams]
+    #
+    def streams
+      @streams ||= Streams.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def archives
+      @archives ||= Archives.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def moderation
+      @moderation ||= Moderation.new(@config)
+    end
+
+    # @return [Archives]
+    #
+    def signals
+      @signals ||= Signals.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,25 +82,6 @@ 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
       uri = URI.parse(self.eventUrl)
 
@@ -220,4 +196,4 @@ module Vonage
       }
     end
   end
-end
+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