plivo 4.20.0 → 4.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6472d23802b39086fb94ce313553e668bd3f210b
-  data.tar.gz: b620b7efeb18cbd2680d5701ba1054e23a0e3874
+  metadata.gz: 15f859f3b8d4d5c86051c7707f7a0b3519bbccc6
+  data.tar.gz: 4058af2b93014f1552e30cae972e7f3a30bc4b3b
 SHA512:
-  metadata.gz: c5bbacc139403864cf9ee636063d8eb9717a9b8b175a4265d08cdaa85c3813f678a97573940a2c8d90c15d364c535578932331b817b7278f96c0ccdaa6c81f2b
-  data.tar.gz: a2ec84374d288f88cba292e667193810f51c6565be8c5457ee8deb952eb1c6f160f62205fb5d85532dc0d542c3880fe4552d79eb20c63bf0afa0e97bf3c648ac
+  metadata.gz: f14e5c137e14abb3775c6aca039e03ec3027688500ea265c33dcb9c3b2bd861b186f19694449f7f758de6632a8ab6cda90844ab424ee219507d7047cdd178647
+  data.tar.gz: a91d7d11cda391bfc9d5079b2d5ea1d233cdf82c2cb2c7083c33cafb8e9be28d2bdafb59c8671a698b24728efe4a35e001087ee7a43ea7bf7ec172e0b8e43236

data/.github/workflows/unitTests.yml

