plivo 4.16.0 → 4.58.0

data/lib/plivo/resources/messages.rb

@@ -29,7 +29,24 @@ module Plivo
           to_number: @to_number,
           total_amount: @total_amount,
           total_rate: @total_rate,
-          units: @units
+          powerpack_id: @powerpack_id,
+          units: @units,
+          tendlc_campaign_id: @tendlc_campaign_id,
+          destination_country_iso2: @destination_country_iso2,
+          tendlc_registration_status: @tendlc_registration_status,
+          requester_ip: @requester_ip,
+          is_domestic: @is_domestic,
+          replaced_sender: @replaced_sender,
+          dlt_entity_id: @dlt_entity_id,
+          dlt_template_id: @dlt_template_id,
+          dlt_template_category: @dlt_template_category,
+          destination_network: @destination_network,
+          carrier_fees_rate: @carrier_fees_rate,
+          carrier_fees: @carrier_fees,
+          conversation_id: @conversation_id,
+          conversation_origin: @conversation_origin,
+          conversation_expiration_timestamp: @conversation_expiration_timestamp,
+          log: @log
         }.to_s
       end
     end
@@ -51,7 +68,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
@@ -68,72 +85,375 @@ module Plivo
       # @option options [String] :method The method used to call the url. Defaults to POST.
       # @option options [String] :log If set to false, the content of this message will not be logged on the Plivo infrastructure and the dst value will be masked (e.g., 141XXXXX528). Default is set to true.
       # @option options [String] :trackable set to false
-      #@option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
-      #@option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
-
-      def create(src, dst, text = nil, options = nil, powerpack_uuid = nil)
-        valid_param?(:src, src, [Integer, String, Symbol], false)
-        valid_param?(:text, text, [String, Symbol], false)
-        valid_param?(:dst, dst, Array, true)
-        valid_param?(:powerpack_uuid, powerpack_uuid, [String, Symbol], false)
-        dst.each do |dst_num|
-          valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
-        end
+      # @option options[Int]: message_expiry, int value
+      # @option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
+      # @option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
+      # @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.
+      # @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
+        value = src
+        if(value.is_a?(Hash))
+          valid_param?(:src, value[:src], [Integer, String, Symbol], false)
+          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)
 
-        if dst.include? src
-          raise InvalidRequestError, 'src and dst cannot be same'
-        end
+          if (value[:dst] == value[:src])
+            raise InvalidRequestError, 'src and dst cannot be same'
+          end
 
-        if src.nil? && powerpack_uuid.nil?
-          raise InvalidRequestError, 'src and powerpack uuid both cannot be nil'
-        end
+          if value.key?(:value).nil? && value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'value and powerpack uuid both cannot be nil'
+          end
 
-        if !src.nil? && !powerpack_uuid.nil?
-          raise InvalidRequestError, 'src and powerpack uuid both cannot be present'
-        end
+          if !value.key?(:value).nil? && !value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'value and powerpack uuid both cannot be present'
+          end
 
-        params = {
-          src: src,
-          dst: dst.join('<'),
-          text: text,
-          powerpack_uuid: powerpack_uuid
-        }
+          if !value.key?(:dst).nil? && !value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'dst is a required parameter'
+          end
 
-        return perform_create(params) if options.nil?
-        valid_param?(:options, options, Hash, true)
+          params = {
+            src: value[:src],
+            text: value[:text],
+            powerpack_uuid: value[:powerpack_uuid]
+          }
+          if (value[:dst].is_a?(Array))
+            value[:dst].each do |dst_num|
+               valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
+               params[:dst] = value[:dst].join('<')
+            end
+          else
+            params[:dst] = value[:dst]
+          end
 
-        if options.key?(:type) &&
-          valid_param?(:type, options[:type], String, true, ['sms', 'mms'])
-          params[:type] = options[:type]
-        end
+          #Handling optional params in One HASH
+          if value.key?(:type) && valid_param?(:type, value[:type],String, true, %w[sms mms whatsapp])
+            params[:type] = value[:type]
+          end
+
+          if value.key?(:url) && valid_param?(:url, value[:url], String, true)
+             params[:url] = value[:url]
+             if value.key?(:method) &&
+              valid_param?(:method, value[:method], String, true, %w[POST GET])
+              params[:method] = value[:method]
+             else
+               params[:method] = 'POST'
+             end
+          end         
+          
+          if value.key?(:log)
+            log = value[:log]
+            if log.is_a?(TrueClass) || log.is_a?(FalseClass)  # Check if log is boolean
+              params[:log] = log.to_s  # Convert boolean to string
+            elsif log.is_a?(String)  # Check if log is string
+              params[:log] = log
+            else
+              raise ArgumentError, "Invalid type for log parameter. Expected boolean or string."
+            end
+          end
+
+          if value.key?(:message_expiry) &&
+            valid_param?(:message_expiry, value[:message_expiry], [Integer, Integer], true)
+              params[:message_expiry] = value[:message_expiry]
+          end         
+
+          if value.key?(:trackable) &&
+              valid_param?(:trackable, value[:trackable], [TrueClass, FalseClass], true)
+              params[:trackable] = value[:trackable]
+          end
+
+          if value.key?(:media_urls) &&
+            valid_param?(:media_urls, value[:media_urls], Array, true)
+           params[:media_urls] = value[:media_urls]
+          end
 
