vonage 7.17.0 → 7.19.0

data/lib/vonage/number_insight_2.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class NumberInsight2 < Namespace
+    extend T::Sig
+
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    # Make fraud check requests with a phone number by looking up fraud score and/or by checking sim swap status.
+    #
+    # @example
+    #   response = client.number_insight_2.fraud_check(type: 'phone', phone: '447900000000', insights: ['fraud_score'])
+    #
+    # @param [required, String] :type The type of number to check.
+    #   Accepted value is “phone” when a phone number is provided.
+    #
+    # @param [required, String] :phone A single phone number that you need insight about in the E.164 format.
+    #
+    # @param [required, Array] :insights An array of strings indicating the fraud check insights required for the number.
+    #   Must be least one of: `fraud_score`, `sim_swap`
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/number-insight.v2#fraud_check
+    #
+    sig { params(type: String, phone: String, insights: T::Array[String]).returns(Vonage::Response) }
+    def fraud_check(type:, phone:, insights:)
+      raise ArgumentError.new("`insights` must not be an empty") if insights.empty?
+
+      request('/v2/ni', params: {type: type, phone: phone, insights: insights}, type: Post)
+    end
+  end
+end

data/lib/vonage/signature.rb

@@ -27,24 +27,24 @@ module Vonage
     #
     # @see https://developer.nexmo.com/concepts/guides/signing-messages
     #
-    def check(params, signature_method: @config.signature_method)
+    def check(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
       params = params.dup
 
       signature = params.delete('sig')
 
-      ::JWT::Algos::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_method))
+      ::JWT::Algos::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_secret, signature_method))
     end
 
     private
 
-    def digest(params, signature_method)
+    def digest(params, signature_secret, signature_method)
       digest_string = params.sort.map { |k, v| "&#{k}=#{v.tr('&=', '_')}" }.join
 
       case signature_method
       when 'md5', 'sha1', 'sha256', 'sha512'
-        OpenSSL::HMAC.hexdigest(signature_method, @config.signature_secret, digest_string).upcase
+        OpenSSL::HMAC.hexdigest(signature_method, signature_secret, digest_string).upcase
       when 'md5hash'
-        Digest::MD5.hexdigest("#{digest_string}#{@config.signature_secret}")
+        Digest::MD5.hexdigest("#{digest_string}#{signature_secret}")
       else
         raise ArgumentError, "Unknown signature algorithm: #{signature_method}. Expected: md5hash, md5, sha1, sha256, or sha512."
       end

data/lib/vonage/sms.rb

@@ -91,11 +91,31 @@ module Vonage
       response
     end
 
