plivo 4.56.0 → 4.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f30ff0d80407fc770beb03a8889bf6dacafc8742
-  data.tar.gz: 930c4826d997a597f909dc4eb83aac4d43e6729e
+  metadata.gz: dcdea3382ce47522a95bff0850bcc67a582ebb54
+  data.tar.gz: 77652b31e99304dc2166f94fa9e7b5384d0c5fe6
 SHA512:
-  metadata.gz: 8293924cb842fb82415f1b3c4e1116a99340d9467d8827caa95906b4b249f2d82855d03379c8d80edff4cfb9ebcb4558933e7e9ae7f87ba85afb90e6f5b9eef7
-  data.tar.gz: 57337155f190fd2d39abd96e0f6bb8304d3428ccbef7dafa61f3e0cde573ce3d24184a44db61da8bc92a4b29cbf125066dc2acb35a1dbee581d2e35b148381cf
+  metadata.gz: dda1d4228d6a950a364da677d7fc561a090e79cf83991c4a14659bf1f37f56229c029fd3f12a1f0e8e6dfc3d3a38237d54dca200095c0e7873025d924285e9ec
+  data.tar.gz: e7e0832bb62f63262843787afc5a2107474c4e1133e3ef8b6cb088b8e0d32b15eb3de8afa2731b243af720fc26a908946539051140f8f134f9516c5027d130d1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [4.58.0](https://github.com/plivo/plivo-ruby/tree/v4.58.0) (2023-05-17)
+**Feature - Adding support for location whatsapp messages**
+- Added new param `location` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support location `whatsapp` messages
+- Added new param `location` in templates to support location based templated messages
+
+## [4.57.0](https://github.com/plivo/plivo-ruby/tree/v4.57.0) (2023-05-07)
+**Feature - Adding support for interactive whatsapp messages**
+- Added new param `interactive` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message) to support interactive `whatsapp` messages
+
 ## [4.56.0](https://github.com/plivo/plivo-ruby/tree/v4.56.0) (2023-04-18)
 **Feature - Support for dynamic button components when sending a templated WhatsApp message**
 - Added new param `payload` in templates to support dynamic payload in templates

data/README.md

@@ -9,7 +9,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'plivo', '>= 4.56.0'
+gem 'plivo', '>= 4.58.0'
 ```
 
 And then execute:
@@ -168,6 +168,354 @@ begin
   end
 ```
 
