vonage 7.30.2 → 7.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5bce7c35b2c0a0924617583e6f8222f13bd1947d91466375562b3db16fc722
-  data.tar.gz: 7e7e035d5452fa74e748e0fc5af0c6032331d928032386402608af9b27e868ee
+  metadata.gz: 767237040504d75ff4f4e7966e2de52d44eb7b1be47470bb238cde32702892f7
+  data.tar.gz: 197f6d40f803f60acc37ea8a58dd96fae47666d86eb2b1c7eb1d17f9602b24bb
 SHA512:
-  metadata.gz: 5c5a81e7c5da2b37284df13a9e5ea645dd801f25311dccf1f0015db4441eb4aa314ea76c6d2f9c7565efb9ed3f9bc39a6b197281971f0ac71bcd12dcda76e5cf
-  data.tar.gz: f9de47b16b045eaee2168f375bcc866cae975ec3c4e1fb00083b47187e0b3bb2b10fa4c66402cbc8a1b7f2e05c122c39c389bda466b820d9e61791204078488e
+  metadata.gz: 07a15f1ae2b57f93ecd509a7d162594cd2e134ee79783ae21855d13c93f85886a3c78b797854c71640e10003275e669101e1cbc0c20e9cc39f031df7c01365b7
+  data.tar.gz: 8152d4eedc3109a26556fb8249fc192737624532b3b7906305b82587abd9be229dc23b797f05b4cf035cb2283a0f009f10db7227943fd58c62ac72c6d0ed71b9

data/lib/vonage/client.rb

@@ -71,7 +71,7 @@ module Vonage
     end
 
     # @return [Meetings]
-    #
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings)) }
     def meetings
       @meetings ||= T.let(Meetings.new(config), T.nilable(Vonage::Meetings))
@@ -113,7 +113,7 @@ module Vonage
     end
 
     # @return [NumberInsight2]
-    #
+    # @deprecated
     sig { returns(T.nilable(Vonage::NumberInsight2)) }
     def number_insight_2
       @number_insight_2 ||= T.let(NumberInsight2.new(config), T.nilable(Vonage::NumberInsight2))
@@ -134,7 +134,7 @@ module Vonage
     end
 
     # @return [ProactiveConnect]
-    #
+    # @deprecated
     sig { returns(T.nilable(Vonage::ProactiveConnect)) }
     def proactive_connect
       @proactive_connect ||= T.let(ProactiveConnect.new(config), T.nilable(Vonage::ProactiveConnect))

data/lib/vonage/keys.rb

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

data/lib/vonage/messaging/channels/mms.rb

@@ -2,7 +2,7 @@
 
 module Vonage
   class Messaging::Channels::MMS < Messaging::Message
-    MESSAGE_TYPES = ['image', 'vcard', 'audio', 'video']
+    MESSAGE_TYPES = ['text', 'image', 'vcard', 'audio', 'video', 'file', 'content'].freeze
 
     attr_reader :data
 
@@ -29,8 +29,16 @@ module Vonage
     end
 
     def verify_message
-      raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
-      raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
+      case type
+      when 'text'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a String") unless message.is_a? String
+      when 'content'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be an Array") unless message.is_a? Array
+        raise Vonage::ClientError.new("Invalid parameter content. `:message` must not be empty") if message.empty?
+      else
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
+        raise Vonage::ClientError.new("Missing parameter. `:message` must contain a `:url` key") unless message[:url]
+      end
     end
   end
 end

data/lib/vonage/messaging/channels/rcs.rb

@@ -2,7 +2,7 @@
 
 module Vonage
   class Messaging::Channels::RCS < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image', 'video', 'file', 'custom']
+    MESSAGE_TYPES = ['text', 'image', 'video', 'file', 'card', 'carousel', 'custom']
 
     attr_reader :data
 
@@ -32,7 +32,7 @@ module Vonage
       case type
       when 'text'
         raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a String") unless message.is_a? String