+    # Validate a Signature from an SMS API Webhook.
+    #
+    # @param [Hash, required] :webhook_params The parameters from the webhook request body
+    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
+    #   is set in `Config`
+    # @param [String, optional] :signature_method The account signature method. Required, unless `signature_method`
+    #   is set in `Config`
+    #
+    # @return [Boolean] true, if the JWT is verified, false otherwise
+    def verify_webhook_sig(webhook_params:, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+      signature.check(webhook_params, signature_secret: signature_secret, signature_method: signature_method)
+    end
+
     private
 
     sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
       !Vonage::GSM7.encoded?(text)
     end
+
+    # @return [Signature]
+    #
+    sig { returns(T.nilable(Vonage::Signature)) }
+    def signature
+      @signature ||= T.let(Signature.new(@config), T.nilable(Vonage::Signature))
+    end
   end
 end

data/lib/vonage/verify2/channels/email.rb

@@ -10,16 +10,14 @@ module Vonage
     def initialize(to:, from: nil)
       self.channel = 'email'
       self.to = to
-      self.from = from if from
+      self.from = from unless from.nil?
     end
 
     def to=(to)
-      # TODO: add validation
       @to = to
     end
 
     def from=(from)
-      # TODO: add validation
       @from = from
     end
 

data/lib/vonage/verify2/channels/silent_auth.rb

@@ -1,15 +1,18 @@
 # typed: true
 # frozen_string_literal: true
 require 'phonelib'
+require 'uri'
 
 module Vonage
   class Verify2::Channels::SilentAuth
 
-    attr_reader :channel, :to
+    attr_reader :channel, :to, :sandbox, :redirect_url
 
-    def initialize(to:)
+    def initialize(to:, redirect_url: nil, sandbox: nil)
       self.channel = 'silent_auth'
       self.to = to
+      self.redirect_url = redirect_url unless redirect_url.nil?
+      self.sandbox = sandbox unless sandbox.nil?
     end
 
     def to=(to)
@@ -17,6 +20,16 @@ module Vonage
       @to = to
     end
 
+    def redirect_url=(redirect_url)
+      raise ArgumentError, "Invalid 'to' value #{redirect_url}. Expected to be a valid URL" unless URI.parse(redirect_url).is_a?(URI::HTTP)
+      @redirect_url = redirect_url
+    end
+
+    def sandbox=(sandbox)
+      raise ArgumentError, "Invalid 'sandbox' value #{sandbox}. Expected to be boolean value" unless [true, false].include? sandbox
+      @sandbox = sandbox
+    end
+
     def to_h
       hash = Hash.new
       self.instance_variables.each do |ivar|

data/lib/vonage/verify2/channels/sms.rb

@@ -11,7 +11,7 @@ module Vonage
     def initialize(to:, app_hash: nil)
       self.channel = 'sms'
       self.to = to
-      self.app_hash = app_hash if app_hash
+      self.app_hash = app_hash unless app_hash.nil?
     end
 
     def to=(to)

data/lib/vonage/verify2/channels/whats_app.rb

@@ -10,7 +10,7 @@ module Vonage
     def initialize(to:, from: nil)
       self.channel = 'whatsapp'
       self.to = to
-      self.from = from if from
+      self.from = from unless from.nil?
     end
 
     def to=(to)

data/lib/vonage/verify2.rb

@@ -10,7 +10,7 @@ module Vonage
     # Request a verification be sent to a user.
     #
     # @example
-    #   verification_request = verify.start_verification(
+    #   verification_request = client.verify2.start_verification(
     #     brand: 'Acme',
     #     workflow: [{channel: 'sms', to: '447000000000'}],
     #     code_length: 6
@@ -41,7 +41,7 @@ module Vonage
     # Check a supplied code against a request to see if it is valid.
     #
     # @example
-    #   code_check = verify.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
+    #   code_check = client.verify2.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
     #
     # @param [required, String] :request_id The request_id of the verification request being checked
     #
@@ -56,7 +56,7 @@ module Vonage
     # Cancel a verifiction. If a verification request is still active, calling this method aborts the workflow.
     #
     # @example
-    #   verify.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
+    #   client.verify2.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
     #
     # @param [required, String] :request_id The request_id of the verification request to be cancelled
     #

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = "7.17.0"
+  VERSION = '7.19.0'
 end

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

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Video::Archives::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/archives.rb

@@ -0,0 +1,152 @@
+# 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, 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(**params)
+      request('/v2/project/' + @config.application_id + '/archive', params: params, response_class: ListResponse)
+    end
+
+    # Return information for specified archive.
+    #
+    # @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)
+    end
+
+    # Create a new archive.
+    #
+    # @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(session_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive', params: camelcase(params.merge(session_id: session_id)), type: Post)
+    end
+
+    # Stop recording a specified archive.
+    #
+    # @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)
+    end
+
+    # Delete a specified archive.
+    #
+    # @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)
+    end
+
+    # Add a stream to a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] stream_id 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(archive_id:, stream_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: camelcase(params.merge(addStream: stream_id)), type: Patch)
+    end
+
+    # Remove a stream from a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] stream_id 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)
+    end
+
+    # Change the layout of a composed archive while it is being recorded.
+    #
+    # @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(archive_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Video::Broadcasts::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/broadcasts.rb

@@ -0,0 +1,75 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Broadcasts < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of live streaming broadcasts for a specified Vonage application.
+    #
+    def list(**params)
+      path = '/v2/project/' + @config.application_id + '/broadcast'
+      path += "?#{Params.encode(camelcase(params))}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+
+    # Return information for specified broadcast.
+    #
+    def info(broadcast_id:)
+      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id)
+    end
+
+    # Start a new live streaming broadcast.
+    #
+    def start(session_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast',
+        params: camelcase(params.merge(session_id: session_id)),
+        type: Post
+      )
+    end
+
+    # Stop a specified broadcast.
+    #
+    def stop(broadcast_id:)
+      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/stop', type: Post)
+    end
+
+    # Add a stream to a live streaming broadcast.
+    #
+
+    def add_stream(broadcast_id:, stream_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
+        params: camelcase(params.merge(addStream: stream_id)),
+        type: Patch
+      )
+    end
+
+    # Remove a stream from a live streaming broadcast.
+    #
+    def remove_stream(broadcast_id:, stream_id:)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
+        params: {removeStream: stream_id},
+        type: Patch
+      )
+    end
+
+    # Dynamically change layout of a broadcast.
+    #
+    def change_layout(broadcast_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/layout',
+        params: camelcase(params),
+        type: Put)
+    end
+  end
+end

data/lib/vonage/video/moderation.rb

@@ -0,0 +1,58 @@
+# 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 [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(session_id:, connection_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
+    end
+
+    # Force mute a specific publisher stream in a session.
+    #
+    # @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(session_id:, stream_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
+    end
+
+    # Force mute all publisher stream for a specific session.
+    #
+    # @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(session_id:, **params)
+      request('/v2/project/' + @config.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,50 @@
+# 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(session_id:, connection_id:, **params)
+      request('/v2/project/' + @config.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(session_id:, **params)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/signal', params: params, type: Post)
+    end
+  end
+end

data/lib/vonage/video/sip.rb

@@ -0,0 +1,48 @@
+# 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

@@ -0,0 +1,11 @@
+# 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