+
+## WhatsApp Messaging
+Plivo's WhatsApp API allows you to send different types of messages over WhatsApp, including templated messages, free form messages and interactive messages. Below are some examples on how to use the Plivo Go SDK to send these types of messages.
+
+### Templated Messages
+Templated messages are a crucial to your WhatsApp messaging experience, as businesses can only initiate WhatsApp conversation with their customers using templated messages.
+
+WhatsApp templates support 4 components:  `header` ,  `body`,  `footer`  and `button`. At the point of sending messages, the template object you see in the code acts as a way to pass the dynamic values within these components.  `header`  can accomodate `text` or `media` (images, video, documents) content.  `body`  can accomodate text content.  `button`  can support dynamic values in a `url` button or to specify a developer-defined payload which will be returned when the WhatsApp user clicks on the `quick_reply` button. `footer`  cannot have any dynamic variables.
+
+Example 1:
+```ruby
+require "plivo"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+template={ 
+            "name": "template_name",
+            "language": "en_US",
+            "components": [
+                {
+                    "type": "header",
+                    "parameters": [
+                        {
+                            "type": "media",
+                            "media": "https://xyz.com/s3/img.jpg"
+                        }
+                    ]
+                },
+                {
+                    "type": "body",
+                    "parameters": [
+                        {
+                            "type": "text",
+                            "text": "WA-Text"
+                        }
+                    ]
+                }
+            ]
+          }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        template:template,
+        url: "https://<yourdomain>.com/whatsapp_status/",
+)
+puts response
+```
+
+Example 2:
+```ruby
+require "plivo"
+require "plivo/template"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+header_media_param = Parameter.new(type: "media", media: "https://xyz.com/s3/img.jpg")
+body_text_params = [ Parameter.new(type: "text", text: "WA-Text") ]
+​
+header_component = Component.new(type: "header", parameters: [header_media_param])
+body_component = Component.new(type: "body", parameters: body_text_params)
+​
+template = Template.new(name: "template_name", language: "en_US", components: [header_component, body_component])
+​
+response = api.messages.create(
+    src: "+14156667778",
+    dst:"+14156667777",
+    type:"whatsapp",
+    template:template,
+    url: "https://<yourdomain>.com/whatsapp_status/",
+)
+puts response
+```
+> Note: It is also possible to create and manage objects directly within the SDK for whatsapp, providing a structured approach to message creation.
+
+### Free Form Messages
+Non-templated or Free Form WhatsApp messages can be sent as a reply to a user-initiated conversation (Service conversation) or if there is an existing ongoing conversation created previously by sending a templated WhatsApp message.
+
+#### Free Form Text Message
+Example:
+```ruby
+require "plivo"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        text:"Hello, this is sample text",
+        url: "https://<yourdomain>.com/whatsapp_status/",
+)
+puts response
+```
+
+#### Free Form Media Message
+Example:
+```ruby
+require "plivo"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        text:"Hello, this is sample text",
+        media_urls:["https://sample-videos.com/img/Sample-png-image-1mb.png"],
+        url: "https://<yourdomain>.com/wa_status/",
+)
+puts response
+```
+
+### Interactive Messages
+This guide shows how to send non-templated interactive messages to recipients using Plivo’s APIs.
+
+#### Quick Reply Buttons
+Quick reply buttons allow customers to quickly respond to your message with predefined options.
+
+Example:
+```ruby
+require "rubygems"
+require "/usr/src/app/lib/plivo.rb"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+interactive= {
+        "type": "button",
+        "header": {
+            "type": "media",
+            "media": "https://xyz.com/s3/img.jpg"
+        },
+        "body": {
+            "text": "Make your selection"
+        },
+        "action": {
+            "buttons": [
+                {
+                    "title": "Click here",
+                    "id": "bt1"
+                },
+                {
+                    "title": "Know More",
+                    "id": "bt2"
+                },
+                {
+                    "title": "Request Callback",
+                    "id": "bt3"
+                }
+            ]
+        }
+    }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        interactive:interactive
+)
+puts response
+```
+
+#### Interactive Lists
+Interactive lists allow you to present customers with a list of options.
+
+Example:
+```ruby
+require "rubygems"
+require "/usr/src/app/lib/plivo.rb"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+interactive= {
+        "type": "list",
+        "header": {
+            "type": "text",
+            "text": "Welcome to Plivo"
+        },
+        "body": {
+            "text": "You can review the list of rewards we offer"
+        },
+        "footer": {
+            "text": "Yours Truly"
+        },
+        "action": {
+            "buttons": [{
+                "title": "Click here"
+            }],
+            "sections": [
+                {
+                    "title": "SECTION_1_TITLE",
+                    "rows": [
+                        {
+                            "id": "SECTION_1_ROW_1_ID",
+                            "title": "SECTION_1_ROW_1_TITLE",
+                            "description": "SECTION_1_ROW_1_DESCRIPTION"
+                        },
+                        {
+                            "id": "SECTION_1_ROW_2_ID",
+                            "title": "SECTION_1_ROW_2_TITLE",
+                            "description": "SECTION_1_ROW_2_DESCRIPTION"
+                        }
+                    ]
+                },
+                {
+                    "title": "SECTION_2_TITLE",
+                    "rows": [
+                        {
+                            "id": "SECTION_2_ROW_1_ID",
+                            "title": "SECTION_2_ROW_1_TITLE",
+                            "description": "SECTION_2_ROW_1_DESCRIPTION"
+                        },
+                        {
+                            "id": "SECTION_2_ROW_2_ID",
+                            "title": "SECTION_2_ROW_2_TITLE",
+                            "description": "SECTION_2_ROW_2_DESCRIPTION"
+                        }
+                    ]
+                }
+            ]
+        }
+    }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        interactive:interactive
+)
+puts response
+```
+
+#### Interactive CTA URLs
+CTA URL messages allow you to send links and call-to-action buttons.
+
+Example:
+```ruby
+require "rubygems"
+require "/usr/src/app/lib/plivo.rb"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+interactive= {
+        "type": "cta_url",
+        "header": {
+            "type": "media",
+            "media": "https://xyz.com/s3/img.jpg"
+        },
+        "body": {
+            "text": "Know More"
+        },
+        "footer": {
+            "text": "Plivo"
+        },
+        "action": {
+            "buttons": [
+                {
+                    "title": "Click here",
+                    "cta_url": "https:plivo.com"
+                }
+            ]
+        }
+    }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        interactive:interactive
+)
+puts response
+```
+
+### Location Messages
+This guide shows how to send templated and non-templated location messages to recipients using Plivo’s APIs.
+
+#### Templated Location Messages
+Example:
+```ruby
+require "rubygems"
+require "/usr/src/app/lib/plivo.rb"
+require "/usr/src/app/lib/plivo/template.rb"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+template= {
+        "name": "plivo_order_pickup",
+        "language": "en_US",
+        "components": [
+            {
+                "type": "header",
+                "parameters": [
+                    {
+                        "type": "location",
+                        "location": {
+                            "longitude": "122.148981",
+                            "latitude": "37.483307",
+                            "name": "Pablo Morales",
+                            "address": "1 Hacker Way, Menlo Park, CA 94025"
+                        }
+                    }
+                ]
+            }
+        ]
+    }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        template:template
+)
+puts response
+```
+
+#### Non-Templated Location Messages
+Example:
+```ruby
+require "rubygems"
+require "/usr/src/app/lib/plivo.rb"
+require "/usr/src/app/lib/plivo/location.rb"
+include Plivo
+
+api = RestClient.new("<auth_id>","<auth_token>")
+
+location= {
+        "longitude": "122.148981",
+        "latitude": "37.483307",
+        "name": "Pablo Morales",
+        "address": "1 Hacker Way, Menlo Park, CA 94025"
+    }
+
+response = api.messages.create(
+        src: "+14156667778",
+        dst:"+14156667777",
+        type:"whatsapp",
+        location:location
+)
+puts response
+```
+
 ### More examples
 More examples are available [here](https://github.com/plivo/plivo-examples-ruby). Also refer to the [guides for configuring the Rails server to run various scenarios](https://www.plivo.com/docs/sms/quickstart/ruby-rails/) & use it to test out your integration in under 5 minutes.
 

data/lib/plivo/interactive.rb

@@ -0,0 +1,139 @@
+require_relative "template"
+
+module Plivo
+  class Interactive
+    attr_accessor :type, :header, :body, :footer, :action
+
+    def initialize(type: nil, header: nil, body: nil, footer: nil, action: nil)
+      @type = type
+      @header = header
+      @body = body
+      @footer = footer
+      @action = action
+    end
+
+    def to_hash
+      {
+        type: @type,
+        header: @header&.to_hash,
+        body: @body&.to_hash,
+        footer: @footer&.to_hash,
+        action: @action&.to_hash
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Header
+    attr_accessor :type, :text, :media
+
+    def initialize(type: nil, text: nil, media: nil)
+      @type = type
+      @text = text
+      @media = media
+    end
+
+    def to_hash
+      {
+        type: @type,
+        text: @text,
+        media: @media
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Body
+    attr_accessor :text
+
+    def initialize(text: nil)
+      @text = text
+    end
+
+    def to_hash
+      {
+        text: @text
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Footer
+    attr_accessor :text
+
+    def initialize(text: nil)
+      @text = text
+    end
+
+    def to_hash
+      {
+        text: @text
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Action
+    attr_accessor :buttons, :sections
+
+    def initialize(buttons: nil, sections: nil)
+      @buttons = buttons ? buttons.map { |b| Buttons.new(**b) } : []
+      @sections = sections ? sections.map { |s| Section.new(**s) } : []
+    end
+
+    def to_hash
+      {
+        buttons: @buttons.map(&:to_hash),
+        sections: @sections.map(&:to_hash),
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Buttons
+    attr_accessor :id, :title, :cta_url
+
+    def initialize(id: nil, title: nil, cta_url: nil)
+      @id = id
+      @title = title
+      @cta_url = cta_url
+    end
+
+    def to_hash
+      {
+        id: @id,
+        title: @title,
+        cta_url: @cta_url
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Section
+    attr_accessor :title, :rows
+
+    def initialize(title: nil, rows: nil)
+      @title = title
+      @rows = rows ? rows.map { |r| Row.new(**r) } : []
+    end
+
+    def to_hash
+      {
+        title: @title,
+        rows: @rows.map(&:to_hash),
+      }.reject { |_, v| v.nil? }
+    end
+  end
+
+  class Row
+    attr_accessor :id, :title, :description
+
+    def initialize(id: nil, title: nil, description: nil)
+      @id = id
+      @title = title
+      @description = description
+    end
+
+    def to_hash
+      {
+        id: @id,
+        title: @title,
+        description: @description
+      }.reject { |_, v| v.nil? }
+    end
+  end
+end

data/lib/plivo/location.rb

@@ -0,0 +1,22 @@
+module Plivo
+    class Location
+      attr_accessor :latitude, :longitude, :name, :address
+
+      def initialize(latitude: nil, longitude: nil, name: nil, address: nil)
+        @latitude = latitude
+        @longitude = longitude
+        @name = name
+        @address = address
+      end
+  
+      def to_hash
+        {
+          latitude: @latitude,
+          longitude: @longitude,
+          name: @name,
+          address: @address
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  end
+  

data/lib/plivo/resources/messages.rb

@@ -92,6 +92,8 @@ module Plivo
       # @option options [String] :dlt_template_id This is the DLT template id passed in the message request. 
       # @option options [String] :dlt_template_category This is the DLT template category passed in the message request.
       # @option options [Hash] :template This is the template used in the whatsapp message request. It can handle both JSON and String.
+      # @option options [Hash] :interactive This is the interactive parameter used in the whatsapp message request. It can handle both JSON and String.
+      # @option options [Hash] :location This is the location parameter used in the whatsapp message request. It can handle both JSON and String.
       
       def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil)
         #All params in One HASH
@@ -227,6 +229,48 @@ module Plivo
             end
           end
 
+          if value.key?(:template) && value.key?(:type) && (value[:type] != "whatsapp")
+            raise InvalidRequestError, 'template parameter is only applicable when type is whatsapp'
+          end
+
+        if value.is_a?(Hash) && !value[:interactive].nil?
+          if value.key?(:interactive)
+            if value[:interactive].is_a?(String)
+              begin
+                json_interactive = JSON.parse(value[:interactive])
+                params[:interactive] = json_interactive
+              rescue JSON::ParserError => e
+                raise InvalidRequestError, 'failed to parse interactive as JSON'
+              end
+            elsif value[:interactive].is_a?(Hash)
+              params[:interactive] = value[:interactive]
+            elsif value[:interactive].is_a?(Plivo::Interactive)
+              params[:interactive] = value[:interactive].to_hash
+            else
+              raise InvalidRequestError, 'invalid interactive format'
+            end
+          end
+        end
+
+        if value.is_a?(Hash) && !value[:location].nil?
+          if value.key?(:location)
+            if value[:location].is_a?(String)
+              begin
+                json_location = JSON.parse(value[:location])
+                params[:location] = json_location
+              rescue JSON::ParserError => e
+                raise InvalidRequestError, 'failed to parse location as JSON'
+              end
+            elsif value[:location].is_a?(Hash)
+              params[:location] = value[:location]
+            elsif value[:location].is_a?(Plivo::Location)
+              params[:location] = value[:location].to_hash
+            else
+              raise InvalidRequestError, 'invalid location format'
+            end
+          end
+        end
+
         #legacy code compatibility
         else
           valid_param?(:src, src, [Integer, String, Symbol], false)
@@ -372,6 +416,44 @@ module Plivo
             end
           end   
 
+          if options.is_a?(Hash) && !options[:interactive].nil?
+            if options.key?(:interactive)
+              if options[:interactive].is_a?(String)
+                begin
+                  json_interactive = JSON.parse(options[:interactive])
+                  params[:interactive] = json_interactive
+                rescue JSON::ParserError => e
+                  raise InvalidRequestError, 'failed to parse interactive as JSON'
+                end
+              elsif options[:interactive].is_a?(Hash)
+                params[:interactive] = options[:interactive]
+              elsif options[:interactive].is_a?(Plivo::Interactive)
+                params[:interactive] = options[:interactive].to_hash
+              else
+                raise InvalidRequestError, 'invalid interactive format'
+              end
+            end
+          end
+
+          if options.is_a?(Hash) && !options[:location].nil?
+            if options.key?(:location)
+              if options[:location].is_a?(String)
+                begin
+                  json_location = JSON.parse(options[:location])
+                  params[:location] = json_location
+                rescue JSON::ParserError => e
+                  raise InvalidRequestError, 'failed to parse location as JSON'
+                end
+              elsif options[:location].is_a?(Hash)
+                params[:location] = options[:location]
+              elsif options[:location].is_a?(Plivo::Location)
+                params[:location] = options[:location].to_hash
+              else
+                raise InvalidRequestError, 'invalid location format'
+              end
+            end
+          end
+
         end
         perform_create(params)
       end

data/lib/plivo/template.rb

@@ -1,6 +1,7 @@
 require_relative "resources"
 require_relative "base_client"
 require_relative "base"
+require_relative "location"
 module Plivo
     class Template
       attr_accessor :name, :language, :components
@@ -41,15 +42,16 @@ module Plivo
     end
   
     class Parameter
-      attr_accessor :type, :text, :media, :payload, :currency, :date_time
+      attr_accessor :type, :text, :media, :payload, :currency, :date_time, :location
   
-      def initialize(type: nil, text: nil, media: nil, payload: nil, currency: nil, date_time: nil)
+      def initialize(type: nil, text: nil, media: nil, payload: nil, currency: nil, date_time: nil, location: nil)
         @type = type
         @text = text
         @media = media
         @payload = payload
         @currency = currency
         @date_time = date_time
+        @location = location
       end
   
       def to_hash
@@ -59,7 +61,8 @@ module Plivo
           media: @media,
           payload: @payload,
           currency: @currency&.to_hash,
-          date_time: @date_time&.to_hash
+          date_time: @date_time&.to_hash,
+          location: @location&.to_hash
         }.reject { |_, v| v.nil? }
       end
     end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.56.0".freeze
+  VERSION = "4.58.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.56.0
+  version: 4.58.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -166,7 +166,9 @@ files:
 - lib/plivo/base/response.rb
 - lib/plivo/base_client.rb
 - lib/plivo/exceptions.rb
+- lib/plivo/interactive.rb
 - lib/plivo/jwt.rb
+- lib/plivo/location.rb
 - lib/plivo/phlo_client.rb
 - lib/plivo/resources.rb
 - lib/plivo/resources/accounts.rb