vonage 7.25.0 → 7.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508c457f8278aae1d8cc3951a8b4c38423ab63307917c4bbc09960f45cbafa9f
-  data.tar.gz: '00329df94f3ab44d6ab8d2552931438358f92ad59c121db87e1668bd1c336814'
+  metadata.gz: 1ef29adae44fffb9754118333b6a82cac7172cb536eb2b4ec31644694c6388ef
+  data.tar.gz: 43496b6bcf0db687cdef8bdd4506db140fea685f48a306abc1aac4325f8300f5
 SHA512:
-  metadata.gz: 80d9743779edc4dca5c4c9babb6a8591d616e4ac2f393ca4932a5a8640574561b28c61c803dc7c397c99221f0a086bd4604f62e8b36b97c7fd2b7da85ddc88d0
-  data.tar.gz: 40756daa0add532dead58f6d7d057e5bfc8f5d39a9bd84515bcdc08f9a6686eb983b6859f45b71fde9e11b8f474dbecb8a2973ff7270fe8256d813e281783341
+  metadata.gz: 055f8c7f7e0bcdc9eb8c59f0110b6bbfb850a1d725468f0e23d1e5bf736b5acdf3a9dfdbf0e17e0f4e5b54fabe6415173c2d8f39106b73ca336389f4f8483baa
+  data.tar.gz: 72ad26a1bf8696cd465ea2f89f7ab190803a29ee13dcb3680238504b9c81c6264dc444e2e12c0e078a19dd2042ea8fe31e8988e32162413325fa7be5a56444d4

data/README.md