-      when 'custom'
+      when 'card', 'carousel', 'custom'
         raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
         raise Vonage::ClientError.new("Invalid parameter content. `:message` must not be empty") if message.empty?
       else

data/lib/vonage/number_insight.rb

@@ -3,6 +3,7 @@
 
 module Vonage
   class NumberInsight < Namespace
+    self.authentication = Basic
     # Provides basic number insight information about a number.
     #
     # @example

data/lib/vonage/number_insight_2.rb

@@ -9,25 +9,10 @@ module Vonage
 
     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
-    #
+   # @deprecated
     sig { params(type: String, phone: String, insights: T::Array[String]).returns(Vonage::Response) }
     def fraud_check(type:, phone:, insights:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       raise ArgumentError.new("`insights` must not be an empty") if insights.empty?
 
       request('/v2/ni', params: {type: type, phone: phone, insights: insights}, type: Post)

data/lib/vonage/sms.rb

@@ -66,6 +66,9 @@ module Vonage
     #   An optional string used to identify separate accounts using the SMS endpoint for billing purposes.
     #   To use this feature, please email [support@nexmo.com](mailto:support@nexmo.com).
     #
+    # @option params [String] :trusted_number
+    #   Setting this parameter to true overrides, on a per-message basis, any protections set up via Fraud Defender (Traffic Rules, SMS Burst Protection, AIT Protection).
+    #
     # @param [Hash] params
     #
     # @return [Response]

data/lib/vonage/version.rb

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

data/lib/vonage/video/archives.rb

@@ -59,7 +59,9 @@ module Vonage
     #
     # @param [optional, String] :multi_archive_tag
     #
-    # @param [optional, String] :max_bitrate
+    # @param [optional, Number] :max_bitrate
+    #
+    # @param [optional, Number] :quantization_parameter
     #
     # @param [optional, Hash] :layout
     #
@@ -69,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/web_socket.rb

@@ -38,6 +38,7 @@ module Vonage
     # @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]
     #

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,9 +65,11 @@ 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)
+        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])
+        raise ClientError.new("You must provide both `user` and `domain`") if (endpoint[:user] && !endpoint[:domain]) || (endpoint[:domain] && !endpoint[:user])
       end
     end
 
@@ -208,10 +210,12 @@ module Vonage
 
     def sip_endpoint(endpoint_attrs)
       hash = {
-        type: 'sip',
-        uri: endpoint_attrs[:uri]
+        type: 'sip'
       }
 
+      hash.merge!(uri: endpoint_attrs[:uri]) if endpoint_attrs[:uri]
+      hash.merge!(user: endpoint_attrs[:user]) if endpoint_attrs[:user]
+      hash.merge!(domain: endpoint_attrs[:domain]) if endpoint_attrs[:domain]
       hash.merge!(headers: endpoint_attrs[:headers]) if endpoint_attrs[:headers]
       hash.merge!(standardHeaders: endpoint_attrs[:standardHeaders]) if endpoint_attrs[:standardHeaders]
 

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

@@ -3,16 +3,13 @@
 
 module Vonage
   class Voice::Actions::Stream
-    attr_accessor :streamUrl, :level, :bargeIn, :loop, :eventOnCompletion, :eventUrl, :eventMethod
+    attr_accessor :streamUrl, :level, :bargeIn, :loop
 
     def initialize(attributes = {})
       @streamUrl = attributes.fetch(:streamUrl)
       @level = attributes.fetch(:level, nil)
       @bargeIn = attributes.fetch(:bargeIn, nil)
       @loop = attributes.fetch(:loop, nil)
-      @eventOnCompletion = attributes.fetch(:eventOnCompletion, nil)
-      @eventUrl = attributes.fetch(:eventUrl, nil)
-      @eventMethod = attributes.fetch(:eventMethod, nil)
 
       after_initialize!
     end
@@ -31,18 +28,6 @@ module Vonage
       if self.loop
         verify_loop
       end
