vonage 7.32.0 → 8.0.0.beta

data/lib/vonage/video/renders.rb

@@ -1,107 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Video::Renders < Namespace
-    include Keys
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    self.host = :video_host
-
-    # Start an Experience Composer Render
-    #
-    # @example
-    #   response = client.video.renders.start(
-    #     session_id: "12312312-3811-4726-b508-e41a0f96c68f",
-    #     token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJp...",
-    #     url: 'https://example.com/',
-    #     max_duration: 1800,
-    #     resolution: '1280x720',
-    #     properties: {
-    #       name: 'foo'
-    #     }
-    #   )
-    #
-    # @params [required, String] :session_id The session ID of the Vonage Video session you are working with.
-    #
-    # @param [required, String] :token A valid OpenTok JWT token with a Publisher role and (optionally) connection data to be associated with the output stream.
-    #
-    # @params [required, String] :url A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
-    #
-    # @params [optional, Integer] :max_duration The maximum duration of the rendered video in seconds. 
-    #   - After this time, it is stopped automatically, if it is still running.
-    #     - Min: 60
-    #     - Max: 3600
-    #     - Default: 3600
-    #
-    # @params [optional, String] :resolution The resolution of the Experience Composer render.
-    #   - Must be one of: '640x480', '480x640', '1280x720', '720x1280', '1080x1920', '1920x1080'
-    #
-    # @params [optional, Hash] :properties The initial configuration of Publisher properties for the composed output stream.
-    # @option properties [required, String] :name The name of the composed output stream which is published to the session.
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def start(session_id:, token:, url:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/render',
-        params: camelcase(params.merge({sessionId: session_id, token: token, url: url})),
-        type: Post)
-    end
-
-    # Stop an Experience Composer render
-    #
-    # @example
-    #   response = client.video.renders.stop(experience_composer_id: "1248e7070b81464c9789f46ad10e7764")
-    #
-    # @params [required, String] :experience_composer_id ID of the Experience Composer instance that you want to stop.
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def stop(experience_composer_id:)
-      request('/v2/project/' + @config.application_id + '/render/' + experience_composer_id, type: Delete)
-    end
-
-    # Get information about an Experience Composer session 
-    #
-    # @example
-    #   response = client.video.renders.info(experience_composer_id: "1248e7070b81464c9789f46ad10e7764")
-    #
-    # @params [required, String] :experience_composer_id ID of the Experience Composer instance for which you are requesitng information.
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def info(experience_composer_id:)
-      request('/v2/project/' + @config.application_id + '/render/' + experience_composer_id)
-    end
-
-    # List all Experience Composer renders in an application 
-    #
-    # @example
-    #   response = client.video.renders.list
-    #
-    # @params [optional, Integer] :offset Specify the index offset of the first experience composer. 0 is offset of the most recently started render.
-    #
-    # @params [optional, Integer] :count Limit the number of experience composers to be returned.
-    #
-    # @return [Video::Renders::ListResponse]
-    #
-    # @see TODO: Add document link here
-    #
-    def list(**params)
-      path = '/v2/project/' + @config.application_id + '/render'
-      path += "?#{Params.encode(camelcase(params))}" unless params.empty?
-
-      request(path, response_class: ListResponse)
-    end
-  end
-end

data/lib/vonage/video/sip.rb

@@ -1,48 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Video::SIP < Namespace
-    include Keys
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    self.host = :video_host
-
-    # Initiate an outbound SIP call.
-    #
-    def dial(session_id:, token:, sip_uri:, **params)
-      request(
-        '/v2/project/' + @config.application_id + '/dial',
-        params: camelcase({
-          session_id: session_id,
-          token: token,
-          sip: params.merge({uri: sip_uri})
-          }),
-        type: Post
-      )
-    end
-
-    # Play DTMF tones into a SIP call.
-    #
-    def play_dtmf_to_session(session_id:, dtmf_digits:)
-      request(
-        '/v2/project/' + @config.application_id + '/session/' + session_id + '/play-dtmf',
-        params: {digits: dtmf_digits},
-        type: Post
-      )
-    end
-
-    # Play DMTF tones into a specific connection.
-    #
-    def play_dtmf_to_connection(session_id:, connection_id:, dtmf_digits:)
-      request(
-        '/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id + '/play-dtmf',
-        params: {digits: dtmf_digits},
-        type: Post
-      )
-    end
-  end
-end

data/lib/vonage/video/streams/list_response.rb

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

data/lib/vonage/video/web_socket.rb

@@ -1,62 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Video::WebSocket < Namespace
-    include Keys
-
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    self.host = :video_host
-
-    # Start an audio connector websocket connection 
-    #
-    # @example
-    #   response = client.video.web_socket.connect(
-    #    session_id: "12312312-3811-4726-b508-e41a0f96c68f",
-    #    token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJp...",
-    #    websocket: {
-    #       uri: 'wss://example.com/ws-endpoint',
-    #       streams: ["8b732909-0a06-46a2-8ea8-074e64d43422"],
-    #       headers: { property1: 'foo', property2: 'bar' },
-    #       audio_rate: 16000
-    #     }
-    #   )
-    #
-    # @params [required, String] :session_id The Vonage Video session ID that includes the Vonage Video streams you want to include in the WebSocket stream.
-    #   - The Audio Connector feature is only supported in routed sessions
-    #
-    # @param [required, String] :token A valid Vonage Video token for the Audio Connector connection to the Vonage Video Session.
-    #   - You can add additional data to the JWT to identify that the connection is the Audio Connector endpoint or for any other identifying data.
-    #
-    # @params [required, Hash] :websocket The WebSocket configuration for the Audio Connector connection.
-    # @option websocket [required, String] :uri A publicly reachable WebSocket URI to be used for the destination of the audio stream
-    # @option websocket [optional, String] :streams An array of stream IDs for the Vonage Video streams you want to include in the WebSocket audio.
-    #   - If you omit this property, all streams in the session will be included.
-    # @option websocket [optional, Hash] :headers An object of key-value pairs of headers to be sent to your WebSocket server with each message, with a maximum length of 512 bytes.
-    # @option websocket [optional, Integer] :audio_rate A number representing the audio sampling rate in Hz
-    #   - Must be one of: 8000, 16000
-    # @option websocket [optional, Boolean] :bidirectional Whether to send audio data from the WebSocket connection to a stream published in the session.
-    #
-    # @return [Response]
-    #
-    # @see TODO: Add document link here
-    #
-    def connect(session_id:, token:, websocket:)
-      raise ArgumentError, 'websocket must be a Hash' unless websocket.is_a?(Hash)
-      raise ArgumentError, 'websocket must contain a uri' unless websocket.key?(:uri)
-      
-      request(
-        '/v2/project/' + @config.application_id + '/connect',
-        params: {
-          sessionId: session_id,
-          token: token,
-          websocket: camelcase(websocket)
-        },
-        type: Post
-      )
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# typed: true
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Voice::Actions::Transfer
-    attr_accessor :conversation_id, :can_hear, :can_speak, :mute
-
-    def initialize(attributes = {})
-      @conversation_id = attributes.fetch(:conversation_id)
-      @can_hear = attributes.fetch(:can_hear, nil)
-      @can_speak = attributes.fetch(:can_speak, nil)
-      @mute = attributes.fetch(:mute, nil)
-
-      after_initialize!
-    end
-
-    def after_initialize!
-      validate_conversation_id
-      validate_can_hear if self.can_hear
-      validate_can_speak if self.can_speak
-      validate_mute if self.mute != nil
-    end
-
-    def validate_conversation_id
-      conversation_id = self.conversation_id
-
-      raise ClientError.new("Expected 'conversation_id' parameter to be a string") unless conversation_id.is_a?(String)
-
-      self.conversation_id
-    end
-
-    def validate_can_hear
-      can_hear = self.can_hear
-      unless can_hear.is_a?(Array) && can_hear.all? { |item| item.is_a?(String) }
-        raise ClientError.new("Expected 'can_hear' parameter to be an array of strings")
-      end
-
-      self.can_hear
-    end
-
-    def validate_can_speak
-      can_speak = self.can_speak
-      unless can_speak.is_a?(Array) && can_speak.all? { |item| item.is_a?(String) }
-        raise ClientError.new("Expected 'can_speak' parameter to be an array of strings")
-      end
-
-      self.can_speak
-    end
-
-    def validate_mute
-      mute = self.mute
-      unless [true, false].include?(mute)
-        raise ClientError.new("Expected 'mute' parameter to be a boolean")
-      end
-
-      if self.mute && self.can_speak
-        raise ClientError.new("The 'mute' parameter is not supported if 'can_speak' is also set")
-      end
-
-      self.mute
-    end
-
-    def action
-      create_transfer!(self)
-    end
-
-    def create_transfer!(builder)
-      ncco = [
-        {
-          action: 'transfer',
-          conversation_id: builder.conversation_id,
-        }
-      ]
-
-      ncco[0].merge!(canHear: builder.can_hear) if builder.can_hear
-      ncco[0].merge!(canSpeak: builder.can_speak) if builder.can_speak
-      ncco[0].merge!(mute: builder.mute) if builder.mute != nil
-
-      ncco
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# typed: true
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Voice::Actions::Wait
-    attr_accessor :timeout
-
-    def initialize(attributes = {})
-      @timeout = attributes.fetch(:timeout, nil)
-
-      after_initialize!
-    end
-
-    def after_initialize!
-      validate_timeout if self.timeout
-    end
-
-    def validate_timeout
-      timeout = self.timeout
-
-      raise ClientError.new("Expected 'timeout' parameter to be a number") unless timeout.is_a?(Numeric)
-
-      self.timeout
-    end
-
-    def action
-      create_wait!(self)
-    end
-
-    def create_wait!(builder)
-      ncco = [
-        {
-          action: 'wait'
-        }
-      ]
-
-      ncco[0].merge!(timeout: builder.timeout) if builder.timeout
-
-      ncco
-    end
-  end
-end