plivo 4.25.0 → 4.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbaf4fabdd81296b5818890fc82e5d651ba24e8b
-  data.tar.gz: 9943aaacb63c0022e3052533cc951d72f30e2e1e
+  metadata.gz: 1ac7974dc26d379831ecc8637397c0cbf43156b5
+  data.tar.gz: 65b7a24f1cba9542117edefd8c19a48fc89e39bd
 SHA512:
-  metadata.gz: affc19347cdbec6fa100c74c058588a9f69c1225c9c496ebf506d05cb10cf2ff917a0b4d53a2c850756d9a3ed93e3df1bdb0954bc0593e8a8e7de5f5b9cba9c0
-  data.tar.gz: 3d357b1f45ff1949d6bb2e6d0cc9cdadd775366c62a534d602c5c448ea25d9859c193ffcd17593e6becbbabde923f96912adf63e0a47c1ae615e5a51b6d7211d
+  metadata.gz: 6b897b48d2cc18aeccbf0d5a9795fafe5f025d8d7375aad700bcdc05ea9c94a7786db3f667ed37af56df127749f66b3a6039deb90700582b8a536538e34c6278
+  data.tar.gz: 9dcc97d2cb1fe1d6473daf99652a5ec7fec9aaea5c8681b67e7acf4aff56f4261e9496cf096835ae64b79a0bea574e2e51a7c91169797fadbe4a856c6e4cbd20

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [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/)
+
+## [4.25.1](https://github.com/plivo/plivo-ruby/tree/v4.25.1) (2022-02-02)
+**Bugfix - Recording**
+- Fix for Start Recording API response issue
+
 ## [4.25.0](https://github.com/plivo/plivo-ruby/tree/v4.25.0) (2022-01-27)
 **Features - MPCStartCallRecording**
 - parameter name change from statusCallback to recordingCallback

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

data/lib/plivo/resources/calls.rb

@@ -492,7 +492,11 @@ module Plivo
       # @option options [String] :callback_method - The method which is used to invoke the callback_url URL. Defaults to POST.
       def record(call_uuid, options = nil)
         valid_param?(:call_uuid, call_uuid, [String, Symbol], true)
-        Call.new(@_client, resource_id: call_uuid).record(options)
+        response = Call.new(@_client, resource_id: call_uuid).record(options)
+        return Base::Response.new(Hash["api_id" => response.api_id,
+                                       "recording_id" => response.recording_id,
+                                       "message" => response.message,
+                                       "url" => response.url])
       end
 
       # @param [String] call_uuid

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.25.0".freeze
+  VERSION = "4.27.0".freeze
 end

data/lib/plivo/xml/dial.rb

@@ -3,7 +3,7 @@ module Plivo
     class Dial < Element
       @nestables = %w[Number User]
       @valid_attributes = %w[action method timeout hangupOnStar
-                             timeLimit callerId callerName confirmSound
+                             timeLimit callerId callerName confirmSound confirmTimeout
                              dialMusic confirmKey redirect
                              callbackUrl callbackMethod digitsMatch digitsMatchBLeg
                              sipHeaders]

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.25.0
+  version: 4.27.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday