plivo 4.49.0 → 4.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed30e13d70b2483bb821add7ba7cb7207be1096d
-  data.tar.gz: 155092cdb1a1983dab872b2810ee6a0ad497daed
+  metadata.gz: e9064c62f724b62e2aeea109723c81030fe138ef
+  data.tar.gz: 8a0348e73d6792c79034d23cb1e7e90748304183
 SHA512:
-  metadata.gz: bb91ca43cb84672006c71ceb1aab588db855bae029840f7e353a9d768359cf354b4641075cd1212cfbbc95bd140f22290aca7f4b9f277500b8ba13ace6a1606e
-  data.tar.gz: 83e334ec371050c18eed54a74e8658d265fd04eeb60b6d37a8c56c18b508fa4c99fcada29d5d420efecea7e5dce3490212b8074746c7da49141a9e46962f9602
+  metadata.gz: 7f2331bc3b7eb435076f747b19e54a30662051b534baff258c5dbaba40baf6ae659f1d7abd073c5529e3fad97ec4aca3018896bd63aa7d7003759171a75fc798
+  data.tar.gz: cae52fb1615526472e629ca5455c12f4b38b06f9d8332f709487e1f5f2e3e213005981a9fd4a4b57a5285e6c4c3065614c7f5bf4b5e94f29ca9996f202d096a5

