vonage 7.30.0 → 8.0.0.beta

data/lib/vonage/video/archives.rb

@@ -13,6 +13,8 @@ module Vonage
 
     # 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
@@ -25,41 +27,47 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def list(**params)
-      request('/v2/project/' + @config.application_id + '/archive', params: params, response_class: ListResponse)
+    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(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id)
+    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] :has_audio
+    # @param [optional, String] :hasAudio
     #
-    # @param [optional, String] :has_video
+    # @param [optional, String] :hasVideo
     #
     # @param [optional, String] :name
     #
-    # @param [optional, String] :output_mode
+    # @param [optional, String] :outputMode
     #
     # @param [optional, String] :resolution
     #
-    # @param [optional, String] :stream_mode
+    # @param [optional, String] :streamMode
     #
-    # @param [optional, String] :multi_archive_tag
-    #
-    # @param [optional, String] :max_bitrate
+    # @param [optional, String] :multiArchiveTag
     #
     # @param [optional, Hash] :layout
     #
@@ -73,39 +81,52 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def start(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive', params: camelcase(params.merge(session_id: session_id)), type: Post)
+    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(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/stop', type: Post)
+    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(archive_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id, type: Delete)
+    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] stream_id The ID of the stream to be added
+    # @param [required, String] add_stream The ID of the stream to be added
     #
     # @param [optional, Boolean] has_audio
     #
@@ -115,26 +136,36 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def add_stream(archive_id:, stream_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: camelcase(params.merge(addStream: stream_id)), type: Patch)
+    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] stream_id The ID of the stream to be removed
+    # @param [required, String] remove_stream The ID of the stream to be removed
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def remove_stream(archive_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: {removeStream: stream_id}, type: Patch)
+    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
@@ -147,8 +178,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def change_layout(archive_id:, **params)
-      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
+    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

@@ -11,6 +11,8 @@ module Vonage
 
     # 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.
@@ -19,12 +21,16 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def force_disconnect(session_id:, connection_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
+    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.
@@ -33,26 +39,35 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def mute_single_stream(session_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
+    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
+    # @param [required, Array<String>] :excludedStreamIds 
     #
     # @return [Response]
     #
     # @see TODO: add docs link
     #
-    def mute_multiple_streams(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/mute', params: params, type: Post)
+    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

@@ -25,8 +25,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def send_to_one(session_id:, connection_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id + '/signal', params: params, type: Post)
+    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.
@@ -43,8 +45,11 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def send_to_all(session_id:, **params)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/signal', params: params, type: Post)
+    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

@@ -22,8 +22,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def list(session_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream', response_class: ListResponse)
+    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.
@@ -38,8 +40,10 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def info(session_id:, stream_id:)
-      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id)
+    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.
@@ -58,13 +62,15 @@ module Vonage
     #
     # @see TODO: add docs link
     #
-    def change_layout(session_id:, **params)
+    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/' + @config.application_id + '/session/' + session_id + '/stream', params: params, type: Put)
+      request('/v2/project/' + application_id + '/session/' + session_id + '/stream', params: params, type: Put)
     end
   end
 end
+  

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