vonage 7.8.2 → 7.36.0

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/api_error.rb

@@ -0,0 +1,33 @@
+# typed: strong
+require "json"
+
+module Vonage
+  class APIError < Error
+    extend T::Sig
+
+    sig { returns(Net::HTTPResponse) }
+    attr_reader :http_response
+
+    sig { params(message: T.nilable(String), http_response: T.nilable(Net::HTTPResponse)).void }
+    def initialize(message = nil, http_response: nil)
+      super(message)
+      @http_response = http_response
+    end
+
+    def http_response_code
+      return nil unless http_response
+      http_response.code
+    end
+
+    def http_response_headers
+      return nil unless http_response
+      http_response.to_hash
+    end
+
+    def http_response_body
+      return nil unless http_response
+      return {} unless http_response.content_type && http_response.content_type.include?("json")
+      ::JSON.parse(http_response.body)
+    end
+  end
+end

data/lib/vonage/applications.rb

@@ -33,6 +33,8 @@ module Vonage
     #
     #   response = client.applications.create(params)
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :name
     #   Application name.
     #
@@ -44,7 +46,9 @@ module Vonage
     #   This contains the configuration for each product.
     #   This replaces the application `type` from version 1 of the Application API.
     #
-    # @param [Hash] params
+    # @option params [Hash] :privacy
+    #   - **:improve_ai** (Boolean) If set to `true``, Vonage may store and use your content and data for the improvement
+    #      of Vonage's AI based services and technologies.
     #
     # @return [Response]
     #
@@ -73,7 +77,7 @@ module Vonage
     #   Set this to `false` to not auto-advance through all the pages in the record
     #   and collect all the data. The default is `true`.
     # @param [Hash] params
-    #  
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/application.v2#listApplication
@@ -109,6 +113,9 @@ module Vonage
     # @example
     #   response = client.applications.update(id, answer_method: 'POST')
     #
+    # @param [String] id
+    # @param [Hash] params
+    #
     # @option params [required, String] :name
     #   Application name.
     #
@@ -120,8 +127,9 @@ module Vonage
     #   This contains the configuration for each product.
     #   This replaces the application `type` from version 1 of the Application API.
     #
-    # @param [String] id
-    # @param [Hash] params
+    # @option params [Hash] :privacy
+    #   - **:improve_ai** (Boolean) If set to `true``, Vonage may store and use your content and data for the improvement
+    #      of Vonage's AI based services and technologies.
     #
     # @return [Response]
     #

data/lib/vonage/basic.rb

@@ -2,7 +2,7 @@
 
 module Vonage
   class Basic < AbstractAuthentication
-    def update(object)
+    def update(object, data)
       return unless object.is_a?(Net::HTTPRequest)
 
       object.basic_auth(@config.api_key, @config.api_secret)

data/lib/vonage/basic_and_bearer_token.rb

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class BasicAndBearerToken < AbstractAuthentication
+    def update(object, data)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      if @config.authentication_preference == :basic
+        object.basic_auth(@config.api_key, @config.api_secret)
+      else
+        object['Authorization'] = 'Bearer ' + @config.token
+      end
+    end
+  end
+
+  private_constant :BasicAndBearerToken
+end

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 :BasicAndSignature
+end

data/lib/vonage/bearer_token.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class BearerToken < AbstractAuthentication
-    def update(object)
+    def update(object, data)
       return unless object.is_a?(Net::HTTPRequest)
 
       object['Authorization'] = 'Bearer ' + @config.token

data/lib/vonage/client.rb

@@ -40,8 +40,17 @@ module Vonage
       @applications ||= T.let(Applications.new(config), T.nilable(Vonage::Applications))
     end
 
+    # @return [Conversation]
+    #
+    sig { returns(T.nilable(Vonage::Conversation)) }
+    def conversation
+      @conversation ||= T.let(Conversation.new(config), T.nilable(Vonage::Conversation))
+    end
+
     # @return [Conversations]
     #
