plivo 4.26.0 → 4.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28692b913ed5944eadc3dc9cb233f821ac357681
-  data.tar.gz: 6f4ae15fc412b3eef3c09fe9588e5b65d4e0ccc1
+  metadata.gz: 91f541dc63837a9f4a0b79eb70e711da032861ee
+  data.tar.gz: 69f4ea6a4ad5fe0055b823a19c1b4ba58bdc76ea
 SHA512:
-  metadata.gz: a63734b4798e92b7cd8805783fd696d884fed366c15707f182da49562f192f600740f11997aa16132aaa5cbc115476cfb995532e310f480834e8e4f078f05722
-  data.tar.gz: 8c0564708aceb0ce7d2658fa39075b4c53c2549e3d8f21d3141b66091326551883042c7138eb8c39a0aeb15eb1c28ee93039ddb89011a14c73d2f5a1cc6acf0a
+  metadata.gz: ea87b969d9dc6d4f8bc7133d15b0d3225e64015898677262c334043e7afc6f67367f57f4a439f98bd678814423c4b0298175945dfee10c820502c38accc413c3
+  data.tar.gz: 1ad27edb2ed4f707d2e1a969e3d8f19b7f0650e2e47f59df3cc9ab4ee25674c7f9c003917f926e669ac32f7d94704644b6589872b5945e638b855acd5b4dddbf

data/CHANGELOG.md

@@ -1,4 +1,17 @@
 # Change Log