@@ -0,0 +1,32 @@
+name: UnitTest
+
+on:
+  push:
+    branches: [ unitTests ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: UnitTest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+         ruby-version: [ '2.4', '2.5', '2.6' ,'2.7', '3.0' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Dependencies Installation
+        run: |
+          bundle install --without development
+      - name: Run Tests
+        run: |
+          ruby --version
+          bundle exec rake
+          rm Gemfile.lock
+  

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## [4.24.0](https://github.com/plivo/plivo-ruby/tree/v4.24.0) (2021-12-14)
+**Features - Voice**
+- Routing SDK traffic through Akamai endpoints for all the [Voice APIs](https://www.plivo.com/docs/voice/api/overview/)
+
+## [4.23.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.23.0) (2021-12-02)
+**Features - Messaging: 10 DLC**
+- 10DLC API's for brand and campaign support.
+
+## [4.22.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.22.0) (2021-11-11)
+**Features - Voice: Multiparty call**
+- 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.
+
+  Example for [send SMS](https://github.com/plivo/plivo-ruby#send-a-message)
+
 ## [4.20.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.20.0) (2021-08-04)
 - Added continue speak XML element support.
 

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec', '~> 3.0'
   gem 'simplecov'
   gem 'json'
+  gem 'rexml'
 end

data/README.md

@@ -1,6 +1,7 @@
 # plivo-ruby
 
-[![Build Status](https://travis-ci.org/plivo/plivo-ruby.svg?branch=4.0)](https://travis-ci.org/plivo/plivo-ruby)
+[![UnitTest](https://github.com/plivo/plivo-ruby/actions/workflows/unitTests.yml/badge.svg?branch=ns-ut-fix)](https://github.com/plivo/plivo-ruby/actions/workflows/unitTests.yml)
+[![Gem Version](https://badge.fury.io/rb/plivo.svg)](https://badge.fury.io/rb/plivo)
 
 The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
 
@@ -8,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.20.0'
+gem 'plivo', '>= 4.24.0'
 ```
 
 And then execute:
@@ -39,7 +40,7 @@ client = RestClient.new;
 Alternatively, you can specifiy the authentication credentials while initializing the `RestClient`.
 
 ```ruby
-client = RestClient.new('your_auth_id', 'your_auth_token');
+client = RestClient.new('<auth_id>', '<auth_token>');
 ```
 
 ### The basics
@@ -76,17 +77,15 @@ end
 ### Send a message
 
 ```ruby
-require 'rubygems'
-require 'plivo'
-
+require "plivo"
 include Plivo
 
 client = RestClient.new
-message_created = client.messages.create(
-  'your_source_number',
-  %w[your_destination_number_1 your_destination_number_2],
-  'Hello, world!'
-)
+response = client.messages.create(
+  src: '+14156667778',
+  dst: '+14156667777',
+  text: 'Hello, this is a sample text'
+  )
 ```
 
 ### Make a call
@@ -99,8 +98,8 @@ include Plivo
 
 client = RestClient.new
 call_made = client.calls.create(
-  'your_source_number',
-  ['your_destination_number'],
+  '+14156667778',
+  ['+14156667777'],
   'https://answer.url'
 )
 ```
@@ -149,10 +148,7 @@ require 'plivo'
 
 include Plivo
 
-AUTH_ID = 'AUTH_ID'
-AUTH_TOKEN = 'AUTH_TOKEN'
-
-client = Phlo.new(AUTH_ID, AUTH_TOKEN)
+client = Phlo.new('<auth_id>', '<auth_token>')
 
 # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
 # then initialize client as:
@@ -162,8 +158,8 @@ client = Phlo.new(AUTH_ID, AUTH_TOKEN)
 begin
     #parameters set in PHLO - params
     params = {
-       from: '9999999999',
-       to: '0000000000'
+       from: '+14156667778',
+       to: '+14156667777'
     }
     response = phlo.run(params)
     puts response
@@ -173,7 +169,7 @@ begin
 ```
 
 ### More examples
-Refer to the [Ruby API Reference](https://api-reference.plivo.com/latest/ruby/introduction/overview) for more examples. Also refer to the [guide to setting up dev environment](https://developers.plivo.com/getting-started/setting-up-dev-environment/) on [Plivo Developers Portal](https://developers.plivo.com) to setup a Sinatra server & use it to test out your integration in under 5 minutes.
+More examples are available [here](https://github.com/plivo/plivo-examples-ruby). Also refer to the [guides for configuring the Rails server to run various scenarios](https://www.plivo.com/docs/sms/quickstart/ruby-rails/) & use it to test out your integration in under 5 minutes.
 
 ## Reporting issues
 Report any feedback or problems with this version by [opening an issue on Github](https://github.com/plivo/plivo-ruby/issues).

data/lib/plivo/base.rb

@@ -6,9 +6,9 @@ module Plivo
   module Base
     PLIVO_API_URL = 'https://api.plivo.com'.freeze
 
-    API_VOICE = 'https://voice.plivo.com'.freeze
-    API_VOICE_FALLBACK_1 = 'https://voice-usw1.plivo.com'.freeze
-    API_VOICE_FALLBACK_2 = 'https://voice-use1.plivo.com'.freeze
+    API_VOICE = 'https://api.plivo.com'.freeze
+    API_VOICE_FALLBACK_1 = 'https://api.plivo.com'.freeze
+    API_VOICE_FALLBACK_2 = 'https://api.plivo.com'.freeze
 
     CALLINSIGHTS_API_URL = 'https://stats.plivo.com'.freeze
     PHLO_API_URL = 'https://phlorunner.plivo.com'.freeze

data/lib/plivo/resources/brand.rb

@@ -0,0 +1,62 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Brand < Base::Resource
+      def initialize(client, options = nil)
+        @_name = '10dlc/Brand'
+        @_identifier_string = 'brand_id'
+        super
+      end
+  
+      def to_s
+        {
+          api_id: @api_id,
+          brand: @brand
+        }.to_s
+      end
+    end
+  
+    class BrandInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = '10dlc/Brand'
+        @_resource_type = Brand
+        @_identifier_string = 'brand_id'
+        super
+      end
+  
+        ##
+        # Get an Brand
+        # @param [String] brand_id
+        # @return [Brand] Brand
+      def get(brand_id)
+        valid_param?(:brand_id, brand_id, [String, Symbol], true)
+        perform_get(brand_id)
+      end
+  
+        ##
+        # List all Brand
+        # @param [Hash] options
+        # @option options [String] :type
+        # @option options [Status] :status
+        # @return [Hash]
+      def list(options=nil)
+        return perform_list_without_object if options.nil?
+  
+        params = {}
+        %i[status type].each do |param|
+          if options.key?(param) && valid_param?(param, options[param],
+                                                   [String], true)
+            params[param] = options[param]
+          end
+        end  
+        perform_list_without_object(params)
+      end
+  
+        ##
+        # Create a new brand
+      def create(params)
+        perform_create(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources/campaign.rb

@@ -0,0 +1,62 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Campaign < Base::Resource
+      def initialize(client, options = nil)
+        @_name = '10dlc/Campaign'
+        @_identifier_string = 'campaign_id'
+        super
+      end
+  
+      def to_s
+        {
+          api_id: @api_id,
+          campaign: @campaign
+        }.to_s
+      end
+    end
+  
+    class CampaignInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = '10dlc/Campaign'
+        @_resource_type = Campaign
+        @_identifier_string = 'campaign_id'
+        super
+      end
+  
+        ##
+        # Get an Campaign
+        # @param [String] campaign_id
+        # @return [Campaign] Campaign
+      def get(campaign_id)
+        valid_param?(:campaign_id, campaign_id, [String, Symbol], true)
+        perform_get(campaign_id)
+      end
+  
+        ##
+        # List all Campaign
+        # @param [Hash] options
+        # @option options [String] :brand
+        # @option options [Status] :usecase
+        # @return [Hash]
+      def list(options=nil)
+        return perform_list_without_object if options.nil?
+  
+        params = {}
+        %i[usecase brand].each do |param|
+          if options.key?(param) && valid_param?(param, options[param],
+                                                   [String], true)
+            params[param] = options[param]
+          end
+        end  
+        perform_list_without_object(params)
+      end
+  
+        ##
+        # Create a new Camapign
+      def create(params)
+          perform_create(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources/messages.rb

@@ -69,72 +69,160 @@ 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[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 = 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?(: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],
+            dst: value[:dst],
+            text: value[:text],
+            powerpack_uuid: value[:powerpack_uuid]
+          }
 
-        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])
+            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) &&
+            valid_param?(:log, value[:log], [TrueClass, FalseClass], true)
+              params[:log] = value[:log]
+          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 value.key?(:media_ids) &&
+            valid_param?(:media_ids, value[:media_ids], Array, true)
+           params[:media_ids] = value[:media_ids]
+          end
+
+        #legacy code compatibility
+        else
+          valid_param?(:src, src, [Integer, String, Symbol], false)
+          valid_param?(:text, text, [String, Symbol], true)
+          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 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 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[:method] = 'POST'
+            params[:dst] = dst
           end
-        end
 
-        if options.key?(:log) &&
-           valid_param?(:log, options[:log], [TrueClass, FalseClass], true)
-          params[:log] = options[:log]
-        end
+          return perform_create(params) if options.nil?
+          valid_param?(:options, options, Hash, true)
 
-        if options.key?(:trackable) &&
-          valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
-         params[:trackable] = options[:trackable]
-        end
+          if options.key?(:type) &&
+             valid_param?(:type, options[:type], String, true, %w[sms mms])
+            params[:type] = options[:type]
+          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]
+          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) &&
+             valid_param?(:log, options[:log], [TrueClass, FalseClass], true)
+            params[:log] = options[:log]
+          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?(:trackable) &&
+            valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
+           params[:trackable] = options[:trackable]
+          end
         end
         perform_create(params)
       end
@@ -153,7 +241,9 @@ 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 [String] :powerpack_id Filter the results by powerpack id.
+      # @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
       def list(options = nil)
         return perform_list if options.nil?
         valid_param?(:options, options, Hash, true)

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/resources.rb

@@ -15,6 +15,8 @@ require_relative 'resources/nodes'
 require_relative 'resources/phlo_member'
 require_relative 'resources/call_feedback'
 require_relative 'resources/media'
+require_relative 'resources/brand'
+require_relative 'resources/campaign'
 require_relative 'resources/lookup'
 require_relative 'resources/regulatory_compliance'
 require_relative 'resources/multipartycalls'

data/lib/plivo/rest_client.rb

@@ -14,6 +14,7 @@ module Plivo
     attr_reader :powerpacks
     attr_reader :powerpacks, :media
     attr_reader :lookup
+    attr_reader :brand, :campaign
     attr_reader :end_users
     attr_reader :compliance_document_types, :compliance_documents, :compliance_requirements, :compliance_applications
 
@@ -39,6 +40,8 @@ module Plivo
       @messages = Resources::MessagesInterface.new(self)
       @powerpacks = Resources::PowerpackInterface.new(self)
       @media = Resources::MediaInterface.new(self)
+      @brand = Resources::BrandInterface.new(self)
+      @campaign = Resources::CampaignInterface.new(self)
       @subaccounts = Resources::SubaccountInterface.new(self)
       @recordings = Resources::RecordingInterface.new(self)
       @pricings = Resources::PricingInterface.new(self)

data/lib/plivo/utils.rb

@@ -227,7 +227,7 @@ module Plivo
         uri += "?"
       end
       if parsed_uri.query.to_s.length > 0
-        parsed_uri_query = URI.decode(parsed_uri.query)
+        parsed_uri_query = URI.decode_www_form_component(parsed_uri.query)
         if method == "GET"
           queryParamMap = getMapFromQueryString?(parsed_uri_query)
           params.keys.sort.each { |key|

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.20.0".freeze
+  VERSION = "4.24.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.20.0
+  version: 4.24.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,6 +152,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/unitTests.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -182,8 +183,10 @@ files:
 - lib/plivo/resources/accounts.rb
 - lib/plivo/resources/addresses.rb
 - lib/plivo/resources/applications.rb
+- lib/plivo/resources/brand.rb
 - lib/plivo/resources/call_feedback.rb
 - lib/plivo/resources/calls.rb
+- lib/plivo/resources/campaign.rb
 - lib/plivo/resources/conferences.rb
 - lib/plivo/resources/endpoints.rb
 - lib/plivo/resources/identities.rb