+    # @deprecated Please use {#conversation} instead
+    #
     sig { returns(T.nilable(Vonage::Conversations)) }
     def conversations
       @conversations ||= T.let(Conversations.new(config), T.nilable(Vonage::Conversations))
@@ -61,6 +70,20 @@ module Vonage
       @files ||= T.let(Files.new(config), T.nilable(Vonage::Files))
     end
 
+    # @return [IdentityInsights]
+    #
+    sig { returns(T.nilable(Vonage::IdentityInsights)) }
+    def identity_insights
+      @identity_insights ||= T.let(IdentityInsights.new(config), T.nilable(Vonage::IdentityInsights))
+    end
+
+    # @return [Meetings]
+    # @deprecated
+    sig { returns(T.nilable(Vonage::Meetings)) }
+    def meetings
+      @meetings ||= T.let(Meetings.new(config), T.nilable(Vonage::Meetings))
+    end
+
     # @return [Messages]
     #
     sig { returns(T.nilable(Vonage::Messages)) }
@@ -75,6 +98,20 @@ module Vonage
       @messaging ||= T.let(Messaging.new(config), T.nilable(Vonage::Messaging))
     end
 
+    # @return [NetworkNumberVerification]
+    #
+    sig { returns(T.nilable(Vonage::NetworkNumberVerification)) }
+    def network_number_verification
+      @network_number_verification ||= T.let(NetworkNumberVerification.new(config), T.nilable(Vonage::NetworkNumberVerification))
+    end
+
+    # @return [NetworkSIMSwap]
+    #
+    sig { returns(T.nilable(Vonage::NetworkSIMSwap)) }
+    def network_sim_swap
+      @network_sim_swap ||= T.let(NetworkSIMSwap.new(config), T.nilable(Vonage::NetworkSIMSwap))
+    end
+
     # @return [NumberInsight]
     #
     sig { returns(T.nilable(Vonage::NumberInsight)) }
@@ -82,6 +119,13 @@ module Vonage
       @number_insight ||= T.let(NumberInsight.new(config), T.nilable(Vonage::NumberInsight))
     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))
+    end
+
     # @return [Numbers]
     #
     sig { returns(T.nilable(Vonage::Numbers)) }
@@ -96,6 +140,13 @@ module Vonage
       @pricing ||= T.let(PricingTypes.new(config), T.nilable(Vonage::PricingTypes))
     end
 
+    # @return [ProactiveConnect]
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect)) }
+    def proactive_connect
+      @proactive_connect ||= T.let(ProactiveConnect.new(config), T.nilable(Vonage::ProactiveConnect))
+    end
+
     # @return [Redact]
     #
     sig { returns(T.nilable(Vonage::Redact)) }
@@ -117,6 +168,13 @@ module Vonage
       @sms ||= T.let(SMS.new(config), T.nilable(Vonage::SMS))
     end
 
+    # @return [Subaccounts]
+    #
+    sig { returns(T.nilable(Vonage::Subaccounts)) }
+    def subaccounts
+      @subaccounts ||= T.let(Subaccounts.new(config), T.nilable(Vonage::Subaccounts))
+    end
+
     # @return [TFA]
     #
     sig { returns(T.nilable(Vonage::TFA)) }
@@ -124,6 +182,13 @@ module Vonage
       @tfa ||= T.let(TFA.new(config), T.nilable(Vonage::TFA))
     end
 
+    # @return [Users]
+    #
+    sig { returns(T.nilable(Vonage::Users)) }
+    def users
+      @users ||= T.let(Users.new(config), T.nilable(Vonage::Users))
+    end
+
     # @return [Verify]
     #
     sig { returns(T.nilable(Vonage::Verify)) }
@@ -131,6 +196,20 @@ module Vonage
       @verify ||= T.let(Verify.new(config), T.nilable(Vonage::Verify))
     end
 