+
+## [4.28.0](https://github.com/plivo/plivo-go/tree/v4.28.0) (2022-07-11)
+**Feature - STIR Attestation**
+- Add stir attestation param as part of Get CDR and Get live call APIs Response
+
+## [4.27.1](https://github.com/plivo/plivo-ruby/tree/v4.27.1) (2022-06-30)
+- `from_number`, `to_number` and `stir_verification` added to filter param [Retrieve all calls] (https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)
+
+## [4.27.0](https://github.com/plivo/plivo-ruby/tree/v4.27.0) (2022-05-05)
+**Feature - List all recordings**
+- `from_number` and `to_number` added to filter param [List all recordings](https://www.plivo.com/docs/voice/api/recording#list-all-recordings)
+- `record_min_member_count` param added to [Add a participant to a multiparty call using API](https://www.plivo.com/docs/voice/api/multiparty-call/participants#add-a-participant)
+
 ## [4.26.0](https://github.com/plivo/plivo-ruby/tree/v4.26.0) (2022-03-24)
 **Feature - DialElement**
 - `confirmTimeout` parameter added to [The Dial element](https://www.plivo.com/docs/voice/xml/dial/)

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

data/lib/plivo/resources/calls.rb

@@ -231,7 +231,8 @@ module Plivo
           request_uuid: @request_uuid,
           direction: @direction,
           caller_name: @caller_name,
-          stir_verification: @stir_verification
+          stir_verification: @stir_verification,
+          stir_attestation: @stir_attestation
         }
         call_details = call_details.select {|k, v| !v.nil? }
         call_details.to_s
@@ -275,14 +276,14 @@ module Plivo
       # @option options [String] :parent_call_uuid - The call_uuid of the first leg in an ongoing conference call. It is recommended to use this parameter in scenarios where a member who is already present in the conference intends to add new members by initiating outbound API calls. This minimizes the delay in adding a new memeber to the conference.
       # @option options [Boolean] :error_parent_not_found - if set to true and the parent_call_uuid cannot be found, the API request would return an error. If set to false, the outbound call API request will be executed even if the parent_call_uuid is not found. Defaults to false.
       # @return [Call] Call
-      def create(from, to, answer_url, options = nil) 
+      def create(from, to, answer_url, options = nil)
         valid_param?(:from, from, [String, Symbol, Integer], true)
         valid_param?(:to, to, Array, true)
         to.each do |to_num|
           valid_param?(:to_num, to_num, [Integer, String, Symbol], true)
         end
         valid_param?(:answer_url, answer_url, [String, Symbol], true)
-      
+
 
         params = {
           from: from,
@@ -345,31 +346,6 @@ module Plivo
         return perform_list if options.nil?
         valid_param?(:options, options, Hash, true)
 
-        params = {}
-        params_expected = %i[
-          subaccount bill_duration bill_duration__gt bill_duration__gte
-          bill_duration__lt bill_duration__lte end_time end_time__gt
-          end_time__gte end_time__lt end_time__lte parent_call_uuid hangup_source
-        ]
-        params_expected.each do |param|
-          if options.key?(param) &&
-             valid_param?(param, options[param], [String, Symbol], true)
-            params[param] = options[param]
-          end
-        end
-
-        if options.key?(:call_direction) &&
-           valid_param?(:call_direction, options[:call_direction],
-                        [String, Symbol], true, %w[inbound outbound])
-          params[:call_direction] = options[:call_direction]
-        end
-
-        %i[offset limit hangup_cause_code].each do |param|
-          if options.key?(param) && valid_param?(param, options[param], [Integer, Integer], true)
-            params[param] = options[param]
-          end
-        end
-
         raise_invalid_request("Offset can't be negative") if options.key?(:offset) && options[:offset] < 0
 
         if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
@@ -377,6 +353,47 @@ module Plivo
           "fetched is 20. limit can't be more than 20 or less than 1")
         end
 
+        # initial list of possible params
+        params = %i[
+          bill_duration
+          bill_duration__gt
+          bill_duration__gte
+          bill_duration__lt
+          bill_duration__lte
+          call_direction
+          end_time
+          end_time__gt
+          end_time__gte
+          end_time__lt
+          end_time__lte
+          from_number
+          hangup_cause_code
+          hangup_source
+          limit
+          offset
+          parent_call_uuid
+          subaccount
+          to_number
+          stir_verification
+        ].reduce({}) do |result_hash, param|
+          if options.key?(param)
+            if param == :call_direction
+              if valid_param?(:call_direction, options[:call_direction],
+                  [String, Symbol], true, %w[inbound outbound])
+                result_hash[:call_direction] = options[:call_direction]
+              end
+            elsif %i[offset limit hangup_cause_code].include?(param)
+              if valid_param?(param, options[param], [Integer, Integer], true)
+                result_hash[param] = options[param]
+              end
+            elsif valid_param?(param, options[param], [String, Symbol], true)
+              result_hash[param] = options[param]
+            end
+          end
+
+          result_hash
+        end
+
         perform_list(params)
       end
 

data/lib/plivo/resources/multipartycalls.rb

@@ -35,6 +35,7 @@ module Plivo
                           delay_dial=0,
                           max_duration=14400,
                           max_participants=10,
+                          record_min_member_count=1,
                           wait_music_url=nil,
                           wait_music_method='GET',
                           agent_hold_music_url=nil,
@@ -95,6 +96,7 @@ module Plivo
         valid_multiple_destination_integers?(:delay_dial, delay_dial)
         valid_range?(:max_duration, max_duration, false, 300, 28800)
         valid_range?(:max_participants, max_participants, false, 2, 10)
+        valid_range?(:record_min_member_count, record_min_member_count, false, 1, 2)
         valid_url?(:wait_music_url, wait_music_url, false ) unless wait_music_url.nil?
         valid_param?(:wait_music_method, wait_music_method.upcase, String, false , %w[GET POST])
         valid_url?(:agent_hold_music_url, agent_hold_music_url, false) unless agent_hold_music_url.nil?
@@ -128,7 +130,7 @@ module Plivo
         if (to!=nil) && (ring_timeout.is_a?(String)) && (to.split('<').size < ring_timeout.split('<').size)
           raise_invalid_request("RingTimeout:number of ring_timout(s) should be same as number of destination(s)")
         end
-          
+
         if (to!=nil) && (delay_dial.is_a?(String)) && (to.split('<').size < delay_dial.split('<').size)
           raise_invalid_request("Delaydial : number of delay_dial(s) should be same as number of destination(s)")
         end
@@ -150,6 +152,7 @@ module Plivo
         params[:delay_dial] = delay_dial unless delay_dial.nil?
         params[:max_duration] = max_duration unless max_duration.nil?
         params[:max_participants] = max_participants unless max_participants.nil?
+        params[:record_min_member_count] = record_min_member_count unless record_min_member_count.nil?
         params[:wait_music_url] = wait_music_url unless wait_music_url.nil?
         params[:wait_music_method] = wait_music_method.upcase unless wait_music_method.nil?
         params[:agent_hold_music_url] = agent_hold_music_url unless agent_hold_music_url.nil?
@@ -235,7 +238,7 @@ module Plivo
         valid_param?(:member_id, member_id, [String, Integer], true)
         MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], member_id: member_id).resume_participant_recording
       end
