vonage 7.31.0 → 7.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef9ba6a82f261b39300753a6a894de863fa511caeedbe4da526f19386310a5d
-  data.tar.gz: ecdb4a66e5ce1d811c9acaf65c87c6a7acf7c25ec547ae2be6f1089600088f45
+  metadata.gz: a5b786bdfd6a5142be34fe1400d4e1914b6d6d9ef4b7e15d10a56e88f9bb5250
+  data.tar.gz: 5768855f0b0d03e66222694234f257600fa65a4eaf07dc4c0b9ce36471b87807
 SHA512:
-  metadata.gz: 88e3b48ab6f91e84397bcf2ec1ec4d05303bdb54fb6a911a835b494bae537984779875975903a5ebd5ebfad10ac148da95c427785cd27fc6d701397df7ef9558
-  data.tar.gz: 2fafc180379722a799ba71eaf5d3bcd08e992298e9ccc4f7503d5a07033498cad34e9fa3bbf23e955a7618f36b31b8f9a18ca16dad94aa0bc684beb1db0a2e20
+  metadata.gz: 3596b7759e7dc20c08ea1a127d97519aff481011134db294ac81b01452700757055813b2905d32144ae1977d8daa1d7d391ef1378763360ca3443b117caf7e05
+  data.tar.gz: e4a089e502ded233cbfbc0c07a60ae5dffceae4e5c550556f377202b7a4cef3b1e42806c3901b81c1c9763a7dd884ae82e9e80e0ecb016e56d0e9bbaeadf7e3d

data/lib/vonage/account.rb

@@ -6,6 +6,8 @@ module Vonage
     extend T::Sig
     include Keys
 
+    self.authentication = Basic
+
     self.host = :rest_host
 
     # Retrieve your account balance.

data/lib/vonage/basic_and_signature.rb

@@ -0,0 +1,22 @@
+# typed: true
+
+module Vonage
+  class BasicAndSignature < AbstractAuthentication
+    def update(object, data)
+      if @config.authentication_preference == :signature
+        return unless object.is_a?(Hash)
+        
+        object['api_key'] = T.must(@config).api_key
+        object['timestamp'] =Time.now.to_i.to_s
+        signature = Signature.new(@config).generate(object)
+        object[:sig] = signature
+      else
+        return unless object.is_a?(Net::HTTPRequest)
+
+        object.basic_auth(@config.api_key, @config.api_secret)
+      end
+    end
+  end
+
+  private_constant :Basic
+end

data/lib/vonage/config.rb

@@ -109,6 +109,9 @@ module Vonage
     sig { returns(T.nilable(String)) }
     attr_accessor :app_version
 
+    sig { returns(T.nilable(Symbol)) }
+    attr_accessor :authentication_preference
+
     # Returns the value of attribute http.
     #
     # @return [Vonage::HTTP::Options]

data/lib/vonage/conversions.rb

@@ -6,6 +6,8 @@ module Vonage
     extend T::Sig
     include Keys
 
+    self.authentication = BasicAndSignature
+
     sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
     def track_sms(params)
       request('/conversions/sms', params: hyphenate(params), type: Post)

data/lib/vonage/keys.rb

@@ -41,7 +41,9 @@ module Vonage
         'hashed_phone_number',
         'max_age',
         'max_bitrate',
-        'quantization_parameter'
+        'quantization_parameter',
+        'has_transcription',
+        'transcription_properties'
       ]
       hash.transform_keys do |k|
         if exceptions.include?(k.to_s)

data/lib/vonage/signature.rb

@@ -10,6 +10,29 @@ module Vonage
       @config = config
     end
 