+    # @return [Verify2]
+    #
+    sig { returns(T.nilable(Vonage::Verify2)) }
+    def verify2
+      @verify2 ||= T.let(Verify2.new(config), T.nilable(Vonage::Verify2))
+    end
+
+    # @return [Video]
+    #
+    sig { returns(T.nilable(Vonage::Video)) }
+    def video
+      @video ||= T.let(Video.new(config), T.nilable(Vonage::Video))
+    end
+
     # @return [Voice]
     #
     sig { returns(T.nilable(Vonage::Voice)) }

data/lib/vonage/client_error.rb

@@ -1,6 +1,6 @@
 # typed: strong
 
 module Vonage
-  class ClientError < Error
+  class ClientError < APIError
   end
 end

data/lib/vonage/config.rb

@@ -18,6 +18,8 @@ module Vonage
       self.signature_secret = ENV['VONAGE_SIGNATURE_SECRET']
       self.signature_method = ENV['VONAGE_SIGNATURE_METHOD'] || 'md5hash'
       self.token = T.let(nil, T.nilable(String))
+      self.video_host = 'video.api.vonage.com'
+      self.vonage_host = 'api-eu.vonage.com'
     end
 
     # Merges the config with the given options hash.
@@ -107,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]
@@ -129,7 +134,6 @@ module Vonage
 
     # @return [Vonage::Logger]
     #
-    sig { params(logger: T.nilable(T.any(::Logger, Vonage::Logger))).returns(T.nilable(Vonage::Logger)) }
     def logger=(logger)
       @logger = T.let(Logger.new(logger), T.nilable(Vonage::Logger))
     end
@@ -198,6 +202,12 @@ module Vonage
     sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :token
 
+    sig { returns(String) }
+    attr_accessor :video_host
+    
+    sig { returns(String) }
+    attr_accessor :vonage_host
+
     protected
 
     sig { params(name: Symbol, value: T.untyped).void }

data/lib/vonage/conversation/event/list_response.rb

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

data/lib/vonage/conversation/event.rb