-        if options.key?(:url) && valid_param?(:url, options[:url], String, true)
-          params[:url] = options[:url]
-          if options.key?(:method) &&
-             valid_param?(:method, options[:method], String, true, %w[POST GET])
-            params[:method] = options[:method]
+          if value.key?(:media_ids) &&
+            valid_param?(:media_ids, value[:media_ids], Array, true)
+           params[:media_ids] = value[:media_ids]
+          end
+
+          if value.key?(:dlt_entity_id) &&
+            valid_param?(:dlt_entity_id, value[:dlt_entity_id], String, true)
+           params[:dlt_entity_id] = value[:dlt_entity_id]
+          end
+
+          if value.key?(:dlt_template_id) &&
+            valid_param?(:dlt_template_id, value[:dlt_template_id], String, true)
+           params[:dlt_template_id] = value[:dlt_template_id]
+          end
+
+          if value.key?(:dlt_template_category) &&
+            valid_param?(:dlt_template_category, value[:dlt_template_category], String, true)
+           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
-            params[:method] = 'POST'
+            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
-        end
 
-        if options.key?(:log) &&
-           valid_param?(:log, options[:log], [TrueClass, FalseClass], true)
-          params[:log] = options[:log]
-        end
+          if value.key?(:template) && value.key?(:type) && (value[:type] != "whatsapp")
+            raise InvalidRequestError, 'template parameter is only applicable when type is whatsapp'
+          end
 
-        if options.key?(:trackable) &&
-          valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
-         params[:trackable] = options[:trackable]
+        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 options.key?(:media_urls) &&
-          valid_param?(:media_urls, options[:media_urls], Array, true)
-         params[:media_urls] = options[:media_urls]
+        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
-        if options.key?(:media_ids) &&
-          valid_param?(:media_ids, options[:media_ids], Array, true)
-         params[:media_ids] = options[:media_ids]
+
+        #legacy code compatibility
+        else
+          valid_param?(:src, src, [Integer, String, Symbol], false)
+          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|
+            valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
+          end
+  
+          if dst.include? src
+            raise InvalidRequestError, 'src and dst cannot be same'
+          end
+
+          if src.nil? && powerpack_uuid.nil?
+            raise InvalidRequestError, 'src and powerpack uuid both cannot be nil'
+          end
+
+          if !src.nil? && !powerpack_uuid.nil?
+            raise InvalidRequestError, 'src and powerpack uuid both cannot be present'
+          end
+
+          params = {
+            src: src,
+            text: text,
+            powerpack_uuid: powerpack_uuid
+          }
+
+          if (dst.is_a?(Array))
+            dst.each do |dst_num|
+              valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
+              params[:dst] = dst.join('<')
+            end
+          else
+            params[:dst] = dst
+          end
+
+          return perform_create(params) if options.nil?
+          valid_param?(:options, options, Hash, true)
+
+          if options.key?(:type) &&
+             valid_param?(:type, options[:type], String, true, %w[sms mms whatsapp])
+            params[:type] = options[:type]
+          end
+
+          if options.key?(:url) && valid_param?(:url, options[:url], String, true)
+            params[:url] = options[:url]
+            if options.key?(:method) &&
+               valid_param?(:method, options[:method], String, true, %w[POST GET])
+              params[:method] = options[:method]
+            else
+              params[:method] = 'POST'
+            end
+          end
+
+          if options.key?(:media_urls) &&
+            valid_param?(:media_urls, options[:media_urls], Array, true)
+           params[:media_urls] = options[:media_urls]
+          end
+          
+          if options.key?(:media_ids) &&
+            valid_param?(:media_ids, options[:media_ids], Array, true)
+           params[:media_ids] = options[:media_ids]
+          end
+
+          if options.key?(:log)
+            log = options[:log]
+            if log.is_a?(TrueClass) || log.is_a?(FalseClass)  # Check if log is boolean
+              params[:log] = log.to_s  # Convert boolean to string
+            elsif log.is_a?(String)  # Check if log is string
+              params[:log] = log
+            else
+              raise ArgumentError, "Invalid type for log parameter. Expected boolean or string."
+            end
+          end
+
+          if options.key?(:media_urls) &&
+            valid_param?(:media_urls, options[:media_urls], Array, true)
+           params[:media_urls] = options[:media_urls]
+          end
+  
+          if options.key?(:media_ids) &&
+            valid_param?(:media_ids, options[:media_ids], Array, true)
+           params[:media_ids] = options[:media_ids]
+          end
+
+          if options.key?(:message_expiry) &&
+            valid_param?(:message_expiry, options[:message_expiry], [Integer, Integer], true)
+              params[:message_expiry] = options[:message_expiry]
+          end
+
+          if options.key?(:trackable) &&
+            valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
+           params[:trackable] = options[:trackable]
+          end
+
+          if options.key?(:dlt_entity_id) &&
+            valid_param?(:dlt_entity_id, options[:dlt_entity_id], String, true)
+           params[:dlt_entity_id] = options[:dlt_entity_id]
+          end
+
+          if options.key?(:dlt_template_id) &&
+            valid_param?(:dlt_template_id, options[:dlt_template_id], String, true)
+           params[:dlt_template_id] = options[:dlt_template_id]
+          end
+
+          if options.key?(:dlt_template_category) &&
+            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   
+
+          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
@@ -141,6 +461,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
@@ -152,8 +473,14 @@ module Plivo
       # @option options [Int] :limit Used to display the number of results per page. The maximum number of results that can be fetched is 20.
       # @option options [Int] :offset Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results.
       # @option options [String] :error_code Delivery Response code returned by the carrier attempting the delivery. See Supported error codes {https://www.plivo.com/docs/api/message/#standard-plivo-error-codes}.
-      #@option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
-      #@option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
+      # @option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
+      # @option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
+      # @option options [String] :powerpack_id Filter the results by powerpack id
+      # @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)
@@ -161,7 +488,8 @@ module Plivo
         params = {}
         params_expected = %i[
           subaccount message_time message_time__gt message_time__gte
-          message_time__lt message_time__lte error_code
+          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) &&
@@ -185,11 +513,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 '\