-
-      if self.eventOnCompletion || self.eventOnCompletion == false
-        verify_event_on_completion
-      end
-
-      if self.eventUrl
-        verify_event_url
-      end
-
-      if self.eventMethod
-        verify_event_method
-      end
     end
 
     def verify_stream_url
@@ -69,28 +54,6 @@ module Vonage
       raise ClientError.new("Expected 'loop' value to be either 0 or a positive integer") unless self.loop >= 0
     end
 
-    def verify_event_on_completion
-      raise ClientError.new("Expected 'eventOnCompletion' value to be a Boolean") unless self.eventOnCompletion == true || self.eventOnCompletion == false
-    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])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-
-      self.eventUrl
-    end
-
-    def verify_event_method
-      valid_methods = ['GET', 'POST']
-
-      raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
-    end
-
     def action
       create_stream!(self)
     end
@@ -106,9 +69,6 @@ module Vonage
       ncco[0].merge!(level: builder.level) if builder.level
       ncco[0].merge!(bargeIn: builder.bargeIn) if (builder.bargeIn || builder.bargeIn == false)
       ncco[0].merge!(loop: builder.loop) if builder.loop
-      ncco[0].merge!(eventOnCompletion: builder.eventOnCompletion) if (builder.eventOnCompletion || builder.eventOnCompletion == false)
-      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
-      ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
 
       ncco
     end

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

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 module Vonage
   class Voice::Actions::Talk
-    attr_accessor :text, :bargeIn, :loop, :level, :language, :style, :premium, :eventOnCompletion, :eventUrl, :eventMethod
+    attr_accessor :text, :bargeIn, :loop, :level, :language, :style, :premium
 
     def initialize(attributes= {})
       @text = attributes.fetch(:text)
@@ -12,9 +12,6 @@ module Vonage
       @language = attributes.fetch(:language, nil)
       @style = attributes.fetch(:style, nil)
       @premium = attributes.fetch(:premium, nil)
-      @eventOnCompletion = attributes.fetch(:eventOnCompletion, nil)
-      @eventUrl = attributes.fetch(:eventUrl, nil)
-      @eventMethod = attributes.fetch(:eventMethod, nil)
 
       after_initialize!
     end
@@ -39,18 +36,6 @@ module Vonage
       if self.premium || self.premium == false
         verify_premium
       end
-
-      if self.eventOnCompletion || self.eventOnCompletion == false
-        verify_event_on_completion
-      end
-
-      if self.eventUrl
-        verify_event_url
-      end
-
-      if self.eventMethod
-        verify_event_method
-      end
     end
 
     def verify_barge_in
@@ -73,28 +58,6 @@ module Vonage
       raise ClientError.new("Expected 'premium' value to be a Boolean") unless self.premium == true || self.premium == false
     end
 
-    def verify_event_on_completion
-      raise ClientError.new("Expected 'eventOnCompletion' value to be a Boolean") unless self.eventOnCompletion == true || self.eventOnCompletion == false
-    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])
-
-      raise ClientError.new("Invalid 'eventUrl' value, array must contain a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-
-      self.eventUrl
-    end
-
-    def verify_event_method
-      valid_methods = ['GET', 'POST']
-
-      raise ClientError.new("Invalid 'eventMethod' value. must be either: 'GET' or 'POST'") unless valid_methods.include?(self.eventMethod.upcase)
-    end
-
     def action
       create_talk!(self)
     end
@@ -113,9 +76,6 @@ module Vonage
       ncco[0].merge!(language: builder.language) if builder.language
       ncco[0].merge!(style: builder.style) if builder.style
       ncco[0].merge!(premium: builder.premium) if (builder.bargeIn || builder.bargeIn == false)
-      ncco[0].merge!(eventOnCompletion: builder.eventOnCompletion) if (builder.eventOnCompletion || builder.eventOnCompletion == false)
-      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
-      ncco[0].merge!(eventMethod: builder.eventMethod) if builder.eventMethod
 
       ncco
     end

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.30.2
+  version: 7.32.0
 platform: ruby
 authors:
 - Vonage
@@ -250,6 +250,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 +268,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