vonage 7.23.0 → 7.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d57526fb0ed81a986a2125a5ed5ebdb3152160cc1666f263772aac023177b1
-  data.tar.gz: b71dc43bcf08ae0b7e5b5a1f788d918ed57d1037e31008e9bceb1bdd3ac16a2c
+  metadata.gz: dd59189827b061987ec3ef8e6b580ed7a0d5dba1513fd19a16bd01b223c64a88
+  data.tar.gz: beb8f428da0682a0a4342ecbde7e9ef0113137afa904ec4a70d1bc2d18ceae9c
 SHA512:
-  metadata.gz: bbfaf5dab47afb432987729162f803cc505f3359eb5fed530104e7c6877bd3e4ffadd0415ce2281004d6a160a6a26b0e18126edf16c204ec12661dd2448c8766
-  data.tar.gz: a1d2607e0a78ccad0e6239db088158a448d506fe93a18c838912e0fb53831729b4fe5d3b1472eb33d1fec67b166e3967adb76e95a7f7857b7945b30f6426e73f
+  metadata.gz: 7d2d13f1f765ad39173e55c8f029308bba5d4fade7a30458828dd4c2dcddb9c2f6207dca291e7497af744d70f85471cf46de4d86ad103b871963989c624285d8
+  data.tar.gz: 0ca1d89cea36c1e71fe136b86b83de92b7d719fc06c4559caef3b5393df20c40155e28a0666b126382694bbdf8d4a544a784a5844f22311b939c6cde7d2f682d

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

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.23.0'
+  VERSION = '7.24.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

data/lib/vonage/video.rb

@@ -54,6 +54,9 @@ module Vonage
     end
 
     def generate_client_token(session_id:, scope: 'session.connect', role: 'publisher', **params)
+      valid_roles = %w[publisher subscriber moderator publisheronly]
+      raise ArgumentError, "Invalid role: #{role}" unless valid_roles.include?(role)
+
       claims = {
         application_id: @config.application_id,
         scope: scope,
@@ -104,6 +107,22 @@ module Vonage
       @streams ||= Streams.new(@config)
     end
 
+    # @return [Captions]
+    #
+    def captions
+      @captions ||= Captions.new(@config)
+    end
+
+    # @return [Renders]
+    #
+    def renders
+      @renders ||= Renders.new(@config)
+    end
 
+    # @return [WebSocket]
+    #
+    def web_socket
+      @web_socket ||= WebSocket.new(@config)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.23.0
+  version: 7.24.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -240,11 +240,15 @@ files:
 - lib/vonage/video/archives/list_response.rb
 - lib/vonage/video/broadcasts.rb
 - lib/vonage/video/broadcasts/list_response.rb
+- lib/vonage/video/captions.rb
 - lib/vonage/video/moderation.rb
+- lib/vonage/video/renders.rb
+- lib/vonage/video/renders/list_response.rb
 - lib/vonage/video/signals.rb
 - lib/vonage/video/sip.rb
 - lib/vonage/video/streams.rb
 - lib/vonage/video/streams/list_response.rb
+- lib/vonage/video/web_socket.rb
 - lib/vonage/voice.rb
 - lib/vonage/voice/actions/connect.rb
 - lib/vonage/voice/actions/conversation.rb