data/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Change Log
+
+## [4.51.0](https://github.com/plivo/plivo-ruby/tree/v4.51.0) (2023-10-16)
+**Introducing campaign_source & import partner camapign API**
+- New field campaign_source introduced
+- Import partner campaign API added
+
+## [4.50.0](https://github.com/plivo/plivo-ruby/tree/v4.50.0) (2023-10-13)
+**Feature - WhatsApp message support**
+- Added new params `template` and new message_type `whatsapp` to [send message API](https://www.plivo.com/docs/sms/api/message#send-a-message)
+- Added  new  `message_state` (`read`), `message_type`(`whatsapp`), `conversation_id`, `conversation_origin`, `conversation_expiration_timestamp` in [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages) and [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message) response
+
 ## [4.49.0](https://github.com/plivo/plivo-ruby/tree/v4.49.0) (2023-09-13)
 **Removing the faraday_middleware dependency and upgrade to farady latest version
 

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.49.0'
+gem 'plivo', '>= 4.51.0'
 ```
 
 And then execute:

data/lib/plivo/resources/campaign.rb

@@ -36,8 +36,9 @@ module Plivo
         ##
         # List all Campaign
         # @param [Hash] options
-        # @option options [String] :brand
+        # @option options [String] :brand_id
         # @option options [Status] :usecase
+        # @option options [String] :campaign_source
         # @option options [Status] :limit
         # @option options [Status] :offset
         # @return [Hash]
@@ -45,7 +46,7 @@ module Plivo
         return perform_list_without_object if options.nil?
   
         params = {}
-        %i[usecase brand limit offset].each do |param|
+        %i[usecase brand_id campaign_source limit offset].each do |param|
           if options.key?(param) && valid_param?(param, options[param],
                                                    [String, Integer], true)
             params[param] = options[param]
@@ -96,6 +97,19 @@ module Plivo
         perform_action_with_identifier(action, 'POST', options)
       end
       ##
+
+      #import campaign
+      def import(options=nil)
+        valid_param?(:options, options, Hash, true)
+        if not options[:campaign_id]
+          raise_invalid_request("campaign_id must be provided")
+        end
+        if not options[:campaign_alias]
+          raise_invalid_request("campaign_alias must be provided")
+        end
+        action = 'Import'
+        perform_action_with_identifier(action, 'POST', options)   
+      end
       # campaign number link
       #
       def number_link(options=nil)

data/lib/plivo/resources/messages.rb

@@ -42,7 +42,10 @@ module Plivo
           dlt_template_category: @dlt_template_category,
           destination_network: @destination_network,
           carrier_fees_rate: @carrier_fees_rate,
-          carrier_fees: @carrier_fees
+          carrier_fees: @carrier_fees,
+          conversation_id: @conversation_id,
+          conversation_origin: @conversation_origin,
+          conversation_expiration_timestamp: @conversation_expiration_timestamp
         }.to_s
       end
     end
@@ -64,7 +67,7 @@ module Plivo
       # @param [Array] dst
       # @param [String] text
       # @param [Hash] options
-      # @option options [String] :type The type of message. Should be `sms` or `mms`. Defaults to `sms`.
+      # @option options [String] :type The type of message. Should be `sms` or `mms` or `whatsapp`. Defaults to `sms`.
       # @option options [String] :url The URL to which with the status of the message is sent. The following parameters are sent to the URL:
       #                               - To - Phone number of the recipient
       #                               - From - Phone number of the sender
@@ -87,13 +90,14 @@ module Plivo
       # @option options [String] :dlt_entity_id This is the DLT entity id passed in the message request.
       # @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.
       
       def create(src = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil)
         #All params in One HASH
         value = src
         if(value.is_a?(Hash))
           valid_param?(:src, value[:src], [Integer, String, Symbol], false)
-          valid_param?(:text, value[:text], [String, Symbol], true)
+          valid_param?(:text, value[:text], [String, Symbol], false)
           valid_param?(:dst, value[:dst], [String, Array], true)
           valid_param?(:powerpack_uuid, value[:powerpack_uuid], [String, Symbol], false)
 
@@ -128,7 +132,7 @@ module Plivo
           end
 
           #Handling optional params in One HASH
-          if value.key?(:type) && valid_param?(:type, value[:type],String, true, %w[sms mms])
+          if value.key?(:type) && valid_param?(:type, value[:type],String, true, %w[sms mms whatsapp])
             params[:type] = value[:type]
           end
 
@@ -182,10 +186,44 @@ module Plivo
            params[:dlt_template_category] = value[:dlt_template_category]
           end
 
+          # handling whatsapp cases
+          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[:template].nil?
+            if value.key?(:template)
+              if value[:template].is_a?(String)
+                begin
+                  json_template = JSON.parse(value[:template])
+                  params[:template] = json_template
+                rescue JSON::ParserError => e
+                  raise InvalidRequestError, 'failed to parse template as JSON'
+                end
+              elsif value[:template].is_a?(Hash)
+                params[:template] = value[:template]
+              elsif value[:template].is_a?(Plivo::Template)
+                params[:template] = value[:template].to_hash
+              else
+                raise InvalidRequestError, 'invalid template format'
+              end
+            end
+          end
+          
+          if !params[:template].nil? && value[:template].is_a?(String)
+            if params.dig(:template, "name").to_s.empty? || params.dig(:template, "language").to_s.empty?
+              raise InvalidRequestError, 'template name and language must not be null or empty'
+            end
+          else
+            if !params[:template].nil? && (params.dig(:template, :name).to_s.empty? || params.dig(:template, :language).to_s.empty?)
+              raise InvalidRequestError, 'template name and language must not be null or empty'
+            end
+          end
+
         #legacy code compatibility
         else
           valid_param?(:src, src, [Integer, String, Symbol], false)
-          valid_param?(:text, text, [String, Symbol], true)
+          valid_param?(:text, text, [String, Symbol], false)
           valid_param?(:dst, dst, [String, Array], true)
           valid_param?(:powerpack_uuid, powerpack_uuid, [String, Symbol], false)
           dst.each do |dst_num|
@@ -223,7 +261,7 @@ module Plivo
           valid_param?(:options, options, Hash, true)
 
           if options.key?(:type) &&
-             valid_param?(:type, options[:type], String, true, %w[sms mms])
+             valid_param?(:type, options[:type], String, true, %w[sms mms whatsapp])
             params[:type] = options[:type]
           end
 
@@ -286,6 +324,41 @@ module Plivo
             valid_param?(:dlt_template_category, options[:dlt_template_category], String, true)
            params[:dlt_template_category] = options[:dlt_template_category]
           end
+
+          # handling whatsapp cases
+          if options.key?(:template) && options.key?(:type) && (options[:type] != "whatsapp")
+            raise InvalidRequestError, 'template parameter is only applicable when type is whatsapp'
+          end
+
+          if options.is_a?(Hash) && !options[:template].nil?
+            if options.key?(:template)
+              if options[:template].is_a?(String)
+                begin
+                  json_template = JSON.parse(options[:template])
+                  params[:template] = json_template
+                rescue JSON::ParserError => e
+                  raise InvalidRequestError, 'failed to parse template as JSON'
+                end
+              elsif options[:template].is_a?(Hash)
+                params[:template] = options[:template]
+              elsif options[:template].is_a?(Plivo::Template)
+                params[:template] = options[:template].to_hash
+              else
+                raise InvalidRequestError, 'invalid template format'
+              end
+            end
+          end
+
+          if !options[:template].nil? && options[:template].is_a?(String)
+            if options.dig(:template, "name").to_s.empty? || options.dig(:template, "language").to_s.empty?
+              raise InvalidRequestError, 'template name and language must not be null or empty'
+            end
+          else
+            if !options[:template].nil? && (options.dig(:template, :name).to_s.empty? || options.dig(:template, :language).to_s.empty?)
+              raise InvalidRequestError, 'template name and language must not be null or empty'
+            end
+          end   
+
         end
         perform_create(params)
       end
@@ -293,6 +366,7 @@ module Plivo
       # @param [Hash] options
       # @option options [String] :subaccount The id of the subaccount, if message details of the subaccount is needed.
       # @option options [String] :message_direction Filter the results by message direction. The valid inputs are inbound and outbound.
+      # @option options [String] :message_type Filter the results by message type. The valid inputs are sms mms and whatsapp.
       # @option options [String] :message_time Filter out messages according to the time of completion. The filter can be used in the following five forms:
       #                                        - message_time: The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all messages that were sent/received at 2012-03-21 11:47[:30], use message_time=2012-03-21 11:47[:30]
       #                                        - message_time\__gt: gt stands for greater than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all messages that were sent/received after 2012-03-21 11:47, use message_time\__gt=2012-03-21 11:47
@@ -310,6 +384,8 @@ module Plivo
       # @option options [string]:  tendlc_campaign_id - exact tendlc campaign id search
       # @option options [string]:destination_country_iso2 - valid 2 character country_iso2
       # @option options [string] : tendlc_registration_status - registered or unregistered enum allowed
+      # @option options [string] : conversation_id - The id of the conversation for whatsapp messages
+      # @option options [string] : conversartion_origin - The type of the conversation for whatsapp messages
       def list(options = nil)
         return perform_list if options.nil?
         valid_param?(:options, options, Hash, true)
@@ -318,6 +394,7 @@ module Plivo
         params_expected = %i[
           subaccount message_time message_time__gt message_time__gte
           message_time__lt message_time__lte error_code powerpack_id tendlc_campaign_id tendlc_registration_status destination_country_iso2
+          message_type conversation_id conversartion_origin
         ]
         params_expected.each do |param|
           if options.key?(param) &&
@@ -341,11 +418,17 @@ module Plivo
 
         if options.key?(:message_state) &&
            valid_param?(:message_state, options[:message_state],
-                        [String, Symbol], true, %w[queued sent failed delivered
+                        [String, Symbol], true, %w[queued sent failed delivered read
                                                    undelivered rejected])
           params[:message_state] = options[:message_state]
         end
 
+        if options.key?(:message_type) &&
+          valid_param?(:message_type, options[:message_type],
+                       [String, Symbol], true, %w[sms mms whatsapp])
+         params[:message_type] = options[:message_type]
+        end
+
         if options.key?(:limit) &&
            (options[:limit] > 20 || options[:limit] <= 0)
           raise_invalid_request('The maximum number of results that can be '\

data/lib/plivo/template.rb

@@ -0,0 +1,97 @@
+require_relative "resources"
+require_relative "base_client"
+require_relative "base"
+module Plivo
+    class Template
+      attr_accessor :name, :language, :components
+  
+      def initialize(name: nil, language: nil, components: nil)
+        @name = name
+        @language = language
+        @components = components
+      end
+  
+      def to_hash
+        {
+          name: @name,
+          language: @language,
+          components: @components&.map(&:to_hash)&.reject { |h| h.values.all?(&:nil?) }
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  
+    class Component
+      attr_accessor :type, :sub_type, :index, :parameters
+  
+      def initialize(type: nil, sub_type: nil, index: nil, parameters: nil)
+        @type = type
+        @sub_type = sub_type
+        @index = index
+        @parameters = parameters
+      end
+  
+      def to_hash
+        {
+          type: @type,
+          sub_type: @sub_type,
+          index: @index,
+          parameters: @parameters&.map(&:to_hash)&.reject { |h| h.values.all?(&:nil?) }
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  
+    class Parameter
+      attr_accessor :type, :text, :media, :currency, :date_time
+  
+      def initialize(type: nil, text: nil, media: nil, currency: nil, date_time: nil)
+        @type = type
+        @text = text
+        @media = media
+        @currency = currency
+        @date_time = date_time
+      end
+  
+      def to_hash
+        {
+          type: @type,
+          text: @text,
+          media: @media,
+          currency: @currency&.to_hash,
+          date_time: @date_time&.to_hash
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  
+    class Currency
+      attr_accessor :fallback_value, :currency_code, :amount_1000
+  
+      def initialize(fallback_value: nil, currency_code: nil, amount_1000: nil)
+        @fallback_value = fallback_value
+        @currency_code = currency_code
+        @amount_1000 = amount_1000
+      end
+  
+      def to_hash
+        {
+          fallback_value: @fallback_value,
+          currency_code: @currency_code,
+          amount_1000: @amount_1000
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  
+    class DateTime
+      attr_accessor :fallback_value
+  
+      def initialize(fallback_value: nil)
+        @fallback_value = fallback_value
+      end
+  
+      def to_hash
+        {
+          fallback_value: @fallback_value
+        }.reject { |_, v| v.nil? }
+      end
+    end
+  end
+  

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.49.0".freeze
+  VERSION = "4.51.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.49.0
+  version: 4.51.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -193,6 +193,7 @@ files:
 - lib/plivo/resources/regulatory_compliance.rb
 - lib/plivo/resources/token.rb
 - lib/plivo/rest_client.rb
+- lib/plivo/template.rb
 - lib/plivo/utils.rb
 - lib/plivo/version.rb
 - lib/plivo/xml.rb