vonage 7.18.0 → 7.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1efb8423ce5ccb2549f6f3d65ddc659ab8c28a965888372b06845911b3e598ff
-  data.tar.gz: 4bc50573bada4e41fa89bb63ea02633435426f482722caafd10a904ca7a6b3ea
+  metadata.gz: 748a3a579f5c7c4a263b7b840234b0489e7b895e63d43d939f01bdc177616a53
+  data.tar.gz: 6e2b5d3d0a8135aff72a1314c33a833c1a77384f7a6047e6147c013e29e6ea45
 SHA512:
-  metadata.gz: 296c28e8d4a3f469f938ee2b5cad316a6e3a08696fbce2d17b8afcc3abac5a6d135be9acdb589f3ca4ab73d3ff25d77d37d1457d774bc1149043c6684c0387a4
-  data.tar.gz: 2cea85e954c16bd217efad49454183a68aac48aabb4d995eb1db5376902ff1fe13e296867ffadea0695c8586b6bc06e953004894e35cb487701a8327073315ec
+  metadata.gz: 913f6f7f81f667513740f61849db751dfdd9dc60ca6366c81b6e621564e53719f3503a5085ed38f7c48570dd55a33a26b5037af136387aa2226ed7c8a4542b2c
+  data.tar.gz: 636e92166449f951489340b2cb00a00c7f72225fd2239f4ba9faba6919e72bd17ba24454f8a2be9ed2be8c6f76382045490a2d24b13e09bb1323dbb5dbadcb81

data/README.md