@@ -83,7 +83,7 @@ client = Vonage::Client.new(application_id: application_id, private_key: private
 ```
 
 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)
+values returned in a ["create an application"](https://developer.vonage.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.
 
@@ -104,8 +104,8 @@ 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).
+Documentation for the Vonage Ruby JWT generator gem can be found at: https://www.rubydoc.info/gems/vonage-jwt
+
 The documentation outlines all the possible parameters you can use to customize and build a token with.
 
 ### Logging
@@ -179,9 +179,6 @@ client = Vonage::Client.new(
 
 By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
 
-
-
-
 ### 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.
@@ -300,10 +297,10 @@ Vonage APIs paginate list requests. This means that if a collection is requested
 
 The `auto_advance` parameter is set to a default of `true` for the following APIs:
 
-* [Account API](https://developer.nexmo.com/api/developer/account)
-* [Application API](https://developer.nexmo.com/api/application.v2)
-* [Conversation API](https://developer.nexmo.com/api/conversation)
-* [Voice API](https://developer.nexmo.com/api/voice)
+* [Account API](https://developer.vonage.com/api/developer/account)
+* [Application API](https://developer.vonage.com/api/application.v2)
+* [Conversation API](https://developer.vonage.com/api/conversation)
+* [Voice API](https://developer.vonage.com/api/voice)
 
 To modify the `auto_advance` behavior you can specify it in your method:
 
@@ -314,7 +311,7 @@ client.applications.list(auto_advance: false)
 
 ## Messages API
 
-The [Vonage Messages API](https://developer.vonage.com/messages/overview) allows you to send messages over a number of different channels, and various message types within each channel. See the Vonage Developer Documentation for a [complete API reference](https://developer.vonage.com/api/messages-olympus) listing all the channel and message type combinations.
+The [Vonage Messages API](https://developer.vonage.com/messages/overview) allows you to send messages over a number of different channels, and various message types within each channel. See the Vonage Developer Documentation for a [complete API reference](https://developer.vonage.com/en/api/messages) listing all the channel and message type combinations.
 
 The Ruby SDK allows you to construct message data for specific messaging channels. Other than SMS (which has only one type -- text), you need to pass the message `:type` as well as the `:message` itself as arguments to the appropriate messages method, along with any optional properties if needed.
 
@@ -513,11 +510,11 @@ response = client.voice.create({
 
 ## Documentation
 
-Vonage Ruby SDK documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
+Vonage Ruby SDK documentation: https://www.rubydoc.info/gems/vonage
 
 Vonage Ruby SDK code examples: https://github.com/Vonage/vonage-ruby-code-snippets
 
-Vonage APIs API reference: https://developer.nexmo.com/api
+Vonage APIs API reference: https://developer.vonage.com/api
 
 ## Supported APIs
 
@@ -528,6 +525,8 @@ The following is a list of Vonage APIs for which the Ruby SDK currently provides
 * [Conversation API](https://developer.vonage.com/en/conversation/overview)
 * [Meetings API](https://developer.vonage.com/en/meetings/overview)
 * [Messages API](https://developer.vonage.com/en/messages/overview)
+* [Network Number Verification API](https://developer.vonage.com/en/number-verification/overview)
+* [Network SIM Swap API](https://developer.vonage.com/en/sim-swap/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) *

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/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

@@ -91,6 +91,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)) }

data/lib/vonage/key_secret_params.rb

@@ -5,9 +5,10 @@ module Vonage
     extend T::Sig
 
     sig { params(
-      object: T.any(T::Hash[T.untyped, T.untyped], URI::HTTPS, Net::HTTP::Post, Net::HTTP::Get)
+      object: T.any(T::Hash[T.untyped, T.untyped], URI::HTTPS, Net::HTTP::Post, Net::HTTP::Get),
+      data:  T.nilable(Hash)
     ).void }
-    def update(object)
+    def update(object, data)
       return unless object.is_a?(Hash)
 
       @config = T.let(@config, T.nilable(Vonage::Config))

data/lib/vonage/keys.rb

@@ -34,7 +34,10 @@ module Vonage
         'max_duration',
         'partial_captions',
         'status_callback_url',
-        'audio_rate'
+        'audio_rate',
+        'phone_number',
+        'hashed_phone_number',
+        'max_age'
       ]
       hash.transform_keys do |k|
         if exceptions.include?(k.to_s)

data/lib/vonage/meetings/applications.rb

@@ -13,12 +13,15 @@ module Vonage
 
     # Update an existing application.
     #
+    # @deprecated
+    #
     # @param [required, String] :default_theme_id The id of the theme to set as application default theme
     #
     # @return [Response]
     #
     # @see https://developer.vonage.com/en/api/meetings#updateApplication
     def update(default_theme_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/applications", params: {update_details: {default_theme_id: default_theme_id}}, type: Patch)
     end
   end

data/lib/vonage/meetings/dial_in_numbers.rb

@@ -13,10 +13,13 @@ module Vonage
 
     # Get numbers that can be used to dial into a meeting.
     #
+    # @deprecated
+    #
     # @return [ListResponse]
     #
     # @see https://developer.vonage.com/en/api/meetings#getDialInNumbers
     def list
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/dial-in-numbers", response_class: ListResponse)
     end
   end

data/lib/vonage/meetings/recordings.rb

@@ -13,23 +13,29 @@ module Vonage
 
     # Return information for specified recording.
     #
+    # @deprecated
+    #
     # @param [required, String] recording_id The id of the recoring for which the info should be returned
     #
     # @return [Response]
     #
     # @see https://developer.vonage.com/en/api/meetings#getRecording
     def info(recording_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/recordings/" + recording_id)
     end
 
     # Delete a specified recording.
     #
+    # @deprecated
+    #
     # @param [required, String] recording_id The id of the recoring to be deleted
     #
     # @return [Response]
     #
     # @see https://developer.vonage.com/en/api/meetings#deleteRecording
     def delete(recording_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/recordings/" + recording_id, type: Delete)
     end
   end

data/lib/vonage/meetings/rooms.rb

@@ -13,6 +13,8 @@ module Vonage
 
     # Get a list of rooms associated with the Vonage application.
     #
+    # @deprecated
+    #
     # @param [optional, Integer] :start_id
     #
     # @param [optional, Integer] :end_id
@@ -23,6 +25,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#getRooms
     def list(**params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       path = "/v1/meetings/rooms"
       path += "?#{Params.encode(params)}" unless params.empty?
 
@@ -31,6 +34,8 @@ module Vonage
 
     # Return information for specified room.
     #
+    # @deprecated
+    #
     # @param [required, String] room_id
     #   The id of the room for which the info should be returned
     #
@@ -38,11 +43,14 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#getRoom
     def info(room_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/rooms/" + room_id)
     end
 
     # Create a new room.
     #
+    # @deprecated
+    #
     # @param [required, String] :display_name
     #
     # @param [optional, String] :metadata
@@ -95,6 +103,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#createRoom
     def create(display_name:, **params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request(
         "/v1/meetings/rooms",
         params: params.merge({ display_name: display_name }),
@@ -106,6 +115,8 @@ module Vonage
     # Although paramaters (other than `room_id`) are optional, at least one other parameter must be provided or an error
     #   response will be received.
     #
+    # @deprecated
+    #
     # @param [required, String] room_id The ID of the Room to be updated
     #
     # @param [optional, String(date)] :expires_at
@@ -142,6 +153,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#updateRoom
     def update(room_id:, **params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       raise ArgumentError, 'must provide at least one other param in addition to :room_id' if params.empty?
       request(
         "/v1/meetings/rooms/" + room_id,

data/lib/vonage/meetings/sessions.rb

@@ -13,12 +13,15 @@ module Vonage
 
     # Return a list of recordings for a specified session.
     #
+    # @deprecated
+    #
     # @param [required, String] session_id The id of the session for which the recordings list should be returned
     #
     # @return [ListResponse]
     #
     # @see https://developer.vonage.com/en/api/meetings#getSessionRecordings
     def list_recordings(session_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request(
         "/v1/meetings/sessions/" + session_id + "/recordings",
         response_class: ListResponse

data/lib/vonage/meetings/themes.rb

@@ -13,26 +13,34 @@ module Vonage
 
     # Get a list of themes associated with the Vonage application.
     #
+    # @deprecated
+    #
     # @return [ListResponse]
     #
     # @see https://developer.vonage.com/en/api/meetings#getThemes
     def list
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/themes", response_class: ListResponse)
     end
 
     # Return information for specified theme.
     #
+    # @deprecated
+    #
     # @param [required, String] theme_id The id of the theme for which the info should be returned
     #
     # @return [Response]
     #
     # @see https://developer.vonage.com/en/api/meetings#getThemeById
     def info(theme_id:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request("/v1/meetings/themes/" + theme_id)
     end
 
     # Create a new theme.
     #
+    # @deprecated
+    #
     # @param [required, String] :main_color
     #   The main color that will be used for the meeting room.
     #
@@ -49,6 +57,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#createTheme
     def create(main_color:, brand_text:, **params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request(
         "/v1/meetings/themes",
         params: params.merge(main_color: main_color, brand_text: brand_text),
@@ -58,6 +67,8 @@ module Vonage
 
     # Update an existing theme.
     #
+    # @deprecated
+    #
     # @param [required, String] theme_id The id of the theme to be updated
     #
     # @param [required, String] :main_color
@@ -76,6 +87,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#updateTheme
     def update(theme_id:, **params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request(
         "/v1/meetings/themes/" + theme_id,
         params: {
@@ -87,6 +99,8 @@ module Vonage
 
     # Delete an existing theme.
     #
+    # @deprecated
+    #
     # @param [required, String] :theme_id The id of the theme to be deleted
     #
     # @param [optional, Boolean] :force. Set to `true` to force delete a theme currently being used for a room, or as
@@ -96,6 +110,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#deleteTheme
     def delete(theme_id:, force: false)
+      logger.info('This method is deprecated and will be removed in a future release.')
       request(
         "/v1/meetings/themes/" + theme_id + "?force=#{force}",
         type: Delete
@@ -104,6 +119,8 @@ module Vonage
 
     # Get a list of rooms that are associated with a theme id.
     #
+    # @deprecated
+    #
     # @param [required, String] theme_id THe ID of the theme to search for rooms associated with.
     #
     # @param [optional, Integer] :start_id
@@ -116,6 +133,7 @@ module Vonage
     #
     # @see https://developer.vonage.com/en/api/meetings#getRoomsByThemeId
     def list_rooms(theme_id:, **params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       path = "/v1/meetings/themes/" + theme_id + "/rooms"
       path += "?#{Params.encode(params)}" unless params.empty?
 
@@ -124,6 +142,8 @@ module Vonage
 
     # Set a logo for a theme.
     #
+    # @deprecated
+    #
     # @param [required, String] :theme_id The ID of the theme for which the logo should be set
     #
     # @param [required, String] :filepath
@@ -146,6 +166,7 @@ module Vonage
     #
     # TODO: add type signature
     def set_logo(theme_id:, filepath:, logo_type:)
+      logger.info('This method is deprecated and will be removed in a future release.')
       pn = Pathname.new(filepath)
       valid_logo_types = ['white', 'colored', 'favicon']
       raise ArgumentError, ':filepath not for a file' unless pn.file?

data/lib/vonage/meetings.rb

@@ -5,33 +5,45 @@ module Vonage
   class Meetings < Namespace
     extend T::Sig
     
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::Rooms)) }
     def rooms
+      logger.info('This method is deprecated and will be removed in a future release.')
       @rooms ||= Rooms.new(@config)
     end
 
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::Recordings)) }
     def recordings
+      logger.info('This method is deprecated and will be removed in a future release.')
       @recordings ||= Recordings.new(@config)
     end
 
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::Sessions)) }
     def sessions
+      logger.info('This method is deprecated and will be removed in a future release.')
       @sessions ||= Sessions.new(@config)
     end
 
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::Themes)) }
     def themes
+      logger.info('This method is deprecated and will be removed in a future release.')
       @themes ||= Themes.new(@config)
     end
 
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::Applications)) }
     def applications
+      logger.info('This method is deprecated and will be removed in a future release.')
       @applications ||= Applications.new(@config)
     end
 
+    # @deprecated
     sig { returns(T.nilable(Vonage::Meetings::DialInNumbers)) }
     def dial_in_numbers
+      logger.info('This method is deprecated and will be removed in a future release.')
       @dial_in_numbers ||= DialInNumbers.new(@config)
     end
   end

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

@@ -0,0 +1,42 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::RCS < Messaging::Message
+    MESSAGE_TYPES = ['text', 'image', 'video', 'file', 'custom']
+
+    attr_reader :data
+
+    def initialize(attributes = {})
+      @type = attributes.fetch(:type, nil)
+      @message = attributes.fetch(:message, nil)
+      @opts = attributes.fetch(:opts, {})
+      @data = {}
+
+      after_initialize!
+    end
+
+    private
+
+    def build
+      data[:channel] = 'rcs'
+      super
+    end
+
+    def verify_type
+      raise ClientError.new("Invalid message type") unless MESSAGE_TYPES.include?(type)
+    end
+
+    def verify_message
+      case type
+      when 'text'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a String") unless message.is_a? String
+      when 'custom'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
+        raise Vonage::ClientError.new("Invalid parameter content. `:message` must not be empty") if message.empty?
+      else
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a Hash") unless message.is_a? Hash
+        raise Vonage::ClientError.new("Missing parameter. `:message` must contain a `:url` key") unless message[:url]
+      end
+    end
+  end
+end

data/lib/vonage/messaging/message.rb

@@ -5,6 +5,7 @@ module Vonage
     CHANNELS = {
       sms: Vonage::Messaging::Channels::SMS,
       mms: Vonage::Messaging::Channels::MMS,
+      rcs: Vonage::Messaging::Channels::RCS,
       whatsapp: Vonage::Messaging::Channels::WhatsApp,
       messenger: Vonage::Messaging::Channels::Messenger,
       viber: Vonage::Messaging::Channels::Viber

data/lib/vonage/messaging.rb

@@ -25,12 +25,26 @@ module Vonage
     # @option params [required, Hash] **message
     #   The Vonage Message object to use for this message.
     #
-    # @see https://developer.vonage.com/api/messages-olympus#SendMessage
+    # @see https://developer.vonage.com/api/messages#SendMessage
     #
     def send(to:, from:, **message)
       request('/v1/messages', params: {to: to, from: from, **message}, type: Post)
     end
 
+    # Update a Message Object.
+    #
+    # @example
+    #   message = client.messaging.update(message_uuid: "aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab", status: "read")
+    #
+    # @option params [required, String] :message_uuid. the UUID of the message to update.
+    #
+    # `:message_uuid` is always required. Other parameters will depend on the message channel and the specific action being performed.
+    # @see https://developer.vonage.com/api/messages#UpdateMessage
+    #
+    def update(message_uuid:, **params)
+      request("/v1/messages/#{message_uuid}", params: params, type: Patch)
+    end
+
     # Validate a JSON Web Token from a Messages API Webhook.
     #
     # @param [String, required] :token The JWT from the Webhook's Authorization header

data/lib/vonage/namespace.rb

@@ -57,18 +57,15 @@ module Vonage
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def build_request(path:, type: Get, params: {})
+    def build_request(path:, type: Get, params: {}, auth_data: nil)
       authentication = self.class.authentication.new(@config)
-      authentication.update(params)
+      authentication.update(params, auth_data)
 
       uri = URI("https://" + @host + path)
       unless type.const_get(:REQUEST_HAS_BODY) || params.empty?
         uri.query = Params.encode(params)
       end
 
-      # Set BasicAuth if neeeded
-      authentication.update(uri)
-
       # instantiate request
       request = type.new(uri)
 
@@ -80,8 +77,8 @@ module Vonage
       request["Accept"] = "application/json"
       self.class.request_headers.each { |key, value| request[key] = value }
 
-      # Set BearerToken if needed
-      authentication.update(request)
+      # Set Authorization header if needed
+      authentication.update(request, auth_data)
 
       # set body
       if type.const_get(:REQUEST_HAS_BODY)
@@ -106,7 +103,7 @@ module Vonage
       response
     end
 
-    def request(path, params: nil, type: Get, response_class: Response, &block)
+    def request(path, params: nil, type: Get, response_class: Response, auth_data: nil, &block)
       auto_advance =
         (
           if !params.nil? && params.key?(:auto_advance)
@@ -120,7 +117,7 @@ module Vonage
         params.tap { |params| params.delete(:auto_advance) } if !params.nil? &&
         params.key?(:auto_advance)
 
-      request = build_request(path: path, params: params || {}, type: type)
+      request = build_request(path: path, params: params || {}, type: type, auth_data: auth_data)
 
       response = make_request!(request, &block)
 
@@ -139,7 +136,7 @@ module Vonage
       end
     end
 
-    def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {}, override_uri: nil, no_auth: false, response_class: Response, &block)
+    def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {}, override_uri: nil, no_auth: false, response_class: Response, auth_data: nil, &block)
       authentication = self.class.authentication.new(@config) unless no_auth
 
       uri = override_uri ? URI(override_uri) : URI('https://' + @host + path)
@@ -156,8 +153,8 @@ module Vonage
 
         request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
 
-        # Set BearerToken if needed
-        authentication.update(request) unless no_auth
+        # Set Authorization header if needed
+        authentication.update(request, auth_data) unless no_auth
 
         logger.log_request_info(request)
 

data/lib/vonage/network_authentication/client_authentication.rb

@@ -0,0 +1,39 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class NetworkAuthentication::ClientAuthentication < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    self.request_headers['Content-Type'] = 'application/x-www-form-urlencoded'
+
+    def token(oidc_auth_code:, redirect_uri:, **params)
+      request(
+        '/oauth2/token',
+        params: {
+          grant_type: 'authorization_code',
+          code: oidc_auth_code,
+          redirect_uri: redirect_uri
+        },
+        type: Post
+      ).access_token
+    end
+
+    def generate_oidc_uri(purpose:, api_scope:, login_hint:, redirect_uri:, state:)
+      scope = "openid%20dpv:#{purpose}%23#{api_scope}"
+      uri = "https://oidc.idp.vonage.com/oauth2/auth?" +
+        "client_id=#{@config.application_id}" +
+        "&response_type=code" +
+        "&scope=#{scope}" +
+        "&login_hint=#{login_hint}" +
+        "&redirect_uri=#{redirect_uri}" +
+        "&state=#{state}"
+
+      uri
+    end
+  end
+end