vonage 7.8.2 → 7.36.0

data/lib/vonage/meetings/sessions.rb

@@ -0,0 +1,31 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Sessions < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # 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
+      )
+    end
+  end
+end

data/lib/vonage/meetings/themes/list_response.rb

@@ -0,0 +1,11 @@
+# typed: true
+
+class Vonage::Meetings::Themes::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity.each { |item| yield item }
+  end
+end

data/lib/vonage/meetings/themes.rb

@@ -0,0 +1,239 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings::Themes < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    self.host = :vonage_host
+
+    # 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.
+    #
+    # @param [required, String] :brand_text
+    #   The text that will appear on the meeting homepage, in the case that there is no brand image
+    #
+    # @param [optional, String] :theme_name
+    #   The name of the theme (must be unique). If null, a UUID will automatically be generated
+    #
+    # @param [optional, String] :short_company_url
+    #   The URL that will represent every meeting room with this theme. The value must be unique across Vonage
+    #
+    # @return [Response]
+    #
+    # @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),
+        type: Post
+      )
+    end
+
+    # Update an existing theme.
+    #
+    # @deprecated
+    #
+    # @param [required, String] theme_id The id of the theme to be updated
+    #
+    # @param [required, String] :main_color
+    #   The main color that will be used for the meeting room.
+    #
+    # @param [required, String] :brand_text
+    #   The text that will appear on the meeting homepage, in the case that there is no brand image
+    #
+    # @param [optional, String] :theme_name
+    #   The name of the theme (must be unique). If null, a UUID will automatically be generated
+    #
+    # @param [optional, String] :short_company_url
+    #   The URL that will represent every meeting room with this theme. The value must be unique across Vonage
+    #
+    # @return [Response]
+    #
+    # @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: {
+          update_details: params
+        },
+        type: Patch
+      )
+    end
+
+    # 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
+    # a default theme. (Defaults to `false`)
+    #
+    # @return [Response]
+    #
+    # @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
+      )
+    end
+
+    # 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
+    #
+    # @param [optional, Integer] :end_id
+    #
+    # @param [optional, Integer] :page_size
+    #
+    # @return [Response]
+    #
+    # @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?
+
+      request(path, response_class: Meetings::Rooms::ListResponse)
+    end
+
+    # 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
+    #   The filepath of the logo file. Logo files must conform to the following requirements:
+    #     - Format: PNG
+    #     - Maximum size: 1MB
+    #     - Background must be transparent
+    #     - Dimensions:
+    #       - 1 px - 300 px (`white` and `colored` logos)
+    #       - 16 x 16 - 32 x 32 and must be square (favicon)
+    #
+    # @param [required, String] :logo_type
+    #   The type of logo to be set. Must be one of `white`, `colored`, `favicon`
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/meetings/guides/theme-management#uploading-icons-and-logos
+    # @see https://developer.vonage.com/en/api/meetings#getUploadUrlsForTheme
+    # @see https://developer.vonage.com/en/api/meetings#finalizeLogosForTheme
+    #
+    # 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?
+      raise ArgumentError, 'file at :filepath not readable' unless pn.readable?
+      raise ArgumentError, "logo_type: must be one of #{valid_logo_types}" unless valid_logo_types.include?(logo_type)
+
+      logo_upload_credentials = get_logo_upload_credentials
+
+      filtered_logo_upload_credentials = logo_upload_credentials.select {|cred| cred.fields.logo_type == logo_type }.first
+
+      upload_logo_file(filepath: filepath, credentials: filtered_logo_upload_credentials)
+
+      finalize_logos(theme_id: theme_id, keys: [filtered_logo_upload_credentials.fields.key])
+    end
+
+    private
+
+    def get_logo_upload_credentials
+      request("/v1/meetings/themes/logos-upload-urls", response_class: ListResponse)
+    end
+
+    def upload_logo_file(filepath:, credentials:)
+      pn = Pathname.new(filepath)
+
+      params = format_s3_upload_credentials(credentials)
+
+      multipart_post_request(
+        nil,
+        filepath: filepath,
+        file_name: pn.basename,
+        mime_type: credentials.fields.content_type,
+        params: params,
+        override_uri: credentials.url,
+        no_auth: true
+      )
+    end
+
+    def finalize_logos(theme_id:, keys: [])
+      request(
+        "/v1/meetings/themes/" + theme_id + "/finalizeLogos",
+        params: {
+          keys: keys
+        },
+        type: Put
+      )
+    end
+
+    def format_s3_upload_credentials(credentials)
+      credentials_key_map = {
+        content_type: "Content-Type",
+        logo_type: "logoType",
+        x_amz_algorithm: "X-Amz-Algorithm",
+        x_amz_credential: "X-Amz-Credential",
+        x_amz_date: "X-Amz-Date",
+        x_amz_security_token: "X-Amz-Security-Token",
+        policy: "Policy",
+        x_amz_signature: "X-Amz-Signature"
+      }
+
+      params = credentials.fields.attributes
+      params.transform_keys do |k|
+        if credentials_key_map.keys.include?(k)
+          credentials_key_map[k]
+        else
+          k.to_s
+        end
+      end
+    end
+  end
+end

data/lib/vonage/meetings.rb

@@ -0,0 +1,50 @@
+# typed: strict
+# frozen_string_literal: true
+
+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
+end

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