@@ -17,13 +17,15 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
     * [JWT authentication](#jwt-authentication)
     * [Webhook signatures](#webhook-signatures)
     * [Pagination](#pagination)
-    * [NCCO Builder](#ncco-builder)
     * [Messages API](#messages-api)
     * [Verify API v2](#verify-api-v2)
+    * [Voice API](#voice-api)
+      * [NCCO Builder](#ncco-builder)
 * [Documentation](#documentation)
-* [Frequently Asked Questions](#frequently-asked-questions)
-    * [Supported APIs](#supported-apis)
+* [Supported APIs](#supported-apis)
+* [Other SDKs and Tools](#other-sdks-and-tools)
 * [License](#license)
+* [Contribute](#contribute)
 
 
 ## Requirements
@@ -66,8 +68,47 @@ For production you can specify the `VONAGE_API_KEY` and `VONAGE_API_SECRET`
 environment variables instead of specifying the key and secret explicitly,
 keeping your credentials out of source control.
 
+For APIs which use a JWT for authentication you'll need to pass `application_id` and `private_key` arguments to the
+`Client` constructor as well as or instead of `api_key` and `api_secret`. See [JWT Authentication](#jwt-authentication).
 
-## Logging
+It is also possible to over-ride the default hosts at `Client` instantiation. See [Overriding the default hosts](overriding-the-default-hosts).
+
+### JWT authentication
+
+To call newer endpoints that support JWT authentication such as the Voice API and Messages API you'll
+also need to specify the `application_id` and `private_key` options. For example:
+
+```ruby
+client = Vonage::Client.new(application_id: application_id, private_key: private_key)
+```
+
+Both arguments should have string values corresponding to the `id` and `private_key`
+values returned in a ["create an application"](https://developer.nexmo.com/api/application.v2#createApplication)
+response. These credentials can be stored in a datastore, in environment variables,
+on disk outside of source control, or in some kind of key management infrastructure.
+
+By default the library generates a short lived JWT per request. To generate a long lived
+JWT for multiple requests or to specify JWT claims directly use `Vonage::JWT.generate` and
+the token option. For example:
+
+```ruby
+claims = {
+  application_id: application_id,
+  private_key: 'path/to/private.key',
+  nbf: 1483315200,
+  ttl: 800
+}
+
+token = Vonage::JWT.generate(claims)
+
+client = Vonage::Client.new(token: token)
+```
+
+Documentation for the Vonage Ruby JWT generator gem can be found at
+[https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby](https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby).
+The documentation outlines all the possible parameters you can use to customize and build a token with.
+
+### Logging
 
 Use the logger option to specify a logger. For example:
 
@@ -83,7 +124,7 @@ By default the library sets the logger to `Rails.logger` if it is defined.
 
 To disable logging set the logger to `nil`.
 
-## Exceptions
+### Exceptions
 
 Where exceptions result from an error response from the Vonage API (HTTP responses that aren't ion the range `2xx` or `3xx`), the `Net::HTTPResponse` object will be available as a property of the `Exception` object via a `http_response` getter method (where there is no `Net::HTTPResponse` object associated with the exception, the value of `http_response` will be `nil`).
 
@@ -124,7 +165,7 @@ rescue Vonage::Error => error
 end
 ```
 
-## Overriding the default hosts
+### Overriding the default hosts
 
 To override the default hosts that the SDK uses for HTTP requests, you need to
 specify the `api_host`, `rest_host` or both in the client configuration. For example:
@@ -139,46 +180,13 @@ client = Vonage::Client.new(
 By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
 
 
-## JWT authentication
-
-To call newer endpoints that support JWT authentication such as the Voice API and Messages API you'll
-also need to specify the `application_id` and `private_key` options. For example:
-
-```ruby
-client = Vonage::Client.new(application_id: application_id, private_key: private_key)
-```
 
-Both arguments should have string values corresponding to the `id` and `private_key`
-values returned in a ["create an application"](https://developer.nexmo.com/api/application.v2#createApplication)
-response. These credentials can be stored in a datastore, in environment variables,
-on disk outside of source control, or in some kind of key management infrastructure.
-
-By default the library generates a short lived JWT per request. To generate a long lived
-JWT for multiple requests or to specify JWT claims directly use `Vonage::JWT.generate` and
-the token option. For example:
-
-```ruby
-claims = {
-  application_id: application_id,
-  private_key: 'path/to/private.key',
-  nbf: 1483315200,
-  ttl: 800
-}
-
-token = Vonage::JWT.generate(claims)
-
-client = Vonage::Client.new(token: token)
-```
-
-Documentation for the Vonage Ruby JWT generator gem can be found at
-[https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby](https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby).
-The documentation outlines all the possible parameters you can use to customize and build a token with.
 
-## Webhook signatures
+### Webhook signatures
 
 Certain Vonage APIs provide signed [webhooks](https://developer.vonage.com/en/getting-started/concepts/webhooks) as a means of verifying the origin of the webhooks. The exact signing mechanism varies depending on the API.
 
-### Signature in Request Body
+#### Signature in Request Body
 
 The [SMS API](https://developer.vonage.com/en/messaging/sms/overview) signs the webhook request using a hash digest. This is assigned to a `sig` parameter in the request body.
 
@@ -229,7 +237,7 @@ client.sms.verify_webhook_sig(webhook_params: params) # => returns true if the s
 
 **Note:** Webhook signing for the SMS API is not switched on by default. You'll need to contact support@vonage.com to enable message signing on your account.
 
-### Signed JWT in Header
+#### Signed JWT in Header
 
 The [Voice API](https://developer.vonage.com/en/voice/voice-api/overview) and [Messages API](https://developer.vonage.com/en/messages/overview) both include an `Authorization` header in their webhook requests. The value of this header includes a JSON Web Token (JWT) signed using the Signature Secret associated with your Vonage account.
 
@@ -286,7 +294,7 @@ client = Vonage::Client.new
 client.voice.verify_webhook_token(token: extracted_token) # => returns true if the token is valid, false otherwise
 ```
 
-## Pagination
+### Pagination
 
 Vonage APIs paginate list requests. This means that if a collection is requested that is larger than the API default, the API will return the first page of items in the collection. The Ruby SDK provides an `auto_advance` parameter that will traverse through the pages and return all the results in one response object.
 
@@ -303,31 +311,6 @@ To modify the `auto_advance` behavior you can specify it in your method:
 client.applications.list(auto_advance: false)
 ```
 
-## NCCO Builder
-
-The Vonage Voice API accepts instructions via JSON objects called NCCOs. Each NCCO can be made up multiple actions that are executed in the order they are written. The Vonage API Developer Portal contains an [NCCO Reference](https://developer.vonage.com/voice/voice-api/ncco-reference) with instructions and information on all the parameters possible.
-
-The SDK includes an NCCO builder that you can use to build NCCOs for your Voice API methods.
-
-For example, to build `talk` and `input` NCCO actions and then combine them into a single NCCO you would do the following:
-
-```ruby
-talk = Vonage::Voice::Ncco.talk(text: 'Hello World!')
-input = Vonage::Voice::Ncco.input(type: ['dtmf'], dtmf: { bargeIn: true })
-ncco = Vonage::Voice::Ncco.build(talk, input)
-
-# => [{:action=>"talk", :text=>"Hello World!"}, {:action=>"input", :type=>["dtmf"], :dtmf=>{:bargeIn=>true}}]
-```
-
-Once you have the constructed NCCO you can then use it in a Voice API request:
-
-```ruby
-response = client.voice.create({
-  to: [{type: 'phone', number: '14843331234'}],
-  from: {type: 'phone', number: '14843335555'},
-  ncco: ncco
-})
-```
 
 ## Messages API
 
@@ -480,40 +463,85 @@ if code_check.http_response.code == '200'
 end
 ```
 
+## Voice API
+
+The [Vonage Voice API](The [Vonage Verify API v2](https://developer.vonage.com/en/verify/verify-v2/overview) allows you to automate voice interactions by creating calls, streaming audio, playing text to speech, playing DTMF tones, and other actions. See the Vonage Developer Documentation for a [complete API reference](https://developer.vonage.com/en/api/voice) listing all the Voice API capabilities.
+
+The Ruby SDK provides numerous methods for interacting with the Voice v2 API. Here's an example of using the `create` method to make an outbound text-to-speech call:
+
+```ruby
+response = client.voice.create(
+  to: [{
+    type: 'phone',
+    number: '447700900000'
+  }],
+  from: {
+    type: 'phone',
+    number: '447700900001'
+  },
+  answer_url: [
+    'https://raw.githubusercontent.com/nexmo-community/ncco-examples/gh-pages/text-to-speech.json'
+  ]
+)
+```
+
+### NCCO Builder
+
+The Vonage Voice API accepts instructions via JSON objects called NCCOs. Each NCCO can be made up multiple actions that are executed in the order they are written. The Vonage API Developer Portal contains an [NCCO Reference](https://developer.vonage.com/voice/voice-api/ncco-reference) with instructions and information on all the parameters possible.
+
+The SDK includes an NCCO builder that you can use to build NCCOs for your Voice API methods.
+
+For example, to build `talk` and `input` NCCO actions and then combine them into a single NCCO you would do the following:
+
+```ruby
+talk = Vonage::Voice::Ncco.talk(text: 'Hello World!')
+input = Vonage::Voice::Ncco.input(type: ['dtmf'], dtmf: { bargeIn: true })
+ncco = Vonage::Voice::Ncco.build(talk, input)
+
+# => [{:action=>"talk", :text=>"Hello World!"}, {:action=>"input", :type=>["dtmf"], :dtmf=>{:bargeIn=>true}}]
+```
+
+Once you have the constructed NCCO you can then use it in a Voice API request:
+
+```ruby
+response = client.voice.create({
+  to: [{type: 'phone', number: '14843331234'}],
+  from: {type: 'phone', number: '14843335555'},
+  ncco: ncco
+})
+```
+
 ## Documentation
 
-Vonage Ruby documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
+Vonage Ruby SDK documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
 
-Vonage Ruby code examples: https://github.com/Vonage/vonage-ruby-code-snippets
+Vonage Ruby SDK code examples: https://github.com/Vonage/vonage-ruby-code-snippets
 
 Vonage APIs API reference: https://developer.nexmo.com/api
 
-## Frequently Asked Questions
-
 ## Supported APIs
 
-The following is a list of Vonage APIs and whether the Ruby SDK provides support for them:
-
-| API   | API Release Status |  Supported?
-|----------|:---------:|:-------------:|
-| Account API | General Availability |✅|
-| Alerts API | General Availability |✅|
-| Application API | General Availability |✅|
-| Audit API | Beta |❌|
-| Conversation API | Beta |❌|
-| Dispatch API | Beta |❌|
-| External Accounts API | Beta |❌|
-| Media API | Beta | ❌|
-| Messages API | General Availability |✅|
-| Number Insight API | General Availability |✅|
-| Number Management API | General Availability |✅|
-| Pricing API | General Availability |✅|
-| Redact API | Developer Preview |✅|
-| Reports API | Beta |❌|
-| SMS API | General Availability |✅|
-| Verify API | General Availability |✅|
-| Verify API v2 | General Availability |✅|
-| Voice API | General Availability |✅|
+The following is a list of Vonage APIs for which the Ruby SDK currently provides support:
+
+* [Account API](https://developer.vonage.com/en/account/overview)
+* [Application API](https://developer.vonage.com/en/application/overview)
+* [Meetings API](https://developer.vonage.com/en/meetings/overview)
+* [Messages API](https://developer.vonage.com/en/messages/overview)
+* [Number Insight API](https://developer.vonage.com/en/number-insight/overview)
+* [Numbers API](https://developer.vonage.com/en/numbers/overview)
+* [Proactive Connect API](https://developer.vonage.com/en/proactive-connect/overview) *
+* [Redact API](https://developer.vonage.com/en/redact/overview)
+* [SMS API](https://developer.vonage.com/en/messaging/sms/overview)
+* [Subaccounts API](https://developer.vonage.com/en/account/subaccounts/overview)
+* [Verify API](https://developer.vonage.com/en/verify/overview)
+* [Voice API](https://developer.vonage.com/en/verify/overview)
+
+\* The Proactive Connect API is partially supported in the SDK. Specifically, the Events, Items, and Lists endpoints are supported.
+
+## Other SDKs and Tools
+
+You can find information about other Vonage SDKs and Tooling on our [Developer Portal](https://developer.vonage.com/en/tools).
+
 
 ## License
 
@@ -521,3 +549,13 @@ This library is released under the [Apache 2.0 License][license]
 
 [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
 [license]: LICENSE.txt
+
+## Contribute!
+
+_We :heart: contributions to this library!_
+
+It is a good idea to [talk to us](https://developer.vonage.com/community/slack)
+first if you plan to add any new functionality.
+Otherwise, [bug reports](https://github.com/Vonage/vonage-ruby-sdk/issues),
+[bug fixes](https://github.com/Vonage/vonage-ruby-sdk/pulls) and feedback on the
+library are always appreciated.

data/lib/vonage/client.rb

@@ -89,6 +89,13 @@ module Vonage
       @number_insight ||= T.let(NumberInsight.new(config), T.nilable(Vonage::NumberInsight))
     end
 
+    # @return [NumberInsight2]
+    #
+    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)) }
@@ -166,6 +173,13 @@ module Vonage
       @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/config.rb

@@ -18,6 +18,7 @@ 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
 
@@ -203,6 +204,9 @@ 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
 

data/lib/vonage/keys.rb

@@ -21,7 +21,15 @@ module Vonage
         'voice_callback_value',
         'voice_status_callback',
         'messages_callback_value',
-        'messages_callback_type'
+        'messages_callback_type',
+        'add_stream',
+        'has_audio',
+        'has_video',
+        'remove_stream',
+        'screenshare_type',
+        'session_id',
+        'stream_mode',
+        'archive_mode'
       ]
       hash.transform_keys do |k|
         if exceptions.include?(k.to_s)

data/lib/vonage/namespace.rb

@@ -23,8 +23,7 @@ module Vonage
     end
 
     def self.host=(host)
-      raise ArgumentError unless %i[rest_host vonage_host].include?(host)
-
+      raise ArgumentError unless %i[rest_host video_host vonage_host].include?(host)
       @host = host
     end
 
@@ -273,7 +272,7 @@ module Vonage
       when Net::HTTPNoContent
         response_class.new(nil, response)
       when Net::HTTPSuccess
-        if response['Content-Type'] && response['Content-Type'].split(';').first == 'application/json'
+        if response['Content-Type'] && response['Content-Type'].split(';').first == 'application/json' && !response.body.empty?
           entity = ::JSON.parse(response.body, object_class: Vonage::Entity)
 
           response_class.new(entity, response)
@@ -295,6 +294,8 @@ module Vonage
       case self.class.host
       when :rest_host
         @config.rest_host
+      when :video_host
+        @config.video_host
       when :vonage_host
         @config.vonage_host
       else

data/lib/vonage/number_insight_2.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class NumberInsight2 < Namespace
+    extend T::Sig
+
+    self.authentication = Basic
+
+    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
+    #
+    sig { params(type: String, phone: String, insights: T::Array[String]).returns(Vonage::Response) }
+    def fraud_check(type:, phone:, insights:)
+      raise ArgumentError.new("`insights` must not be an empty") if insights.empty?
+
+      request('/v2/ni', params: {type: type, phone: phone, insights: insights}, type: Post)
+    end
+  end
+end

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

@@ -10,16 +10,14 @@ module Vonage
     def initialize(to:, from: nil)
       self.channel = 'email'
       self.to = to
-      self.from = from if from
+      self.from = from unless from.nil?
     end
 
     def to=(to)
-      # TODO: add validation
       @to = to
     end
 
     def from=(from)
-      # TODO: add validation
       @from = from
     end
 

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

@@ -1,15 +1,18 @@
 # typed: true
 # frozen_string_literal: true
 require 'phonelib'
+require 'uri'
 
 module Vonage
   class Verify2::Channels::SilentAuth
 
-    attr_reader :channel, :to
+    attr_reader :channel, :to, :sandbox, :redirect_url
 
-    def initialize(to:)
+    def initialize(to:, redirect_url: nil, sandbox: nil)
       self.channel = 'silent_auth'
       self.to = to
+      self.redirect_url = redirect_url unless redirect_url.nil?
+      self.sandbox = sandbox unless sandbox.nil?
     end
 
     def to=(to)
@@ -17,6 +20,16 @@ module Vonage
       @to = to
     end
 
+    def redirect_url=(redirect_url)
+      raise ArgumentError, "Invalid 'to' value #{redirect_url}. Expected to be a valid URL" unless URI.parse(redirect_url).is_a?(URI::HTTP)
+      @redirect_url = redirect_url
+    end
+
+    def sandbox=(sandbox)
+      raise ArgumentError, "Invalid 'sandbox' value #{sandbox}. Expected to be boolean value" unless [true, false].include? sandbox
+      @sandbox = sandbox
+    end
+
     def to_h
       hash = Hash.new
       self.instance_variables.each do |ivar|

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

@@ -11,7 +11,7 @@ module Vonage
     def initialize(to:, app_hash: nil)
       self.channel = 'sms'
       self.to = to
-      self.app_hash = app_hash if app_hash
+      self.app_hash = app_hash unless app_hash.nil?
     end
 
     def to=(to)

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

@@ -10,7 +10,7 @@ module Vonage
     def initialize(to:, from: nil)
       self.channel = 'whatsapp'
       self.to = to
-      self.from = from if from
+      self.from = from unless from.nil?
     end
 
     def to=(to)

data/lib/vonage/verify2.rb

@@ -10,7 +10,7 @@ module Vonage
     # Request a verification be sent to a user.
     #
     # @example
-    #   verification_request = verify.start_verification(
+    #   verification_request = client.verify2.start_verification(
     #     brand: 'Acme',
     #     workflow: [{channel: 'sms', to: '447000000000'}],
     #     code_length: 6
@@ -41,7 +41,7 @@ module Vonage
     # Check a supplied code against a request to see if it is valid.
     #
     # @example
-    #   code_check = verify.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
+    #   code_check = client.verify2.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
     #
     # @param [required, String] :request_id The request_id of the verification request being checked
     #
@@ -56,7 +56,7 @@ module Vonage
     # Cancel a verifiction. If a verification request is still active, calling this method aborts the workflow.
     #
     # @example
-    #   verify.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
+    #   client.verify2.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
     #
     # @param [required, String] :request_id The request_id of the verification request to be cancelled
     #

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = "7.18.0"
+  VERSION = '7.19.0'
 end

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

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

@@ -0,0 +1,152 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Archives < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of archives for a specified Vonage application.
+    #
+    # @param [optional, Integer] :offset
+    #
+    # @param [optional, Integer] :count
+    #
+    # @param [optional, String] :session_id
+    #
+    # TODO: add auto_advance option
+    #
+    # @return [ListResponse]
+    #
+    # @see TODO: add docs link
+    #
+    def list(**params)
+      request('/v2/project/' + @config.application_id + '/archive', params: params, response_class: ListResponse)
+    end
+
+    # Return information for specified archive.
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def info(archive_id:)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id)
+    end
+
+    # Create a new archive.
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [optional, String] :hasAudio
+    #
+    # @param [optional, String] :hasVideo
+    #
+    # @param [optional, String] :name
+    #
+    # @param [optional, String] :outputMode
+    #
+    # @param [optional, String] :resolution
+    #
+    # @param [optional, String] :streamMode
+    #
+    # @param [optional, String] :multiArchiveTag
+    #
+    # @param [optional, Hash] :layout
+    #
+    # @option layout [optional, String] :type
+    #
+    # @option layout [optional, String] :stylesheet
+    #
+    # @option layout [optional, String] :screenshareType
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def start(session_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive', params: camelcase(params.merge(session_id: session_id)), type: Post)
+    end
+
+    # Stop recording a specified archive.
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def stop(archive_id:)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/stop', type: Post)
+    end
+
+    # Delete a specified archive.
+    #
+    # @param [required, String] archive_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def delete(archive_id:)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id, type: Delete)
+    end
+
+    # Add a stream to a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] stream_id The ID of the stream to be added
+    #
+    # @param [optional, Boolean] has_audio
+    #
+    # @param [optional, Boolean] has_video
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def add_stream(archive_id:, stream_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: camelcase(params.merge(addStream: stream_id)), type: Patch)
+    end
+
+    # Remove a stream from a composed archive that was started with the streamMode set to "manual".
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [required, String] stream_id The ID of the stream to be removed
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def remove_stream(archive_id:, stream_id:)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/streams', params: {removeStream: stream_id}, type: Patch)
+    end
+
+    # Change the layout of a composed archive while it is being recorded.
+    #
+    # @param [required, String] archive_id
+    #
+    # @param [optional, String] type
+    #
+    # @param [optional, String] stylesheet
+    #
+    # @param [optional, String] screenshare_type
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def change_layout(archive_id:, **params)
+      request('/v2/project/' + @config.application_id + '/archive/' + archive_id + '/layout', params: camelcase(params), type: Put)
+    end
+  end
+end

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

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

@@ -0,0 +1,75 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Broadcasts < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of live streaming broadcasts for a specified Vonage application.
+    #
+    def list(**params)
+      path = '/v2/project/' + @config.application_id + '/broadcast'
+      path += "?#{Params.encode(camelcase(params))}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+
+    # Return information for specified broadcast.
+    #
+    def info(broadcast_id:)
+      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id)
+    end
+
+    # Start a new live streaming broadcast.
+    #
+    def start(session_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast',
+        params: camelcase(params.merge(session_id: session_id)),
+        type: Post
+      )
+    end
+
+    # Stop a specified broadcast.
+    #
+    def stop(broadcast_id:)
+      request('/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/stop', type: Post)
+    end
+
+    # Add a stream to a live streaming broadcast.
+    #
+
+    def add_stream(broadcast_id:, stream_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
+        params: camelcase(params.merge(addStream: stream_id)),
+        type: Patch
+      )
+    end
+
+    # Remove a stream from a live streaming broadcast.
+    #
+    def remove_stream(broadcast_id:, stream_id:)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/streams',
+        params: {removeStream: stream_id},
+        type: Patch
+      )
+    end
+
+    # Dynamically change layout of a broadcast.
+    #
+    def change_layout(broadcast_id:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/broadcast/' + broadcast_id + '/layout',
+        params: camelcase(params),
+        type: Put)
+    end
+  end
+end

data/lib/vonage/video/moderation.rb

@@ -0,0 +1,58 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Moderation < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Force a client to disconnect from a session.
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :connection_id The connection ID of the specific participant to be disconnected from the session.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def force_disconnect(session_id:, connection_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id, type: Delete)
+    end
+
+    # Force mute a specific publisher stream in a session.
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :stream_id The stream ID of the specific stream to be muted.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def mute_single_stream(session_id:, stream_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id + '/mute', type: Post)
+    end
+
+    # Force mute all publisher stream for a specific session.
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :active
+    #
+    # @param [required, Array<String>] :excludedStreamIds
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def mute_multiple_streams(session_id:, **params)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/mute', params: params, type: Post)
+    end
+
+    # TODO: add disable_force_mute ??
+  end
+end

data/lib/vonage/video/signals.rb

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Signals < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Send a signal to a specific participant in an active Vonage Video session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :connection_id The connection ID of the specific participant.
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def send_to_one(session_id:, connection_id:, **params)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id + '/signal', params: params, type: Post)
+    end
+
+    # Send a signal to all participants in an active Vonage Video session.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :type Type of data that is being sent to the client.
+    #
+    # @param [required, String] :data Payload that is being sent to the client.
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def send_to_all(session_id:, **params)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/signal', params: params, type: Post)
+    end
+  end
+end

data/lib/vonage/video/sip.rb

@@ -0,0 +1,48 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::SIP < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Initiate an outbound SIP call.
+    #
+    def dial(session_id:, token:, sip_uri:, **params)
+      request(
+        '/v2/project/' + @config.application_id + '/dial',
+        params: camelcase({
+          session_id: session_id,
+          token: token,
+          sip: params.merge({uri: sip_uri})
+          }),
+        type: Post
+      )
+    end
+
+    # Play DTMF tones into a SIP call.
+    #
+    def play_dtmf_to_session(session_id:, dtmf_digits:)
+      request(
+        '/v2/project/' + @config.application_id + '/session/' + session_id + '/play-dtmf',
+        params: {digits: dtmf_digits},
+        type: Post
+      )
+    end
+
+    # Play DMTF tones into a specific connection.
+    #
+    def play_dtmf_to_connection(session_id:, connection_id:, dtmf_digits:)
+      request(
+        '/v2/project/' + @config.application_id + '/session/' + session_id + '/connection/' + connection_id + '/play-dtmf',
+        params: {digits: dtmf_digits},
+        type: Post
+      )
+    end
+  end
+end

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

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video::Streams < Namespace
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :video_host
+
+    # Get a list of streams 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 + '/stream', response_class: ListResponse)
+    end
+
+    # Get information about a specified stream.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [required, String] :stream_id
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def info(session_id:, stream_id:)
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream/' + stream_id)
+    end
+
+    # Change the layout for a list of specified streams.
+    #
+    # @param [optional, String] :application_id (Required unless already set at Client instantiation or set in ENV)
+    #
+    # @param [required, String] :session_id
+    #
+    # @param [optional, Array<Hash>] :items An array of hashes representing streams and the layout classes for those streams
+    #
+    # @option items [required, String] :id The stream ID
+    #
+    # @option items [required, Array<String>] :layoutClassList Array of CSS class names as strings
+    #
+    # @return [Response]
+    #
+    # @see TODO: add docs link
+    #
+    def change_layout(session_id:, **params)
+      # TODO camelcase layout_class_list
+      # if params[:items]
+      #   params[:items] = params[:items].map {|item| camelcase(item)}
+      # end
+
+      request('/v2/project/' + @config.application_id + '/session/' + session_id + '/stream', params: params, type: Put)
+    end
+  end
+end

data/lib/vonage/video.rb

@@ -0,0 +1,109 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Video < Namespace
+    include Keys
+
+    self.authentication = BearerToken
+
+    self.host = :video_host
+
+    # Generate a new session.
+    #
+    # @example
+    #   session = client.video.create_session({
+    #     archive_mode: 'always',
+    #     location: '10.1.200.30',
+    #     media_mode: 'routed'
+    #   })
+    #
+    # @params [optional, String] :archive_mode (either 'always' or 'manual')
+    #
+    # @param [optional, String] :location
+    #
+    # @params [optional, String] :media_mode (either 'routed' or 'relayed')
+    #
+    # @return [Response]
+    #
+    # @see TODO: Add document link here
+    #
+    def create_session(**params)
+      request_params = params.clone
+      request_params[:archive_mode] ||= 'manual'
+      media_mode = request_params.delete(:media_mode) || 'routed'
+
+      if media_mode == 'relayed' && request_params[:archive_mode] == 'manual'
+        request_params['p2p.preference'] = 'enabled'
+      else
+        request_params['p2p.preference'] = 'disabled'
+      end
+
+      response = request('/session/create', params: camelcase(request_params), type: Post)
+
+      public_response_data = {
+        session_id: response.entity.first.session_id,
+        archive_mode: request_params[:archive_mode],
+        media_mode: media_mode,
+        location: request_params[:location]
+      }
+
+      entity = Entity.new(public_response_data)
+
+      response.class.new(entity, response.http_response)
+    end
+
+    def generate_client_token(session_id:, scope: 'session.connect', role: 'publisher', **params)
+      claims = {
+        application_id: @config.application_id,
+        scope: scope,
+        session_id: session_id,
+        role: role,
+        initial_layout_class_list: '',
+        sub: 'video',
+        acl: {
+          paths: {'/session/**' => {}}
+        }
+      }
+
+
+      claims[:data] = params[:data] if params[:data]
+      claims[:initial_layout_class_list] = params[:initial_layout_class_list].join(' ') if params[:initial_layout_class_list]
+      claims[:exp] = params[:expire_time].to_i if params[:expire_time]
+
+      JWT.generate(claims, @config.private_key)
+    end
+
+    # @return [Archives]
+    #
+    def archives
+      @archives ||= Archives.new(@config)
+    end
+
+    # @return [Broadcasts]
+    #
+    def broadcasts
+      @broadcasts ||= Broadcasts.new(@config)
+    end
+
+    # @return [Moderation]
+    #
+    def moderation
+      @moderation ||= Moderation.new(@config)
+    end
+
+    # @return [Signals]
+    #
+    def signals
+      @signals ||= Signals.new(@config)
+    end
+
+    # @return [Streams]
+    #
+    def streams
+      @streams ||= Streams.new(@config)
+    end
+
+
+  end
+end

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

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
- 
- module Vonage 
+
+module Vonage
   class Voice::Actions::Conversation
     attr_accessor :name, :musicOnHoldUrl, :startOnEnter, :endOnExit, :record, :canSpeak, :canHear, :mute
 

data/lib/vonage.rb

@@ -13,6 +13,7 @@ module Vonage
     'http' => 'HTTP',
     'json' => 'JSON',
     'jwt' => 'JWT',
+    'sip' => 'SIP',
     'sms' => 'SMS',
     'mms' => 'MMS',
     'tfa' => 'TFA',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.18.0
+  version: 7.19.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -161,6 +161,7 @@ files:
 - lib/vonage/messaging/message.rb
 - lib/vonage/namespace.rb
 - lib/vonage/number_insight.rb
+- lib/vonage/number_insight_2.rb
 - lib/vonage/numbers.rb
 - lib/vonage/numbers/list_response.rb
 - lib/vonage/numbers/response.rb
@@ -205,6 +206,16 @@ files:
 - lib/vonage/verify2/workflow.rb
 - lib/vonage/verify2/workflow_builder.rb
 - lib/vonage/version.rb
+- lib/vonage/video.rb
+- lib/vonage/video/archives.rb
+- lib/vonage/video/archives/list_response.rb
+- lib/vonage/video/broadcasts.rb
+- lib/vonage/video/broadcasts/list_response.rb
+- lib/vonage/video/moderation.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/voice.rb
 - lib/vonage/voice/actions/connect.rb
 - lib/vonage/voice/actions/conversation.rb