plivo 4.56.0 → 4.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f30ff0d80407fc770beb03a8889bf6dacafc8742
-  data.tar.gz: 930c4826d997a597f909dc4eb83aac4d43e6729e
+  metadata.gz: a90c7167882dbe60104e0ff29cf88e4b4df1d762
+  data.tar.gz: e52148f05ce9e96049b63ea1453f9c050932c303
 SHA512:
-  metadata.gz: 8293924cb842fb82415f1b3c4e1116a99340d9467d8827caa95906b4b249f2d82855d03379c8d80edff4cfb9ebcb4558933e7e9ae7f87ba85afb90e6f5b9eef7
-  data.tar.gz: 57337155f190fd2d39abd96e0f6bb8304d3428ccbef7dafa61f3e0cde573ce3d24184a44db61da8bc92a4b29cbf125066dc2acb35a1dbee581d2e35b148381cf
+  metadata.gz: 418f3f2d85ea8482e99314de098c8719dae66581a5f9ea9d470ecb7f3820b3829a0348ea704810928d73a513b3704fcce6b3c2058eab247c63fd7bcb6b2916cb
+  data.tar.gz: 7f69bf8b16f6d7408d0767b58f8b041fe89eb66c2360b8a0fbafd2cb3b6c517118875b19204f3c7259210e98dce611113814771d78f6ed5d82451597e2177e2c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [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.57.0'
 ```
 
 And then execute:

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/resources/messages.rb

@@ -92,6 +92,7 @@ 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.
       
       def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil)
         #All params in One HASH
@@ -227,6 +228,29 @@ 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
+
         #legacy code compatibility
         else
           valid_param?(:src, src, [Integer, String, Symbol], false)
@@ -372,6 +396,25 @@ 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
+
         end
         perform_create(params)
       end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.56.0".freeze
+  VERSION = "4.57.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.57.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-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -166,6 +166,7 @@ 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/phlo_client.rb
 - lib/plivo/resources.rb