@@ -7,6 +7,8 @@ module Vonage
     attr_reader :data
 
     def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
       @type = attributes.fetch(:type, nil)
       @message = attributes.fetch(:message, nil)
       @opts = attributes.fetch(:opts, {})

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

@@ -2,11 +2,13 @@
 
 module Vonage
   class Messaging::Channels::MMS < Messaging::Message
-    MESSAGE_TYPES = ['image', 'vcard', 'audio', 'video']
+    MESSAGE_TYPES = ['text', 'image', 'vcard', 'audio', 'video', 'file', 'content'].freeze
 
     attr_reader :data
 
     def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
       @type = attributes.fetch(:type, nil)
       @message = attributes.fetch(:message, nil)
       @opts = attributes.fetch(:opts, {})
@@ -27,8 +29,16 @@ module Vonage
     end
 
     def verify_message
-      raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
-      raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
+      case type
+      when 'text'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be a String") unless message.is_a? String
+      when 'content'
+        raise Vonage::ClientError.new("Invalid parameter type. `:message` must be an Array") unless message.is_a? Array
+        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/channels/rcs.rb

@@ -0,0 +1,44 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::RCS < Messaging::Message
+    MESSAGE_TYPES = ['text', 'image', 'video', 'file', 'card', 'carousel', 'custom']
+
+    attr_reader :data
+
+    def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
+      @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 'card', 'carousel', '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/channels/sms.rb

@@ -5,6 +5,8 @@ module Vonage
     attr_reader :data
 
     def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
       @type = attributes.fetch(:type, 'text')
       @message = attributes.fetch(:message, nil)
       @opts = attributes.fetch(:opts, {})

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

@@ -2,11 +2,13 @@
 
 module Vonage
   class Messaging::Channels::Viber  < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image']
+    MESSAGE_TYPES = ['text', 'image', 'video', 'file']
 
     attr_reader :data
 
     def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
       @type = attributes.fetch(:type, nil)
       @message = attributes.fetch(:message, nil)
       @opts = attributes.fetch(:opts, {})
@@ -18,7 +20,7 @@ module Vonage
     private
 
     def build
-      data[:channel] = ' viber_service'
+      data[:channel] = 'viber_service'
       super
     end
 
@@ -33,6 +35,13 @@ module Vonage
       when 'image'
         raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
         raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
+      when 'video'
+        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
+        raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
+        raise Vonage::ClientError.new(":thumb_url is required in :message") unless message[:thumb_url]
+      when 'file'
+        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
+        raise Vonage::ClientError.new(":url is required in :message") unless message[:url]
       end
     end
   end

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

@@ -2,11 +2,13 @@
 
 module Vonage
   class Messaging::Channels::WhatsApp < Messaging::Message
-    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file', 'template', 'custom']
+    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file', 'template', 'sticker', 'custom']
 
     attr_reader :data
 
     def initialize(attributes = {})
+      @to = attributes.fetch(:to, nil)
+      @from = attributes.fetch(:from, nil)
       @type = attributes.fetch(:type, nil)
       @message = attributes.fetch(:message, nil)
       @opts = attributes.fetch(:opts, {})
@@ -35,6 +37,8 @@ module Vonage
         raise Vonage::ClientError.new(":name is required in :template") unless message[:name]
         raise Vonage::ClientError.new(":whatsapp is required in :opts") unless opts[:whatsapp]
         raise Vonage::ClientError.new(":locale is required in :whatsapp") unless opts[:whatsapp][:locale]
+      when 'sticker'
+        raise Vonage::ClientError.new(":message must contain either :id or :url") unless message.has_key?(:id) ^ message.has_key?(:url)
       when 'custom'
         raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
       else

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
@@ -24,7 +25,7 @@ module Vonage
 
     private
 
-    attr_accessor :type, :message, :opts
+    attr_accessor :to, :from, :type, :message, :opts
     attr_writer :data
 
     def after_initialize!
@@ -34,6 +35,8 @@ module Vonage
     end
 
     def build
+      data[:to] = to if to
+      data[:from] = from if from
       data[:message_type] = type
       data[type.to_sym] = message
       data.merge!(opts)

data/lib/vonage/messaging.rb

@@ -1,16 +1,21 @@
 # typed: true
 # frozen_string_literal: true
+require 'forwardable'
 
 module Vonage
   class Messaging < Namespace
-    self.authentication = BearerToken
+    extend Forwardable
+
+    self.authentication = BasicAndBearerToken
 
     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
@@ -20,10 +25,44 @@ 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(params)
+    def send(to:, from:, channel:, message_type:, failover: nil, **message)
+      params = { to: to, from: from, channel: channel, message_type: message_type }.merge(message)
+
+      if failover
+        raise ArgumentError.new("`failover` must be an array") unless failover.is_a?(Array)
+        raise ArgumentError.new("`failover` must not be empty") if failover.empty?
+        raise ArgumentError.new("`failover` must contain only Hashes") unless failover.all?(Hash)
+        params[:failover] = failover
+      end
+
       request('/v1/messages', params: params, 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
+    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
+    #   is set in `Config`
+    #
+    # @return [Boolean] true, if the JWT is verified, false otherwise
+    def verify_webhook_token(token:, signature_secret: @config.signature_secret)
+      JWT.verify_hs256_signature(token: token, signature_secret: signature_secret)
+    end
   end
 end