-      
+
       def list_participants(call_uuid = nil )
         valid_param?(:call_uuid, call_uuid, String, false) unless call_uuid.nil?
         params = {}
@@ -405,7 +408,7 @@ module Plivo
         valid_range?(:offset, options[:offset], false, 0)
         perform_action(nil ,'GET', options ,true )
       end
-      
+
       def get(options = {})
         valid_param?(:options, options, Hash, false)
         valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
@@ -422,10 +425,11 @@ module Plivo
         options[:call_status_callback_method] = 'POST' unless options.key?(:call_status_callback_method)
         options[:confirm_key_sound_method] = 'GET' unless options.key?(:confirm_key_sound_method)
         options[:dial_music] = 'Real' unless options.key?(:dial_music)
-        options[:ring_timeout] = 45 unless options.key?(:ring_timeout) 
+        options[:ring_timeout] = 45 unless options.key?(:ring_timeout)
         options[:delay_dial] = 0 unless options.key?(:delay_dial)
         options[:max_duration] = 14400 unless options.key?(:max_duration)
         options[:max_participants] = 10 unless options.key?(:max_participants)
+        options[:record_min_member_count] = 1 unless options.key?(:record_min_member_count)
         options[:wait_music_method] = 'GET' unless options.key?(:wait_music_method)
         options[:agent_hold_music_method] = 'GET' unless options.key?(:agent_hold_music_method)
         options[:customer_hold_music_method] = 'GET' unless options.key?(:customer_hold_music_method)
@@ -453,11 +457,11 @@ module Plivo
         mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
 
         MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).add_participant(options[:role],options[:from],options[:to],options[:call_uuid],options[:caller_name],options[:call_status_callback_url],options[:call_status_callback_method],options[:sip_headers],options[:confirm_key],
-                                                                          options[:confirm_key_sound_url],options[:confirm_key_sound_method],options[:dial_music],options[:ring_timeout],options[:delay_dial],options[:max_duration], options[:max_participants],options[:wait_music_url],
-                                                                          options[:wait_music_method],options[:agent_hold_music_url],options[:agent_hold_music_method],options[:customer_hold_music_url],options[:customer_hold_music_method],
-                                                                          options[:recording_callback_url],options[:recording_callback_method],options[:status_callback_url],options[:status_callback_method],options[:on_exit_action_url], options[:on_exit_action_method],
-                                                                          options[:record],options[:record_file_format],options[:status_callback_events],options[:stay_alone], options[:coach_mode],options[:mute],options[:hold],options[:start_mpc_on_enter],options[:end_mpc_on_exit],
-                                                                          options[:relay_dtmf_inputs],options[:enter_sound],options[:enter_sound_method],options[:exit_sound],options[:exit_sound_method], options[:start_recording_audio], options[:start_recording_audio_method],
+                                                                                                            options[:confirm_key_sound_url],options[:confirm_key_sound_method],options[:dial_music],options[:ring_timeout],options[:delay_dial],options[:max_duration], options[:max_participants],options[:record_min_member_count],options[:wait_music_url],
+                                                                                                            options[:wait_music_method],options[:agent_hold_music_url],options[:agent_hold_music_method],options[:customer_hold_music_url],options[:customer_hold_music_method],
+                                                                                                            options[:recording_callback_url],options[:recording_callback_method],options[:status_callback_url],options[:status_callback_method],options[:on_exit_action_url], options[:on_exit_action_method],
+                                                                                                            options[:record],options[:record_file_format],options[:status_callback_events],options[:stay_alone], options[:coach_mode],options[:mute],options[:hold],options[:start_mpc_on_enter],options[:end_mpc_on_exit],
+                                                                                                            options[:relay_dtmf_inputs],options[:enter_sound],options[:enter_sound_method],options[:exit_sound],options[:exit_sound_method], options[:start_recording_audio], options[:start_recording_audio_method],
                                                                                                             options[:stop_recording_audio], options[:stop_recording_audio_method])
       end
 
