vonage 7.5.1 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0058dda59784aa7cfa75fe455daaea8f77996a3a6bb13d0c4e9e9e3f3189d158'
-  data.tar.gz: f4f638d8a372169e7753e4be0c9a5569034ae94a003fd3abc4e4810d94d4d8e9
+  metadata.gz: 0c49e3250bfdfaea4ece849f64f65e3e7820dafb185fc9816ccb5ae7c2a37a7c
+  data.tar.gz: 402ae1133d19b7a6871642c480b2b2db162e0f560a1179513c088c5209f7e6f1
 SHA512:
-  metadata.gz: 55798156fde3c5cc807a1f1fd9e9e361a76254853fafe314f1c19f687596ebf100f69d9c9791ad31e1e2f22d2c00ddad76ee5e736a39dacfccf0c4d00564f95d
-  data.tar.gz: 58a1bbc1bccf731746a5cea98b973db35fc7aa201a263e7ea1f054c47b4fd8163c04a40677086278a07392a6c439d410cd1c85ec3dd4ac3594f1aa913cba01b2
+  metadata.gz: 1fdb9e9324d0a7c3d41b7670d20bfe16922a41ac97eb15a404a2a69394ee3d6b06fb7d37fbb90cf21dda1b15a35cbe64cfefc2236c2b3e1f0a36438b74e67b75
+  data.tar.gz: 8d80c1b1aef68c354170a5e906427883ae8c48b931cf845f101a72addee80e397517a5c64046a333585963e4a0fde20e2cc48353f7a64908744bd1b72e887195

data/README.md

@@ -98,7 +98,7 @@ By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respective
 
 ## JWT authentication
 
-To call newer endpoints that support JWT authentication such as the Voice API you'll
+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
@@ -194,6 +194,32 @@ response = client.voice.create({
 })
 ```
 
+## 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 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.
+
+```ruby
+# creating an SMS message
+message = Vonage::Messaging::Message.sms(message: 'Hello world!')
+
+# creating a WhatsApp Text message
+message = Vonage::Messaging::Message.whatsapp(type: 'text', message: 'Hello world!')
+
+# creating a WhatsApp Image message
+message = Vonage::Messaging::Message.whatsapp(type: 'image', message: { url: 'https://example.com/image.jpg' })
+
+# creating an MMS audio message with optional properties
+message = Vonage::Messaging::Message.mms(type: 'audio', message: { url: 'https://example.com/audio.mp3' }, opts: {client_ref: "abc123"})
+```
+
+Once the message data is created, you can then send the message.
+
+```ruby
+response = client.messaging.send(to: "447700900000", from: "447700900001", **message)
+```
+
 ## Documentation
 
 Vonage Ruby documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
@@ -218,7 +244,7 @@ The following is a list of Vonage APIs and whether the Ruby SDK provides support
 | Dispatch API | Beta |❌|
 | External Accounts API | Beta |❌|
 | Media API | Beta | ❌|
-| Messages API | Beta |❌|
+| Messages API | General Availability |✅|
 | Number Insight API | General Availability |✅|
 | Number Management API | General Availability |✅|
 | Pricing API | General Availability |✅|

data/lib/vonage/client.rb

@@ -68,6 +68,13 @@ module Vonage
       @messages ||= T.let(Messages.new(config), T.nilable(Vonage::Messages))
     end
 
+    # @return [Messaging]
+    #
+    sig { returns(T.nilable(Vonage::Messaging)) }
+    def messaging
+      @messaging ||= T.let(Messaging.new(config), T.nilable(Vonage::Messaging))
+    end
+
     # @return [NumberInsight]
     #
     sig { returns(T.nilable(Vonage::NumberInsight)) }

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

@@ -0,0 +1,39 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::Messenger < Messaging::Message
+    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file']
+
+    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] = 'messenger'
+      super
+    end
+
+    def verify_type
+      raise Vonage::ClientError.new("Invalid message type") unless MESSAGE_TYPES.include?(type)
+    end
+
+    def verify_message
+      case type
+      when 'text'
+        raise Vonage::ClientError.new(":message must be a String") unless message.is_a? String
+      else
+        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
+end

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

@@ -0,0 +1,34 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::MMS < Messaging::Message
+    MESSAGE_TYPES = ['image', 'vcard', 'audio', 'video']
+
+    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] = 'mms'
+      super
+    end
+
+    def verify_type
+      raise Vonage::ClientError.new("Invalid message type") unless MESSAGE_TYPES.include?(type)
+    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]
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::SMS < Messaging::Message
+    attr_reader :data
+
+    def initialize(attributes = {})
+      @type = attributes.fetch(:type, 'text')
+      @message = attributes.fetch(:message, nil)
+      @opts = attributes.fetch(:opts, {})
+      @data = {}
+
+      after_initialize!
+    end
+
+    private
+
+    def build
+      data[:channel] = 'sms'
+      super
+    end
+
+    def verify_type
+      raise Vonage::ClientError.new("Invalid message type") unless type == 'text'
+    end
+
+    def verify_message
+      raise Vonage::ClientError.new(":message must be a String") unless message.is_a? String
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::Viber  < Messaging::Message
+    MESSAGE_TYPES = ['text', 'image']
+
+    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] = ' viber_service'
+      super
+    end
+
+    def verify_type
+      raise Vonage::ClientError.new("Invalid message type") unless MESSAGE_TYPES.include?(type)
+    end
+
+    def verify_message
+      case type
+      when 'text'
+        raise Vonage::ClientError.new(":message must be a String") unless message.is_a? String
+      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]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# typed: true
+
+module Vonage
+  class Messaging::Channels::WhatsApp < Messaging::Message
+    MESSAGE_TYPES = ['text', 'image', 'audio', 'video', 'file', 'template', '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] = 'whatsapp'
+      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(":message must be a String") unless message.is_a? String
+      when 'template'
+        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
+        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(":policy is required in :whatsapp") unless opts[:whatsapp][:policy]
+        raise Vonage::ClientError.new(":locale is required in :whatsapp") unless opts[:whatsapp][:locale]
+      when 'custom'
+        raise Vonage::ClientError.new(":message must be a Hash") unless message.is_a? Hash
+      else
+        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
+end

data/lib/vonage/messaging/message.rb

@@ -0,0 +1,42 @@
+# typed: true
+
+module Vonage
+  class Messaging::Message
+    CHANNELS = {
+      sms: Vonage::Messaging::Channels::SMS,
+      mms: Vonage::Messaging::Channels::MMS,
+      whatsapp: Vonage::Messaging::Channels::WhatsApp,
+      messenger: Vonage::Messaging::Channels::Messenger,
+      viber: Vonage::Messaging::Channels::Viber
+    }
+
+    class << self
+      CHANNELS.keys.each do |method|
+        define_method method do |attributes|
+          CHANNELS[method].new(**attributes).data
+        end
+      end
+    end
+
+    def self.method_missing(method)
+      raise ClientError.new("Messaging channel must be one of the valid options.")
+    end
+
+    private
+
+    attr_accessor :type, :message, :opts
+    attr_writer :data
+
+    def after_initialize!
+      verify_type
+      verify_message
+      build
+    end
+
+    def build
+      data[:message_type] = type
+      data[type.to_sym] = message
+      data.merge!(opts)
+    end
+  end
+end

data/lib/vonage/messaging.rb

@@ -0,0 +1,29 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Messaging < Namespace
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # Send a Message.
+    #
+    # @example
+    #   message = Vonage::Messaging::Message.sms(message: "Hello world!")
+    #   response = client.messaging.send(to: "447700900000", from: "447700900001", **message)
+    #
+    # @option params [required, String] :to
+    #
+    # @option params [required, String] :from
+    #
+    # @option params [required, Hash] **message
+    #   The Vonage Message object to use for this message.
+    #
+    # @see https://developer.vonage.com/api/messages-olympus#SendMessage
+    #
+    def send(params)
+      request('/v1/messages', params: params, type: Post)
+    end
+  end
+end

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.5.1'
+  VERSION = '7.6.0'
 end

data/lib/vonage.rb

@@ -13,6 +13,7 @@ module Vonage
     'json' => 'JSON',
     'jwt' => 'JWT',
     'sms' => 'SMS',
+    'mms' => 'MMS',
     'tfa' => 'TFA',
     'version' => 'VERSION',
   })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.5.1
+  version: 7.6.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexmo-jwt
@@ -126,6 +126,13 @@ files:
 - lib/vonage/keys.rb
 - lib/vonage/logger.rb
 - lib/vonage/messages.rb
+- lib/vonage/messaging.rb
+- lib/vonage/messaging/channels/messenger.rb
+- lib/vonage/messaging/channels/mms.rb
+- lib/vonage/messaging/channels/sms.rb
+- lib/vonage/messaging/channels/viber.rb
+- lib/vonage/messaging/channels/whats_app.rb
+- lib/vonage/messaging/message.rb
 - lib/vonage/namespace.rb
 - lib/vonage/number_insight.rb
 - lib/vonage/numbers.rb
@@ -184,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: This is the Ruby Server SDK for Vonage APIs. To use it you'll need a Vonage