@@ -0,0 +1,108 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation::Event < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # List conversation events
+    #
+    # @example
+    #   response = client.conversation.event.list(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to list events for
+    #
+    # @param [String] :start_id
+    #   The ID to start returning events at
+    #
+    # @param [String] :end_id
+    #   The ID to end returning events at
+    #
+    # @param [String] :event_type
+    #  The type of event to search for. Does not currently support custom events
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::Member::ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getEvents
+    #
+    def list(conversation_id:, **params)  
+      request("/v1/conversations/#{conversation_id}/events", params: params, response_class: ListResponse)
+    end
+
+    # Create an event
+    # @example
+    #   response = client.conversation.event.create(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     type: 'message',
+    #     body: {
+    #       message_type: 'text',
+    #       text: 'Hello World'
+    #     }
+    #   )  
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to create the event for
+    #
+    # @param [required, String] :type
+    #   Event type.
+    #
+    # @param [String] :from
+    #
+    # @option params [required, String] :from
+    #
+    # @param [Hash] :body
+    #   The body of the event. There are many possible properties depending on the event type and message_type
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#createEvent
+    #
+    def create(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/events", params: params, type: Post)
+    end
+
+    # Get details of a specific event
+    #
+    # @example
+    #   response = client.conversation.event.find(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', event_id: 1) 
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :event_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getEvent
+    #
+    def find(conversation_id:, event_id:)
+      request("/v1/conversations/#{conversation_id}/events/#{event_id}")
+    end
+
+    # Delete an event.
+    #
+    # @example
+    #   response = client.conversation.event.delete(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a', event_id: 1)
+    #
+    # @param [String] :conversation_id
+    #
+    # @param [String] :event_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#deleteEvent
+    #
+    def delete(conversation_id:, event_id:)
+      request("/v1/conversations/#{conversation_id}/events/#{event_id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/conversation/list_response.rb

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

data/lib/vonage/conversation/member/list_response.rb

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

data/lib/vonage/conversation/member.rb

@@ -0,0 +1,134 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Conversation::Member < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # List members of a conversation
+    #
+    # @example
+    #   response = client.conversation.member.list(conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a')
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation to list members for
+    #
+    # @param [Integer] :page_size
+    #   Return this amount of records in the response.
+    #
+    # @param ['asc', 'desc'] :order
+    #   Return the records in ascending or descending order.
+    #
+    # @param [String] :cursor
+    #   The cursor to start returning results from.
+    #
+    # @return [Conversation::Member::ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getMembers
+    #
+    def list(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members", params: params, response_class: ListResponse)
+    end
+
+    # Create a member.
+    #
+    # @example
+    #   response = client.conversation.member.create(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     user: {
+    #       id: 'USR-82e028d9-5201-4f1e-8188-604b2d3471ec'
+    #     }
+    #   )
+    #
+    # @param [required, String] :conversation_id The conversation_id of the conversation for which to create the member
+    #
+    # @param [String] :state Must be one of ['invited', 'joined']
+    #
+    # @param [Hash] :user (Either :id or :name is required)
+    #   - @option user [String] :id The user_id of the user to add to the conversation
+    #   - @option user [String] :name The name of the user to add to the conversation
+    #
+    # @param [Hash] :channel
+    #   - @option channel [required, String] :type The type of channel
+    #   - @option channel [Hash] :from
+    #     - @option from [String] :type
+    #     - @option from [String] :number
+    #     - @option from [String] :id
+    #   - @option channel [Hash] :to
+    #     - @option from [String] :type 
+    #     - @option from [String] :user
+    #     - @option from [String] :number
+    #     - @option from [String] :id
+    #
+    # @param [Hash] :media
+    #   - @option media [Boolean] :audio
+    #   - @option media [Hash] :audio_settings
+    #     - @option audio_settings [Boolean] :enabled
+    #     - @option audio_settings [Boolean] :earmuffed
+    #     - @option audio_settings [Boolean] :muted
+    #
+    # @param [String] :knocking_id
+    #
+    # @param [String] :member_id_inviting
+    #
+    # @param [String] :from
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#createMember
+    #
+    def create(conversation_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members", params: params, type: Post)
+    end
+
+    # Retrieve a member
+    #
+    # @example
+    #   response = client.conversation.member.find(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     member_id: 'MEM-63f61863-4a51-4f6b-86e1-46edebio0391'
+    #   )  
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :member_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#getMember
+    #
+    def find(conversation_id:, member_id:)   
+      request("/v1/conversations/#{conversation_id}/members/#{member_id}", response_class: Vonage::Response)
+    end
+
+    # Update a member
+    #
+    # @example
+    #   response = client.conversation.member.update(
+    #     conversation_id: 'CON-d66d47de-5bcb-4300-94f0-0c9d4b948e9a',
+    #     member_id: 'MEM-63f61863-4a51-4f6b-86e1-46edebio0391',
+    #     state: 'left'
+    #   )  
+    #
+    # @param [required, String] :conversation_id
+    #
+    # @param [required, String] :member_id
+    #
+    # @param [String] :state Must be one of ['joined', 'left']
+    #
+    # @param [String] :from
+    #
+    # @param [Hash] :reason
+    #  - @option reason [String] :code
+    #  - @option reason [String] :text
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/conversation#updateMember
+    #
+    def update(conversation_id:, member_id:, **params)
+      request("/v1/conversations/#{conversation_id}/members/#{member_id}", params: params, type: Patch)
+    end
+  end
+end

data/lib/vonage/conversation/user/conversations_list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Conversation::User::ConversationsListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.conversations.each { |item| yield item }
+  end
+end

data/lib/vonage/conversation/user/sessions_list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Conversation::User::SessionsListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.sessions.each { |item| yield item }
+  end
+end