@@ -560,7 +564,7 @@ module Plivo
         mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
         MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).resume_participant_recording
       end
-      
+
       def list_participants(options = {})
         valid_param?(:options, options, Hash, false)
         valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?

data/lib/plivo/resources/recordings.rb

@@ -26,7 +26,12 @@ module Plivo
           recording_start_ms: @recording_start_ms,
           recording_type: @recording_type,
           recording_url: @recording_url,
-          resource_uri: @resource_uri
+          resource_uri: @resource_uri,
+          from_number: @from_number,
+          to_number: @to_number,
+          mpc_name: @mpc_name,
+          conference_uuid: @conference_uuid,
+          mpc_uuid: @mpc_uuid
         }.to_s
       end
     end
@@ -43,6 +48,12 @@ module Plivo
       # @param [Hash] options
       # @option options [String] :subaccount auth_id of the subaccount. Lists only those recordings of the main accounts which are tied to the specified subaccount.
       # @option options [String] :call_uuid Used to filter recordings for a specific call.
+      # @option options [String] :from_number Used to filter recordings for a specific from_number.
+      # @option options [String] :to_number Used to filter recordings for a specific to_number.
+      # @option options [String] :conference_name Used to filter recordings for a specific conference_name.
+      # @option options [String] :mpc_name Used to filter recordings for a specific mpc_name.
+      # @option options [String] :conference_uuid Used to filter recordings for a specific conference_uuid.
+      # @option options [String] :mpc_uuid Used to filter recordings for a specific mpc_uuid.
       # @option options [String] :add_time Used to filter out recordings according to the time they were added.The add_time filter is a comparative filter that can be used in the following four forms:
       #                                    - add_time\__gt: gt stands for greater than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after 2012-03-21 11:47, use add_time\__gt=2012-03-21 11:47
       #                                    - add_time\__gte: gte stands for greater than or equal. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after or exactly at 2012-03-21 11:47[:30], use add_time\__gte=2012-03-21 11:47[:30]
@@ -59,6 +70,8 @@ module Plivo
         params_expected = %i[
           call_uuid add_time__gt add_time__gte
           add_time__lt add_time__lte
+          from_number to_number conference_uuid
+          conference_name mpc_name mpc_uuid
         ]
 
         params_expected.each do |param|

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.26.0".freeze
+  VERSION = "4.28.0".freeze
 end

data/lib/plivo/xml/multipartycall.rb

@@ -11,7 +11,7 @@ module Plivo
                              enterSound enterSoundMethod exitSound exitSoundMethod
                              onExitActionUrl onExitActionMethod relayDTMFInputs
                              startRecordingAudio startRecordingAudioMethod
-                             stopRecordingAudio stopRecordingAudioMethod]
+                             stopRecordingAudio stopRecordingAudioMethod recordMinMemberCount]
 
       VALID_ROLE_VALUES = %w[agent supervisor customer]
       VALID_METHOD_VALUES = %w[GET POST]
@@ -37,6 +37,12 @@ module Plivo
           attributes[:maxParticipants] = 10
         end
 
+        if attributes[:recordMinMemberCount] && (attributes[:recordMinMemberCount]<1 || attributes[:recordMinMemberCount]>2)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:recordMinMemberCount]} for recordMinMemberCount"
+        elsif !attributes[:recordMinMemberCount]
+          attributes[:recordMinMemberCount] = 1
+        end
+
         if attributes[:waitMusicMethod] && !VALID_METHOD_VALUES.include?(attributes[:waitMusicMethod].upcase)
           raise PlivoXMLError, "invalid attribute value #{attributes[:waitMusicMethod]} for waitMusicMethod"
         elsif !attributes[:waitMusicMethod]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.26.0
+  version: 4.28.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -155,7 +155,6 @@ files:
 - ".github/workflows/unitTests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - AUTHORS.md
 - CHANGELOG.md
 - Gemfile

data/.travis.yml

@@ -1,11 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-bundler_args: --without development
-rvm:
-  - ruby-head
-  - 2.4.0
-  - 2.3.0
-  - 2.2.0
-  - 2.1
-  - 2.0.0