plivo 4.21.0 → 4.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4221884a48c30837e399b3cccf82a2b316b1c8b
-  data.tar.gz: 439b0e03c1e2208bc8c00670decba683c9c4a8d9
+  metadata.gz: 99a81ae9a72d5cd9f5332d84de77f442c565b9a5
+  data.tar.gz: 274d0f0c5e278e9fb003eda9c2b022a6840a99b0
 SHA512:
-  metadata.gz: d349d186ca2bd0b10e6b38b29bb1d44f431e9e00fc97643e72f82c78ff154f1850df29a030bc6fcad71cf7e9e74831d0049b94a2eb5eb3c091fe833d364e461e
-  data.tar.gz: f2cc7bdb7e9aafa70a7954c20f6344a25833e565ad8db8d3bff362de546bb46139a886757b3290e4c3f5ca2ecb8e6726aedc3ebbf81dbd4563d0fed70758b656
+  metadata.gz: 8e5703701787286d5a30a520dedb09bd7c03593f0ac7f8d54a1cfa0ceafaaec31a8b91e135282022f8fcf2fc3fb79191e794bafe844733ac7fc09c337c1d86a3
+  data.tar.gz: edf485c5a4d6e3429dc1dec71fe32fe3d31662627bec06d2de407ee6320fc6b5b0bc1d5dce6ef79d6e88305fe76264dfbea5c848bc77e7f829a5168e3577cda9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## [4.22.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.22.0) (2021-11-11)
+**Features - Voice: Multiparty calls**
+- The [Add Multiparty Call API](https://www.plivo.com/docs/voice/api/multiparty-call/participants#add-a-participant) allows for greater functionality by accepting options like `start recording audio`, `stop recording audio`, and their HTTP methods.
+- [Multiparty Calls](https://www.plivo.com/docs/voice/api/multiparty-call/) now has new APIs to `stop` and `play` audio.
+
 ## [4.21.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.21.0) (2021-10-11)
 **Features - Messaging**
 - This version includes advancements to the Messaging Interface that deals with the [Send SMS/MMS](https://www.plivo.com/docs/sms/api/message#send-a-message) interface, Creating a standard structure for `request/input` arguments to make implementation easier and incorporating support for the older interface.

data/README.md

@@ -8,7 +8,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.21.0'
+gem 'plivo', '>= 4.22.0'
 ```
 
 And then execute:

data/lib/plivo/resources/multipartycalls.rb

@@ -60,7 +60,11 @@ module Plivo
                           enter_sound='beep:1',
                           enter_sound_method='GET',
                           exit_sound='beep:2',
-                          exit_sound_method='GET')
+                          exit_sound_method='GET',
+                          start_recording_audio=nil,
+                          start_recording_audio_method='GET',
+                          stop_recording_audio=nil,
+                          stop_recording_audio_method='GET')
         if (from and to) and call_uuid
           raise_invalid_request('cannot specify call_uuid when (from, to) is provided')
         end
@@ -117,6 +121,10 @@ module Plivo
         valid_param?(:enter_sound_method, enter_sound_method.upcase, String, false, %w[GET POST])
         is_one_among_string_url?(:exit_sound, exit_sound, false , %w[beep:1 beep:2 none])
         valid_param?(:exit_sound_method, exit_sound_method.upcase, String, false, %w[GET POST])
+        valid_param?(:start_recording_audio_method, start_recording_audio_method.upcase, String, false, %w[GET POST])
+        valid_url?(:start_recording_audio, start_recording_audio, false ) unless start_recording_audio.nil?
+        valid_param?(:stop_recording_audio_method, stop_recording_audio_method.upcase, String, false, %w[GET POST])
+        valid_url?(:stop_recording_audio, stop_recording_audio, false ) unless stop_recording_audio.nil?
         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
@@ -168,6 +176,10 @@ module Plivo
         params[:enter_sound_method] = enter_sound_method.upcase unless exit_sound_method.nil?
         params[:exit_sound] = exit_sound unless exit_sound.nil?
         params[:exit_sound_method] = exit_sound_method.upcase unless exit_sound_method.nil?
+        params[:start_recording_audio] = start_recording_audio unless start_recording_audio.nil?
+        params[:start_recording_audio_method] = start_recording_audio_method.upcase unless start_recording_audio_method.nil?
+        params[:stop_recording_audio] = stop_recording_audio unless stop_recording_audio.nil?
+        params[:stop_recording_audio_method] = stop_recording_audio_method.upcase unless stop_recording_audio_method.nil?
         perform_action_apiresponse('Participant', 'POST', params, true )
       end
 
@@ -204,7 +216,6 @@ module Plivo
         perform_action_apiresponse('Record/Resume', 'POST')
       end
 
-
       def start_participant_recording(member_id, file_format='mp3', status_callback_url=nil, status_callback_method='POST')
         valid_param?(:member_id, member_id, [String, Integer], true)
         MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], member_id: member_id).start_participant_recording(file_format, status_callback_url, status_callback_method)
@@ -246,6 +257,17 @@ module Plivo
         valid_param?(:member_id, member_id, [String, Integer], true)
         MultiPartyCallParticipant.new(@_client,resource_id: @id, member_id: member_id).get_participant
       end
+
+      def start_play_audio(member_id, url)
+        valid_param?(:member_id, member_id, [String, Integer], true)
+        valid_url?(:url, url, true)
+        MultiPartyCallMember.new(@_client, resource_id: @id, member_id: member_id).start_play_audio(url)
+      end
+
+      def stop_play_audio(member_id)
+        valid_param?(:member_id, member_id, [String, Integer], true)
+        MultiPartyCallMember.new(@_client, resource_id: @id, member_id: member_id).stop_play_audio
+      end
     end
 
     class MultiPartyCallParticipant < Base::SecondaryResource
@@ -311,6 +333,36 @@ module Plivo
       end
     end
 
+    class MultiPartyCallMember < Base::SecondaryResource
+      def initialize(client, options = nil)
+        @_name = 'MultiPartyCall'
+        @_identifier_string = 'mpc_uuid'
+        @_secondary_name = 'Member'
+        @_secondary_identifier_string = 'member_id'
+        super
+        @_is_voice_request = true
+        if options.key? :multi_party_prefix
+          @id = options[:multi_party_prefix] + '_' + @id
+        elsif @id.split('_').size > 1
+          nil
+        else
+          @id = 'uuid_' + @id
+        end
+        configure_secondary_resource_uri
+      end
+
+      def start_play_audio(url)
+        valid_url?(:url, url, true)
+        params = {}
+        params[:url] = url unless url.nil?
+        perform_action_apiresponse('Play', 'POST', params, true)
+      end
+
+      def stop_play_audio
+        perform_action_apiresponse('Play', 'DELETE')
+      end
+    end
+
     class MultiPartyCallInterface < Base::ResourceInterface
       def initialize(client, resource_list_json = nil)
         @_name = 'MultiPartyCall'
@@ -394,6 +446,8 @@ module Plivo
         options[:enter_sound_method] = 'GET' unless options.key?(:enter_sound_method)
         options[:exit_sound] = 'beep:2' unless options.key?(:exit_sound)
         options[:exit_sound_method] = 'GET' unless options.key?(:exit_sound_method)
+        options[:start_recording_audio_method] = 'GET' unless options.key?(:start_recording_audio_method)
+        options[:stop_recording_audio_method] = 'GET' unless options.key?(:stop_recording_audio_method)
         valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
         valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
         mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
@@ -403,7 +457,8 @@ module Plivo
                                                                           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[: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
 
       def start(options = {})
@@ -549,6 +604,30 @@ 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]).get_participant
       end
+
+      def start_play_audio(options = {})
+        valid_param?(:options, options, Hash, false)
+        if not options[:member_id]
+          raise_invalid_request("Member Id is mandatory")
+        end
+        valid_param?(:member_id, options[:member_id], [String, Integer], true)
+        valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
+        valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
+        mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
+        MultiPartyCallMember.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).start_play_audio(options[:url])
+      end
+
+      def stop_play_audio(options = {})
+        valid_param?(:options, options, Hash, false)
+        if not options[:member_id]
+          raise_invalid_request("Member Id is mandatory")
+        end
+        valid_param?(:member_id, options[:member_id], [String, Integer], true)
+        valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
+        valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
+        mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
+        MultiPartyCallMember.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).stop_play_audio
+      end
     end
   end
 end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.21.0".freeze
+  VERSION = "4.22.0".freeze
 end

data/lib/plivo/xml/multipartycall.rb

@@ -9,7 +9,9 @@ module Plivo
                              statusCallbackEvents statusCallbackUrl statusCallbackMethod
                              stayAlone coachMode mute hold startMpcOnEnter endMpcOnExit
                              enterSound enterSoundMethod exitSound exitSoundMethod
-                             onExitActionUrl onExitActionMethod relayDTMFInputs]
+                             onExitActionUrl onExitActionMethod relayDTMFInputs
+                             startRecordingAudio startRecordingAudioMethod
+                             stopRecordingAudio stopRecordingAudioMethod]
 
       VALID_ROLE_VALUES = %w[agent supervisor customer]
       VALID_METHOD_VALUES = %w[GET POST]
@@ -179,6 +181,26 @@ module Plivo
           raise PlivoXMLError, "invalid attribute value #{attributes[:customerHoldMusicUrl]} for customerHoldMusicUrl"
         end
 
+        if attributes[:startRecordingAudio] && !valid_url?(:startRecordingAudio, attributes[:startRecordingAudio], false)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:startRecordingAudio]} for startRecordingAudio"
+        end
+
+        if attributes[:stopRecordingAudio] && !valid_url?(:stopRecordingAudio, attributes[:stopRecordingAudio], false)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:stopRecordingAudio]} for stopRecordingAudio"
+        end
+
+        if attributes[:startRecordingAudioMethod] && !VALID_METHOD_VALUES.include?(attributes[:startRecordingAudioMethod].upcase)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:startRecordingAudioMethod]} for startRecordingAudioMethod"
+        elsif !attributes[:startRecordingAudioMethod]
+          attributes[:startRecordingAudioMethod] = 'GET'
+        end
+
+        if attributes[:stopRecordingAudioMethod] && !VALID_METHOD_VALUES.include?(attributes[:stopRecordingAudioMethod].upcase)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:stopRecordingAudioMethod]} for stopRecordingAudioMethod"
+        elsif !attributes[:stopRecordingAudioMethod]
+          attributes[:stopRecordingAudioMethod] = 'GET'
+        end
+
         raise PlivoXMLError, 'No MPC name set for the MPC' unless body
         super(body, attributes)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.21.0
+  version: 4.22.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday