vonage 7.5.0 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f62613660a4bd7e71b9a11ef299c20bd28296bc5f757ae82db513f667db0b687
-  data.tar.gz: 0db9c1d1b20dfff9936d7dd5ec495e7074242556f69461b57c5ef69bd244314b
+  metadata.gz: 242b084a9fa7d5182003af91d36beecd17e87067eb857baafea3d3b3e39c249e
+  data.tar.gz: 71ac8feb31afc39000b60d06e41b158effa0017dcd88c5dd799f87474c45c873
 SHA512:
-  metadata.gz: 73d49ed457a469c6caf6599b2f712fd035f3cde34daf350ae1ae4c18d510c94a01cf2e23902686c2429cfad066215ea94ef02d846c8ac001fd29a6d52c994867
-  data.tar.gz: cb3acb8a05f3e3c4ef773a6fca17731ef58929bda0277bbd54e7bc34c8c0983fbcca73e3efd3ddf68a12d62f9c6743efc3474b40d15e13a83bbdd38025ad730b
+  metadata.gz: 2fcd2b8066241a751dbdc7311272e1f5232c0aa740c8b1d6353d28e71295b1393035a8b27801d64503ad34d965b1794c345e3d3753bc7d11109db51222495576
+  data.tar.gz: 999ad595cb6efd3e8ac88cb306ffaf4b1267c356744985e107d6b7a8c488f8988b54ee57cc763cb47622587272bdbe9c8d994286b4067c270792b2743611b0e8

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

@@ -71,6 +71,7 @@ module Vonage
 
       # set headers
       request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
+      request['Accept'] = 'application/json'
       self.class.request_headers.each do |key, value|
         request[key] = value
       end

data/lib/vonage/version.rb

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

data/lib/vonage/voice.rb

@@ -19,8 +19,14 @@ module Vonage
     # @option params [required, Array<Hash>] :to
     #   Connect to a Phone (PSTN) number, SIP Endpoint, Websocket, or VBC extension.
     #
-    # @option params [required, Hash] :from
-    #   Connect to a Phone (PSTN) number.
+    # @option params [Hash] :from
+    #   Connect to a Phone (PSTN) number. Should not be set if **:random_from_number** is **true**
+    #   If not set, then **:random_from_number** will automatically be set to **true**
+    #
+    # @option params [Boolean] :random_from_number
+    #   Set to **true** to use random phone number as **from**. The number will be selected from the list
+    #   of the numbers assigned to the current application.
+    #   **random_from_number: true** cannot be used together with **:from**.
     #
     # @option params [Array<String>] :ncco
     #   The Vonage Call Control Object to use for this call.
@@ -55,6 +61,14 @@ module Vonage
     # @see https://developer.nexmo.com/api/voice#createCall
     #
     def create(params)
+      if params.key?(:from) && params[:random_from_number] == true
+        raise ClientError.new("`from` should not be set if `random_from_number` is `true`")
+      end
+
+      if params && !params.key?(:from)
+        params.merge!(random_from_number: true)
+      end
+
       request('/v1/calls', params: params, type: Post)
     end
 
@@ -101,7 +115,7 @@ module Vonage
       if params && !params.key?(:auto_advance)
         params.merge!(auto_advance: true)
       end
-      
+
       request('/v1/calls', params: params, response_class: ListResponse)
     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.0
+  version: 7.7.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-06-29 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