vonage 7.21.0 → 7.25.0

data/lib/vonage/conversations/members.rb

@@ -9,6 +9,8 @@ module Vonage
 
     # Create a member.
     #
+    # @deprecated Please use {Vonage::Conversation::Member#create} instead
+    #
     # @option params [String] :action
     #   Invite or join a member to a conversation.
     #   Must be one of: `invite` or `join`.
@@ -40,11 +42,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#createMember
     #
     def create(conversation_id, params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Member#create` instead.')
       request('/beta/conversations/' + conversation_id + '/members', params: params, type: Post)
     end
 
     # List members.
     #
+    # @deprecated Please use {Vonage::Conversation::Member#list} instead
+    #
     # @param [String] conversation_id
     #
     # @option params [Boolean] :auto_advance
@@ -56,11 +61,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getMembers
     #
     def list(conversation_id, params = nil, auto_advance = true)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Member#list` instead.')
       request('/beta/conversations/' + conversation_id + '/members', params: params)
     end
 
     # Retrieve a member.
     #
+    # @deprecated Please use {Vonage::Conversation::Member#find} instead
+    #
     # @param [String] conversation_id
     # @param [String] member_id
     #
@@ -69,11 +77,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getMember
     #
     def get(conversation_id, member_id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Member#find` instead.')
       request('/beta/conversations/' + conversation_id + '/members/' + member_id)
     end
 
     # Update a member.
     #
+    # @deprecated Please use {Vonage::Conversation::Member#update} instead
+    #
     # @option params [String] :action
     #   Invite or join a member to a conversation.
     #
@@ -89,11 +100,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#updateMember
     #
     def update(conversation_id, member_id, params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation::Member#update` instead.')
       request('/beta/conversations/' + conversation_id + '/members/' + member_id, params: params, type: Put)
     end
 
     # Delete a member.
     #
+    # @deprecated
+    #
     # @param [String] conversation_id
     # @param [String] member_id
     #
@@ -102,6 +116,7 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#deleteMember
     #
     def delete(conversation_id, member_id)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request('/beta/conversations/' + conversation_id + '/members/' + member_id, type: Delete)
     end
   end

data/lib/vonage/conversations/users.rb

@@ -9,6 +9,8 @@ module Vonage
 
     # Create a user.
     #
+    # @deprecated Please use {Vonage::Users#create} instead
+    #
     # @option params [String] :name
     #   Unique name for a user.
     #
@@ -26,11 +28,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#createUser
     #
     def create(params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#create` instead.')
       request('/beta/users', params: params, type: Post)
     end
 
     # List users.
     #
+    # @deprecated Please use {Vonage::Users#list} instead
+    #
     # @option params [Boolean] :auto_advance
     #   Set this to `false` to not auto-advance through all the pages in the record
     #   and collect all the data. The default is `true`.
@@ -40,11 +45,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getUsers
     #
     def list(params = nil, auto_advance = true)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#list` instead.')
       request('/beta/users', params: params)
     end
 
     # Retrieve a user.
     #
+    # @deprecated Please use {Vonage::Users#find} instead
+    #
     # @param [String] id
     #
     # @return [Response]
@@ -52,11 +60,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#getUser
     #
     def get(id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#find` instead.')
       request('/beta/users/' + id)
     end
 
     # Update a user.
     #
+    # @deprecated Please use {Vonage::Users#update} instead
+    #
     # @option params [String] :name
     #   Unique name for a user.
     #
@@ -79,11 +90,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#updateUser
     #
     def update(id, params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#update` instead.')
       request('/beta/users/' + id, params: params, type: Put)
     end
 
     # Delete a user.
     #
+    # @deprecated Please use {Vonage::Users#delete} instead
+    #
     # @param [String] id
     #
     # @return [Response]
@@ -91,6 +105,7 @@ module Vonage
     # @see https://developer.nexmo.com/api/conversation#deleteUser
     #
     def delete(id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Users#delete` instead.')
       request('/beta/users/' + id, type: Delete)
     end
   end

data/lib/vonage/conversations.rb

@@ -11,6 +11,8 @@ module Vonage
 
     # Create a conversation.
     #
+    # @deprecated Please use {Vonage::Conversation#create} instead
+    #
     # @example
     #   response = client.conversations.create(name: 'Example Conversation', display_name: 'Example Display Name')
     #
@@ -37,11 +39,14 @@ module Vonage
     #
     sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
     def create(params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#create` instead.')
       request('/beta/conversations', params: params, type: Post)
     end
 
     # List all conversations associated with your application.
     #
+    # @deprecated Please use {Vonage::Conversation#list} instead
+    #
     # @example
     #   response = client.conversations.list
     #
@@ -71,6 +76,7 @@ module Vonage
     #
     sig { params(params: T.nilable(T::Hash[Symbol, T.untyped]), auto_advance: T::Boolean).returns(Vonage::Response) }
     def list(params = nil, auto_advance = true)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#list` instead.')
       if params && !params.key?(:auto_advance)
         params.merge!(auto_advance: true)
       end
@@ -80,6 +86,8 @@ module Vonage
 
     # Retrieve a conversation.
     #
+    # @deprecated Please use {Vonage::Conversation#find} instead
+    #
     # @example
     #   response = client.conversations.get(id)
     #
@@ -91,11 +99,14 @@ module Vonage
     #
     sig { params(id: String).returns(Vonage::Response) }
     def get(id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#find` instead.')
       request('/beta/conversations/' + id)
     end
   
     # Update a conversation.
     #
+    # @deprecated Please use {Vonage::Conversation#update} instead
+    #
     # @example
     #   response = client.conversations.update(id, display_name: 'Updated conversation')
     #
@@ -127,11 +138,14 @@ module Vonage
       params: T::Hash[Symbol, T.untyped]
     ).returns(Vonage::Response) }
     def update(id, params)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#update` instead.')
       request('/beta/conversations/' + id, params: params, type: Put)
     end
 
     # Delete a conversation.
     #
+    # @deprecated Please use {Vonage::Conversation#delete} instead
+    #
     # @example
     #   response = client.conversations.delete(id)
     #
@@ -143,11 +157,14 @@ module Vonage
     #
     sig { params(id: String).returns(Vonage::Response) }
     def delete(id)
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#delete` instead.')
       request('/beta/conversations/' + id, type: Delete)
     end
 
     # Record a conversation.
     #
+    # @deprecated
+    #
     # @example
     #   response = client.conversations.record(id, action: 'start')
     #
@@ -178,13 +195,17 @@ module Vonage
       params: T::Hash[Symbol, T.untyped]
     ).returns(Vonage::Response) }
     def record(id, params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request('/v1/conversations/' + id + '/record', params: params, type: Put)
     end
 
     # @return [Events]
     #
+    # @deprecated Please use {Vonage::Conversation#event} instead
+    #
     sig { returns(T.nilable(Vonage::Conversations::Events)) }
     def events
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#event` instead.')
       @events = T.let(@events, T.nilable(Vonage::Conversations::Events))
       @config = T.let(@config, T.nilable(Vonage::Config))
       @events ||= Events.new(@config)
@@ -192,24 +213,33 @@ module Vonage
 
     # @return [Legs]
     #
+    # @deprecated
+    #
     sig { returns(T.nilable(Vonage::Conversations::Legs)) }
     def legs
+      logger.info('This method is deprecated and will be removed in a future release.')
       @legs = T.let(@legs, T.nilable(Vonage::Conversations::Legs))
       @legs ||= Legs.new(@config)
     end
 
     # @return [Members]
     #
+    # @deprecated Please use {Vonage::Conversation#member} instead
+    #
     sig { returns(T.nilable(Vonage::Conversations::Members)) }
     def members
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#member` instead.')
       @members = T.let(@members, T.nilable(Vonage::Conversations::Members))
       @members ||= Members.new(@config)
     end
 
     # @return [Users]
     #
+    # @deprecated Please use {Vonage::Conversation#user} instead
+    #
     sig { returns(T.nilable(Vonage::Conversations::Users)) }
     def users
+      logger.info('This method is deprecated and will be removed in a future release. Please use `Vonage::Conversation#user` instead.')
       @users = T.let(@users, T.nilable(Vonage::Conversations::Users))
       @users ||= Users.new(@config)
     end

data/lib/vonage/keys.rb

@@ -29,7 +29,12 @@ module Vonage
         'screenshare_type',
         'session_id',
         'stream_mode',
-        'archive_mode'
+        'archive_mode',
+        'language_code',
+        'max_duration',
+        'partial_captions',
+        'status_callback_url',
+        'audio_rate'
       ]
       hash.transform_keys do |k|
         if exceptions.include?(k.to_s)

data/lib/vonage/messaging.rb

@@ -1,16 +1,21 @@
 # typed: true
 # frozen_string_literal: true
+require 'forwardable'
 
 module Vonage
   class Messaging < Namespace
+    extend Forwardable
+
     self.authentication = BearerToken
 
     self.request_body = JSON
 
+    def_delegators Message, *Message::CHANNELS.keys
+
     # Send a Message.
     #
     # @example
-    #   message = Vonage::Messaging::Message.sms(message: "Hello world!")
+    #   message = client.messaging.sms(message: "Hello world!")
     #   response = client.messaging.send(to: "447700900000", from: "447700900001", **message)
     #
     # @option params [required, String] :to
@@ -22,8 +27,8 @@ module Vonage
     #
     # @see https://developer.vonage.com/api/messages-olympus#SendMessage
     #
-    def send(params)
-      request('/v1/messages', params: params, type: Post)
+    def send(to:, from:, **message)
+      request('/v1/messages', params: {to: to, from: from, **message}, type: Post)
     end
 
     # Validate a JSON Web Token from a Messages API Webhook.

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

@@ -20,6 +20,7 @@ module Vonage
     end
 
     def from=(from)
+      validate_from(from)
       @from = from
     end
 
@@ -49,5 +50,14 @@ module Vonage
     private
 
     attr_writer :channel
+
+    def validate_from(from)
+      if from.match?(/\D/)
+        raise ArgumentError, "Invalid alpha-numeric 'from' value #{from}. Length must be between 3 and 11 characters." unless from.length.between?(3, 11)
+      else
+        raise ArgumentError, "Invalid numeric 'from' value #{from}. Length must be between 11 and 15 characters." unless from.length.between?(11, 15)
+        raise ArgumentError, "Invalid 'from' value #{from}. Expected to be in E.164 format" unless Phonelib.parse(from).valid?
+      end
+    end
   end
 end

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

@@ -7,10 +7,10 @@ module Vonage
 
     attr_reader :channel, :to, :from
 
-    def initialize(to:, from: nil)
+    def initialize(to:, from:)
       self.channel = 'whatsapp'
       self.to = to
-      self.from = from unless from.nil?
+      self.from = from
     end
 
     def to=(to)
@@ -19,6 +19,7 @@ module Vonage
     end
 
     def from=(from)
+      raise ArgumentError, "Invalid 'from' value #{from}. Length must be between 11 and 15 characters." unless from.length.between?(11, 15)
       raise ArgumentError, "Invalid 'from' value #{from}. Expected to be in E.164 format" unless Phonelib.parse(from.to_i).valid?
       @from = from
     end

data/lib/vonage/verify2.rb

@@ -17,6 +17,7 @@ module Vonage
     #   )
     #
     # @param [required, String] :brand The brand that is sending the verification request
+    #   - Must be between 1 and 16 characters in length
     #
     # @param [required, Array<Hash>] :workflow An array of hashes for channels in the workflow
     #
@@ -32,6 +33,8 @@ module Vonage
     # @see https://developer.vonage.com/en/api/verify.v2#newRequest
     #
     def start_verification(brand:, workflow:, **opts)
+      raise ArgumentError, ':brand must be a String' unless brand.is_a?(String)
+      raise ArgumentError, "Invalid 'brand' value #{brand}. Length must be between 1 and 16 characters." unless brand.length.between?(1, 16)
       raise ArgumentError, ':workflow must be an Array' unless workflow.is_a?(Array)
       raise ArgumentError, ':workflow must not be empty' if workflow.empty?
 
@@ -66,6 +69,10 @@ module Vonage
       request('/v2/verify/' + request_id, type: Delete)
     end
 
+    def next_workflow(request_id:)
+      request('/v2/verify/' + request_id + '/next-workflow', type: Post)
+    end
+
     # Instantiate a new Vonage::Verify2::StartVerificationOptions object
     #
     # @param [optional, Hash] opts the options for the verification request.

data/lib/vonage/version.rb

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

data/lib/vonage/video/captions.rb

@@ -0,0 +1,67 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Captions < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Start Live Captions for a Vonage Video stream
+    #
+    # @example
+    #   response = client.video.captions.start(
+    #     session_id: "12312312-3811-4726-b508-e41a0f96c68f",
+    #     token: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJp...",
+    #     language_code: 'en-US',
+    #     max_duration: 300,
+    #     partial_captions: false,
+    #     status_callback_url: 'https://example.com/captions/status'
+    #   )
+    #
+    # @params [required, String] :session_id The id of the session to start captions for
+    #
+    # @param [required, String] :token A valid Vonage Video token with role set to 'moderator'
+    #
+    # @params [optional, String] :language_code The BCP-47 code for a spoken language used on this call. The default value is "en-US"
+    #   - Must be one of: 'en-US', 'en-AU', 'en-GB', 'zh-CN', 'fr-FR', 'fr-CA', 'de-DE', 'hi-IN', 'it-IT', 'ja-JP', 'ko-KR', 'pt-BR', 'th-TH'
+    #
+    # @param [optional, Integer] :max_duration The maximum duration for the audio captioning, in seconds.
+    #   - The default value is 14,400 seconds (4 hours), the maximum duration allowed.
+    #   - The minimum value for maxDuration is 300 (300 seconds, or 5 minutes).
+    #
+    # @param [optional, Boolean] :partial_captions Whether to enable this to faster captioning (true, the default) at the cost of some degree of inaccuracies.
+    #
+    # @param [optional, String] :status_callback_url The URL to send the status of the captions to.
+    #
+    # @return [Response]
+    #
+    # @see TODO: Add document link here
+    #
+    def start(session_id:, token:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/captions',
+        params: camelcase(params.merge({sessionId: session_id, token: token})),
+        type: Post)
+    end
+
+    # Stop live captions for a session
+    #
+    # @example
+    #   response = client.video.captions.stop(captions_id: "7c0580fc-6274-4de5-a66f-d0648e8d3ac3")
+    #
+    # @params [required, String] :captions_id ID of the connection used for captions
+    #
+    # @return [Response]
+    #
+    # @see TODO: Add document link here
+    #
+    def stop(captions_id:)
+      request('/v2/project/' + @config.application_id + '/captions/' + captions_id + '/stop', type: Post)
+    end
+  end
+end

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

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

@@ -0,0 +1,107 @@
+# 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/web_socket.rb

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