plivo 4.43.0 → 4.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd620cb568e9aa01c45cbd076312392590407957
-  data.tar.gz: 522faeb8afa9ee5a898258055cae038c6eb01dcd
+  metadata.gz: 5a1adf70a4fde50a292d378f057a7f65bfa9ed7b
+  data.tar.gz: 5d89de13e75759f0cfbb7ca9661b43fa743ef8de
 SHA512:
-  metadata.gz: 8425ccce22185e160996a10571905c5ce6f9cd1a483b6db72c4ddd2054e7d0de60e10a4bd6ac270deace0baf480054001b084b74b06b1a6ba471e8da6d4cd90b
-  data.tar.gz: 37cc88e459b987be4b26aa2131f62671c76d74c4c3073f47c7ed4a231dd5e00d82b72bf5c1ec2806810645d39419002983183a1a3d160a52e08472bd9d2bce22
+  metadata.gz: 32ff933158008f134dbc6159cfd9f9bf512f1be42c73aa891afd805a354500065459b0e8d5a6fcac33957f9e3c49445ac903b4b28ca9aeeaf4a4b5213128263f
+  data.tar.gz: fad484cd5da48a0843ec94b182d3d3adb199505b7552cff1dcc017636eb34d917b1d2649ff0fac2519e21933b363807798c6fa89fcc5c05b1d662a5b7084df32

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [4.46.0](https://github.com/plivo/plivo-go/tree/v4.46.0) (2023-06-28)
+**Feature - Audio Streaming**
+- Added functionality to start, stop and fetch audio streams
+- Added functionality to create stream XML
+
+## [4.45.0](https://github.com/plivo/plivo-ruby/tree/v4.45.0) (2023-05-02)
+**Feature - CNAM Lookup**
+- Added New Param `cnam_lookup` in to the response of the [list all numbers API], [list single number API]
+- Added `cnam_lookup` filter to AccountPhoneNumber - list all my numbers API.
+- Added `cnam_lookup` parameter to buy number[Buy a Phone Number]  to configure CNAM Lookup while buying a US number
+- Added `cnam_lookup` parameter to update number[Update an account phone number] to configure CNAM Lookup while buying a US number
+
+
+## [4.44.0](https://github.com/plivo/plivo-ruby/tree/v4.38.2) (2023-03-16)
+**Feature : Added new param in getCallDetail api**
+- From now on we can see CNAM(Caller_id name) details at CDR level.
+
 ## [4.43.0](https://github.com/plivo/plivo-ruby/tree/v4.43.0) (2023-05-29)
 **Feature - Recording API changes**
 - Added `monthly_recording_storage_amount`, `recording_storage_rate`, `rounded_recording_duration`, and `recording_storage_duration` parameters to the response for [get single recording API](https://www.plivo.com/docs/voice/api/recording#retrieve-a-recording) and [get all recordings API](https://www.plivo.com/docs/voice/api/recording#list-all-recordings)
@@ -49,7 +66,6 @@
 **Adding new attribute - 'message_expiry' in Send Message API**
 - Added new attribute - message_expiry in Send Message API
 
-
 ## [4.34.0](https://github.com/plivo/plivo-ruby/tree/v4.34.0) (2022-12-16)
 **10DLC: Update Campaign API**
 - Added Update Campaign API
@@ -67,7 +83,6 @@
 -Added 3 new keys to AccountPhoneNumber object:`tendlc_registration_status`, `tendlc_campaign_id` and `toll_free_sms_verification` (https://www.plivo.com/docs/numbers/api/account-phone-number#the-accountphonenumber-object)
 -Added 3 new filters to AccountPhoneNumber - list all my numbers API:`tendlc_registration_status`, `tendlc_campaign_id` and `toll_free_sms_verification` (https://www.plivo.com/docs/numbers/api/account-phone-number#list-all-my-numbers)
 
-
 ## [4.30.2](https://github.com/plivo/plivo-ruby/tree/v4.30.2) (2022-09-28)
 **10DLC: Campaign request**
 - Added more attributes to create campaign request
@@ -76,7 +91,6 @@
 **stability - faraday upgrade**
 - faraday version upgrade
 
-
 ## [4.30.0](https://github.com/plivo/plivo-ruby/tree/v4.30.0) (2022-08-26)
 **Feature - 10DLC APIs**
 - Added new 10DLC APIs

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

data/lib/plivo/base_client.rb

@@ -33,7 +33,7 @@ module Plivo
           raise Exceptions::PlivoRESTError, "Resource at #{response[:url]} "\
           'couldn\'t be deleted'
         end
-      elsif !([200, 201, 202, 204, 207].include? response[:status])
+      elsif !([200, 201, 202, 204, 207, 206].include? response[:status])
         raise Exceptions::PlivoRESTError, "Received #{response[:status]} for #{method}"
       end
       @@voice_retry_count = 0

data/lib/plivo/resources/calls.rb

@@ -203,6 +203,73 @@ module Plivo
         @_client.send_request(resource_path, 'DELETE', nil, nil, false , is_voice_request: @_is_voice_request)
       end
 
+      def start_stream(service_url, options = nil)
+        valid_param?(:service_url, service_url, [String, Symbol], true)
+        if options.nil?
+          return perform_action('Stream', 'POST', { service_url: service_url }, true)
+        end
+
+        valid_param?(:options, options, Hash, true)
+
+        params = { service_url: service_url }
+
+        if options.key?(:bidirectional) &&
+          valid_param?(:bidirectional, options[:bidirectional], [TrueClass, FalseClass], false )
+          params[:bidirectional] = options[:bidirectional]
+        end
+
+        if options.key?(:audio_track) &&
+          valid_param?(:audio_track, options[:audio_track],
+                       [String, Symbol], false, %w[inbound outbound both])
+          params[:audio_track] = options[:audio_track]
+        end
+
+        if options.key?(:stream_timeout) &&
+          valid_param?(:stream_timeout, options[:stream_timeout], Integer, false)
+          params[:stream_timeout] = options[:stream_timeout]
+        end
+
+        if options.key?(:status_callback_url) &&
+          valid_param?(:status_callback_url, options[:status_callback_url], [String, Symbol], false)
+          params[:status_callback_url] = options[:status_callback_url]
+        end
+
+        if options.key?(:status_callback_method) &&
+          valid_param?(:status_callback_method, options[:status_callback_method],
+                       [String, Symbol], false, %w[GET POST get post])
+          params[:status_callback_method] = options[:status_callback_method]
+        end
+
+        if options.key?(:content_type) &&
+          valid_param?(:content_type, options[:content_type], [String, Symbol, Integer], false)
+          params[:content_type] = options[:content_type]
+        end
+
+        if options.key?(:extra_headers) &&
+          valid_param?(:extra_headers, options[:extra_headers], [String], false)
+          params[:extra_headers] = options[:extra_headers]
+        end
+        perform_action('Stream', 'POST', params, true)
+      end
+
+      def stop_all_streams
+        perform_action('Stream', 'DELETE', nil, false)
+      end
+
+      def stop_stream(stream_id)
+        valid_param?(:stream_id, stream_id, [String, Symbol, Integer], true)
+        perform_action('Stream/' + stream_id, 'DELETE', nil, false)
+      end
+
+      def get_all_streams
+        perform_action('Stream', 'GET', nil, true )
+      end
+
+      def get_stream(stream_id)
+        valid_param?(:stream_id, stream_id, [String, Symbol, Integer], true)
+        perform_action('Stream/' + stream_id, 'GET', nil, true)
+      end
+
       def to_s
         call_details = {
           answer_time: @answer_time,
@@ -233,7 +300,8 @@ module Plivo
           caller_name: @caller_name,
           stir_verification: @stir_verification,
           stir_attestation: @stir_attestation,
-          source_ip: @source_ip
+          source_ip: @source_ip,
+          cnam_lookup: @cnam_lookup
         }
         call_details = call_details.select {|k, v| !v.nil? }
         call_details.to_s
@@ -576,6 +644,62 @@ module Plivo
         valid_param?(:call_uuid, call_uuid, [String, Symbol], true)
         Call.new(@_client, resource_id: call_uuid).cancel_request
       end
+
+      # @param [String] service_url
+      # @param [Hash] options
+      # @option options [Boolean] :bidirectional
+      # @option options [String] :audio_track
+      # @option options [Int] :stream_timeout
+      # @option options [String] :status_callback_url
+      # @option options [String] :status_callback_method
+      # @option options [String] :content_type
+      # @option options [String] :extra_headers
+      def start_stream(call_uuid, service_url, options = {})
+        valid_param?(:call_uuid, call_uuid, [String, Symbol], true)
+        response = Call.new(@_client, resource_id: call_uuid).start_stream(service_url, options)
+        return Base::Response.new(Hash["api_id" => response.api_id,
+                                       "stream_id" => response.stream_id,
+                                       "message" => response.message])
+      end
+
+      def stop_all_streams(call_uuid)
+        valid_param?(:call_uuid, call_uuid, [String, Symbol], true )
+        Call.new(@_client, resource_id: call_uuid).stop_all_streams
+      end
+
+      def stop_stream(call_uuid, stream_id)
+        valid_param?(:call_uuid, call_uuid, [String, Symbol], true )
+        Call.new(@_client, resource_id: call_uuid).stop_stream(stream_id)
+      end
+
+      def get_all_streams(call_uuid)
+        valid_param?(:call_uuid, call_uuid, [String, Symbol], true )
+        response = Call.new(@_client, resource_id: call_uuid).get_all_streams
+        return Base::Response.new(Hash["api_id" => response.api_id,
+                                       "meta" => response.meta,
+                                       "objects" => response.objects])
+      end
+
+      def get_stream(call_uuid, stream_id)
+        valid_param?(:call_uuid, call_uuid, [String, Symbol], true )
+        response = Call.new(@_client, resource_id: call_uuid).get_stream(stream_id)
+        return Base::Response.new(Hash["api_id" => response.instance_variable_get(:@api_id),
+                                       "audio_track" => response.instance_variable_get(:@audio_track),
+                                       "bidirectional" => response.instance_variable_get(:@bidirectional),
+                                       "bill_duration" => response.instance_variable_get(:@bill_duration),
+                                       "billed_amount" => response.instance_variable_get(:@billed_amount),
+                                       "call_uuid" => response.instance_variable_get(:@call_uuid),
+                                       "created_at" => response.instance_variable_get(:@created_at),
+                                       "end_time" => response.instance_variable_get(:@end_time),
+                                       "plivo_auth_id" => response.instance_variable_get(:@plivo_auth_id),
+                                       "resource_uri" => response.instance_variable_get(:@resource_uri),
+                                       "rounded_bill_duration" => response.instance_variable_get(:@rounded_bill_duration),
+                                       "service_url" => response.instance_variable_get(:@service_url),
+                                       "start_time" => response.instance_variable_get(:@start_time),
+                                       "status" => response.instance_variable_get(:@status),
+                                       "status_callback_url" => response.instance_variable_get(:@status_callback_url),
+                                       "stream_id" => response.instance_variable_get(:@stream_id)])
+      end
     end
   end
 end

data/lib/plivo/resources/numbers.rb

@@ -9,10 +9,11 @@ module Plivo
         super
       end
 
-      def buy(app_id = nil, verification_info = nil)
+      def buy(app_id = nil, verification_info = nil, cnam_lookup = nil)
         params = {}
         params[:app_id] = app_id unless app_id.nil?
         params[:verification_info] = verification_info unless verification_info.nil?
+        params[:cnam_lookup] = cnam_lookup unless cnam_lookup.nil?
         perform_action(nil, 'POST', params, true)
       end
 
@@ -118,10 +119,10 @@ module Plivo
         end
       end
 
-      def buy(number, app_id = nil, verification_info = nil)
+      def buy(number, app_id = nil, verification_info = nil, cnam_lookup = nil)
         valid_param?(:number, number, [Integer, String, Symbol], true)
         PhoneNumber.new(@_client,
-                        resource_id: number).buy(app_id, verification_info)
+                        resource_id: number).buy(app_id, verification_info, cnam_lookup)
       end
     end
 
@@ -142,7 +143,7 @@ module Plivo
           params[:subaccount] = options[:subaccount]
         end
 
-        %i[alias app_id].each do |param|
+        %i[alias app_id cnam_lookup].each do |param|
           if options.key?(param) &&
              valid_param?(param, options[param], [String, Symbol], true)
             params[param] = options[param]
@@ -183,7 +184,8 @@ module Plivo
           tendlc_campaign_id: @tendlc_campaign_id,
           tendlc_registration_status: @tendlc_registration_status,
           toll_free_sms_verification: @toll_free_sms_verification,
-          renewal_date: @renewal_date
+          renewal_date: @renewal_date,
+          cnam_lookup: @cnam_lookup
         }.to_s
       end
     end
@@ -226,6 +228,9 @@ module Plivo
       # @option options [String] :renewal_date__lte Returns phone numbers that will be renewed on or before the specified date. Format: YYYY-MM-DD
       # @option options [String] :renewal_date__gt Returns phone numbers that will be renewed after the specified date. Format: YYYY-MM-DD
       # @option options [String] :renewal_date__gte Returns phone numbers that will be renewed on or after the specified date. Format: YYYY-MM-DD
+      # @option options [String] :cnam_lookup The Cnam Lookup Configuration associated with that number. The following values are valid:
+      #                                     - enabled - Returns the list of numbers for which Cnam Lookup configuration is enabled
+      #                                     - disabled - Returns the list of numbers for which Cnam Lookup configuration is disabled
       def list(options = nil)
         return perform_list if options.nil?
 
@@ -233,7 +238,7 @@ module Plivo
 
         params = {}
 
-        %i[number_startswith subaccount alias tendlc_campaign_id tendlc_registration_status toll_free_sms_verification renewal_date renewal_date__lt renewal_date__lte renewal_date__gt renewal_date__gte].each do |param|
+        %i[number_startswith subaccount alias tendlc_campaign_id tendlc_registration_status toll_free_sms_verification renewal_date renewal_date__lt renewal_date__lte renewal_date__gt renewal_date__gte cnam_lookup].each do |param|
           if options.key?(param) &&
              valid_param?(param, options[param], [String, Symbol], true)
             params[param] = options[param]
@@ -324,6 +329,7 @@ module Plivo
       # @option options [String] :alias The textual name given to the number.
       # @option options [String] :app_id The application id of the application that is to be linked.
       # @option options [String] :subaccount The auth_id of the subaccount to which this number should be added. This can only be performed by a main account holder.
+      # @option options [String] :cnam_lookup The Cnam Lookup configuration to enable/disable Cnam Lookup
       def update(number, options = nil)
         valid_param?(:number, number, [String, Symbol], true)
         Number.new(@_client,

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.43.0".freeze
+  VERSION = "4.46.0".freeze
 end

data/lib/plivo/xml/plivo_xml.rb

@@ -8,11 +8,11 @@ module Plivo
       end
 
       def to_xml
-        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_xml
+        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_xml.gsub("&quot;", "\"")
       end
 
       def to_s
-        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_s
+        '<?xml version="1.0" encoding="utf-8" ?>' + @response.to_s.gsub("&quot;", "\"")
       end
     end
   end

data/lib/plivo/xml/response.rb

@@ -2,7 +2,7 @@ module Plivo
   module XML
     class Response < Element
       @nestables = %w[Speak Play GetDigits GetInput Record Dial Message
-                      Redirect Wait Hangup PreAnswer Conference DTMF MultiPartyCall]
+                      Redirect Wait Hangup PreAnswer Conference DTMF MultiPartyCall Stream]
       @valid_attributes = []
 
       def initialize

data/lib/plivo/xml/stream.rb

@@ -0,0 +1,27 @@
+module Plivo
+  module XML
+    class Stream < Element
+      @nestables = []
+      @valid_attributes = %w[bidirectional audioTrack streamTimeout statusCallbackUrl
+                             statusCallbackMethod contentType extraHeaders]
+
+      SUPPORTED_BIDIRECTIONAL=%w(true false)
+      SUPPORTED_AUDIOTRACK=%w(inbound outbound both)
+      SUPPORTED_CALLBACKMETHOD=%w(GET POST)
+
+      def initialize(body, attributes = {})
+        if attributes[:bidirectional] && !SUPPORTED_BIDIRECTIONAL.include?(attributes[:bidirectional])
+          raise PlivoXMLError, "<Stream> bidirectional #{attributes[:bidirectional]} is not valid."
+        end
+        if attributes[:audioTrack] && !SUPPORTED_AUDIOTRACK.include?(attributes[:audioTrack])
+          raise PlivoXMLError, "<Stream> audioTrack #{attributes[:audioTrack]} is not valid."
+        end
+        if attributes[:statusCallbackMethod] && !SUPPORTED_CALLBACKMETHOD.include?(attributes[:statusCallbackMethod].upcase)
+          raise PlivoXMLError, "<Stream> statusCallbackMethod #{attributes[:statusCallbackMethod]} is not valid."
+        end
+        raise PlivoXMLError, 'No text set for Stream' unless body
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml.rb

@@ -31,6 +31,7 @@ require_relative 'xml/w'
 require_relative 'xml/plivo_xml'
 require_relative 'xml/multipartycall'
 require_relative 'xml/cont'
+require_relative 'xml/stream'
 include Plivo::Exceptions
 
 module Plivo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.43.0
+  version: 4.46.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -236,6 +236,7 @@ files:
 - lib/plivo/xml/s.rb
 - lib/plivo/xml/say_as.rb
 - lib/plivo/xml/speak.rb
+- lib/plivo/xml/stream.rb
 - lib/plivo/xml/sub.rb
 - lib/plivo/xml/user.rb
 - lib/plivo/xml/w.rb