vonage 7.26.0 → 7.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3865caa299175327806358dbe9a66e59abefa41240a5d9a847e5e73a37ea50
-  data.tar.gz: 861a7ae004b3908083af43cae0809330732dc07aa7be22a3cc362dc8b538fdab
+  metadata.gz: 882867135989a3281df945f45ee52c5f8ccd01f60878e0987570f43d5802b384
+  data.tar.gz: 805db1a403bdbe6ceae3adb90b7e1cf8afdc25215b947e5a41a010b5050e4836
 SHA512:
-  metadata.gz: 336c7b033206cf204f41e513a2dc8a4c56b57750660e17b37aede3d200aedcced48352ab18ffa3d44f7924df34548f767f19c9189dc385d9f2557a584d399bd7
-  data.tar.gz: da28e64d300d4f70c789e670c10f60beb9fbb058c1da3af8f2f995a8a61541d5b73cea93342f0a5f3b1b0a620dbba5c277fe5b8617259a52446bbbbeed09042e
+  metadata.gz: 14edb2c22f6e54e58bd17a26290944ec5d963706436b3b41d1f5598f094e57a7fdd09fa6ece3d4885a575c567eddaeb16bf8ebf2bd52a5fdd107a4404e7d20ce
+  data.tar.gz: 284099e63365b6e08bbcb6ec3a03213ba9f812963841470b83e35b8f03e040611f75bdba1d6c35d5e4982604dcc1e9803e96fc5a290ed5677474537837687a38

data/README.md

@@ -14,6 +14,7 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
     * [Logging](#logging)
     * [Exceptions](#exceptions)
     * [Overriding the default hosts](#overriding-the-default-hosts)
+    * [HTTP Client Configuration](#http-client-configuration)
     * [JWT authentication](#jwt-authentication)
     * [Webhook signatures](#webhook-signatures)
     * [Pagination](#pagination)
@@ -83,7 +84,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 +105,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,8 +180,32 @@ client = Vonage::Client.new(
 
 By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
 
+### HTTP Client Configuration
+
+It is possible to set configuration options on the HTTP client. This can be don in a couple of ways.
+
+1. Using an `:http` key during `Vonage::Client` instantiation, for example:
+    ```ruby
+    client = Vonage::Client.new(
+      api_key: 'YOUR-API-KEY',
+      api_secret: 'YOUR-API-SECRET',
+      http: {
+        max_retries: 1
+      }
+    )
+    ```
+
+2. By using the `http=` setter on the `Vonage::Config` object, for example:
+    ```ruby
+    client = Vonage::Client.new(
+      api_key: 'YOUR-API-KEY',
+      api_secret: 'YOUR-API-SECRET'
+    )
 
+    client.config.http = { max_retries: 1 }
+    ```
 
+The Vonage Ruby SDK uses the [`Net::HTTP::Persistent` library](https://github.com/drbrain/net-http-persistent) as an HTTP client. For available configuration options see [the documentation for that library](https://www.rubydoc.info/gems/net-http-persistent/3.0.0/Net/HTTP/Persistent).
 
 ### Webhook signatures
 
@@ -300,10 +325,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 +339,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 +538,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
 

data/lib/vonage/http.rb

@@ -1,6 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
-require 'net/http'
+require 'net/http/persistent'
 
 module Vonage
   module HTTP
@@ -21,7 +21,7 @@ module Vonage
         end
       end
 
-      sig { params(http: Net::HTTP).returns(T::Hash[Symbol, T.untyped]) }
+      sig { params(http: Net::HTTP::Persistent).returns(T::Hash[Symbol, T.untyped]) }
       def set(http)
         @hash.each do |name, value|
           http.public_send(defined_options.fetch(name), value)
@@ -34,7 +34,7 @@ module Vonage
       def defined_options
         @defined_options = T.let(@defined_options, T.nilable(T::Hash[Symbol, T.untyped]))
 
-        @defined_options ||= Net::HTTP.instance_methods.grep(/\w=\z/).each_with_object({}) do |name, hash|
+        @defined_options ||= Net::HTTP::Persistent.instance_methods.grep(/\w=\z/).each_with_object({}) do |name, hash|
           hash[name.to_s.chomp('=').to_sym] = name
         end
       end

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

@@ -17,6 +17,8 @@ module Vonage
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
+    # @param [Hash] params
+    #
     # @option params [String] :application_id
     #   The application that you want to return the numbers for.
     #
@@ -47,8 +49,6 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
-    # @param [Hash] params
-    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getOwnedNumbers
@@ -65,6 +65,8 @@ module Vonage
     #     puts "#{item.msisdn} #{item.type} #{item.cost}"
     #   end
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -82,7 +84,7 @@ module Vonage
     #   - `2` - Search for numbers that end with **:pattern**
     #
     # @option params [String] :features
-    #   Available features are `SMS` and `VOICE`.
+    #   Available features are `SMS`, `MMS`, and `VOICE`.
     #   To look for numbers that support both, use a comma-separated value: `SMS,VOICE`.
     #
     # @option params [Integer] :size
@@ -95,8 +97,6 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
-    # @param [Hash] params
-    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getAvailableNumbers
@@ -110,6 +110,8 @@ module Vonage
     # @example
     #   response = client.numbers.buy(country: 'GB', msisdn: '447700900000')
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -120,8 +122,6 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
-    # @param [Hash] params
-    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#buyANumber
@@ -140,6 +140,8 @@ module Vonage
     # @example
     #   response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -150,8 +152,6 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
-    # @param [Hash] params
-    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#cancelANumber
@@ -177,6 +177,8 @@ module Vonage
     #
     #   response = client.numbers.update(params)
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -203,8 +205,6 @@ module Vonage
     # @option params [String] :voice_status_callback
     #   A webhook URI for Vonage to send a request to when a call ends.
     #
-    # @param [Hash] params
-    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#updateANumber

data/lib/vonage/proactive_connect/events.rb

@@ -11,6 +11,8 @@ module Vonage
 
     # Find all events
     #
+    # @deprecated
+    #
     # @example
     #   response = proactive_connect.events.list
     #
@@ -59,6 +61,7 @@ module Vonage
     # @see https://developer.vonage.com/en/api/proactive-connect#eventsFindAll
     #
     def list(**params)
+      logger.info('This method is deprecated and will be removed in a future release.')
       path = "/v0.1/bulk/events"
       path += "?#{Params.encode(params)}" unless params.empty?