+    # Generate a request signature.
+    #
+    # @example
+    #   client = Vonage::Client.new
+    #   client.config.signature_secret = 'secret'
+    #   client.config.signature_method = 'sha512'
+    #   params = {
+    #     'api_key' => 'abc123',
+    #     'to' => '447900000000',
+    #     'from' => '447900000001',
+    #     'text' => 'Hello World',
+    #     'timestamp' => '1385047698'
+    #   }
+    #
+    #   sig = client.signature.generate(params)
+    #
+    # @param [Hash] params
+    #
+    # @see https://developer.nexmo.com/concepts/guides/signing-messages
+    def generate(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+      digest(params, signature_secret, signature_method)
+    end
+    
     # Check webhook request signature.
     #
     # @example
@@ -38,7 +61,7 @@ module Vonage
     private
 
     def digest(params, signature_secret, signature_method)
-      digest_string = params.sort.map { |k, v| "&#{k}=#{v.tr('&=', '_')}" }.join
+      digest_string = params.sort.map { |k, v| "&#{k}=#{v.to_s.tr('&=', '_')}" }.join
 
       case signature_method
       when 'md5', 'sha1', 'sha256', 'sha512'

data/lib/vonage/sms.rb

@@ -6,6 +6,8 @@ module Vonage
     extend T::Sig
     include Keys
 
+    self.authentication = BasicAndSignature
+
     self.host = :rest_host
 
     # Send an outbound SMS from your Vonage account.

data/lib/vonage/verify.rb

@@ -8,6 +8,8 @@ module Vonage
 
     private :http_request
 
+    self.authentication = Basic
+
     # Generate and send a PIN to your user.
     #
     # @note You can make a maximum of one Verify request per second.

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.31.0'
+  VERSION = '7.33.0'
 end

data/lib/vonage/video/archives.rb

@@ -71,6 +71,14 @@ module Vonage
     #
     # @option layout [optional, String] :screenshareType
     #
+    # @param [optional, Boolean] :has_transcription
+    #
+    # @param [optional, Hash] :transcription_properties
+    #
+    # @option transcription_properties [optional, String] :primaryLanguageCode
+    #
+    # @option transcription_properties [optional, Boolean] :hasSummary
+    #
     # @return [Response]
     #
     # @see TODO: add docs link

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

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

@@ -0,0 +1,29 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Connections < Namespace
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of connections 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(session_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection', response_class: ListResponse)
+    end
+  end
+end

data/lib/vonage/video.rb

@@ -107,6 +107,12 @@ module Vonage
       @streams ||= Streams.new(@config)
     end
 
+    # @return [Connections]
+    #
+    def connections
+      @connections ||= Connections.new(@config)
+    end
+
     # @return [Captions]
     #
     def captions

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

@@ -65,7 +65,7 @@ module Vonage
         raise ClientError.new("'user' must be defined") unless endpoint[:user]
       when 'websocket'
         raise ClientError.new("Expected 'uri' value to be a valid URI") unless URI.parse(endpoint[:uri]).kind_of?(URI::Generic)
-        raise ClientError.new("Expected 'content-type' parameter to be either 'audio/116;rate=16000' or 'audio/116;rate=8000") unless endpoint[:'content-type'] == 'audio/116;rate=16000' || endpoint[:'content-type'] == 'audio/116;rate=8000'
+        raise ClientError.new("Expected 'content-type' parameter to be either 'audio/l16;rate=16000', 'audio/l16;rate=8000', or 'audio/l16;rate=24000'") unless ['audio/l16;rate=16000', 'audio/l16;rate=8000', 'audio/l16;rate=24000'].include?(endpoint[:'content-type'])
       when 'sip'
         raise ClientError.new("Expected 'uri' value to be a valid URI") unless URI.parse(endpoint[:uri]).kind_of?(URI::Generic) if endpoint[:uri]
         raise ClientError.new("`uri` must not be combined with `user` and `domain`") if endpoint[:uri] && (endpoint[:user] || endpoint[:domain])

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

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

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

data/lib/vonage/voice/ncco.rb

@@ -10,7 +10,9 @@ module Vonage
       notify: Vonage::Voice::Actions::Notify,
       record: Vonage::Voice::Actions::Record,
       stream: Vonage::Voice::Actions::Stream,
-      talk: Vonage::Voice::Actions::Talk
+      talk: Vonage::Voice::Actions::Talk,
+      wait: Vonage::Voice::Actions::Wait,
+      transfer: Vonage::Voice::Actions::Transfer    
     }
 
     class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.31.0
+  version: 7.33.0
 platform: ruby
 authors:
 - Vonage
@@ -137,6 +137,7 @@ files:
 - lib/vonage/applications/list_response.rb
 - lib/vonage/authentication_error.rb
 - lib/vonage/basic.rb
+- lib/vonage/basic_and_signature.rb
 - lib/vonage/bearer_token.rb
 - lib/vonage/client.rb
 - lib/vonage/client_error.rb
@@ -250,6 +251,8 @@ files:
 - lib/vonage/video/broadcasts.rb
 - lib/vonage/video/broadcasts/list_response.rb
 - lib/vonage/video/captions.rb
+- lib/vonage/video/connections.rb
+- lib/vonage/video/connections/list_response.rb
 - lib/vonage/video/moderation.rb
 - lib/vonage/video/renders.rb
 - lib/vonage/video/renders/list_response.rb
@@ -266,6 +269,8 @@ files:
 - lib/vonage/voice/actions/record.rb
 - lib/vonage/voice/actions/stream.rb
 - lib/vonage/voice/actions/talk.rb
+- lib/vonage/voice/actions/transfer.rb
+- lib/vonage/voice/actions/wait.rb
 - lib/vonage/voice/dtmf.rb
 - lib/vonage/voice/list_response.rb
 - lib/vonage/voice/ncco.rb