plivo 4.51.0 → 4.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9064c62f724b62e2aeea109723c81030fe138ef
-  data.tar.gz: 8a0348e73d6792c79034d23cb1e7e90748304183
+  metadata.gz: 165ab55e98fbfd73f9ea8e8f7cebc6016a76e703
+  data.tar.gz: e33c4b9315f62bee5102194d593bec08bff5df3e
 SHA512:
-  metadata.gz: 7f2331bc3b7eb435076f747b19e54a30662051b534baff258c5dbaba40baf6ae659f1d7abd073c5529e3fad97ec4aca3018896bd63aa7d7003759171a75fc798
-  data.tar.gz: cae52fb1615526472e629ca5455c12f4b38b06f9d8332f709487e1f5f2e3e213005981a9fd4a4b57a5285e6c4c3065614c7f5bf4b5e94f29ca9996f202d096a5
+  metadata.gz: 6b7af2135d6c3107c4da88719a23c82134a304ec5c65c16dbe7983fe1ae9033098d99ee93f05a5e73021d4d4aa2b11336dec13f80dc40f625d597e6471d975ec
+  data.tar.gz: b11f266cecc2848ffda32719f9d4eb78583dc4d4aca26c58e7d16b9ab4fbf4ed5adfc3e0797fc6eb8c447b22593ce49a931951319390b820da0dc7681e95a724

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+
+## [4.53.0](https://github.com/plivo/plivo-ruby/tree/v4.53.0) (2023-11-08)
+**Feature - Verify Service**
+-Added Support for Verify Service Public API'S 
+-Create Session API(POST): To create a verify session (2FA). Allowed params recipient, method, channel, callback_url, app_uuid
+-Get Session API(GET): To retrieve a particular session
+-List Sessions : To retrieve all the sessions
+-Validate Session : To validate OTP for a particular session
+
+## [4.52.0](https://github.com/plivo/plivo-ruby/tree/v4.52.0) (2023-11-08)
+**[BETA] Feature - TollFree Verification API Support**
+- API support for Create, Update, Get, Delete, and List Tollfree Verification.
+- Added New Param `toll_free_sms_verification_id` and `toll_free_sms_verification_order_status` in to the response of the [list all numbers API], [list single number API]
+- Added `toll_free_sms_verification_order_status` filter to AccountPhoneNumber - list all my numbers API.
+
 ## [4.51.0](https://github.com/plivo/plivo-ruby/tree/v4.51.0) (2023-10-16)
 **Introducing campaign_source & import partner camapign API**
 - New field campaign_source introduced
@@ -17,6 +32,7 @@
 **Feature - Added New Param 'carrier_fees', 'carrier_fees_rate', 'destination_network' in Get Message and List Message APIs**
 - Added new params on message get and list response
 
+
 ## [4.47.0](https://github.com/plivo/plivo-ruby/tree/v4.47.0) (2023-08-03)
 **Feature - DLT parameters**
 - Added new params `DLTEntityID`, `DLTTemplateID`, `DLTTemplateCategory` to the [send message API](https://www.plivo.com/docs/sms/api/message/send-a-message/)

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.51.0'
+gem 'plivo', '>= 4.53.0'
 ```
 
 And then execute:
@@ -197,4 +197,4 @@ export PLIVO_API_PROD_HOST=<plivoapi_public_endpoint>
 (The docker container should be running)
 
 > Test code and unit tests can also be run within the container using
-`make run` and `make test` respectively. (`CONTAINER` argument should be omitted when running from the container)
+`make run` and `make test` respectively. (`CONTAINER` argument should be omitted when running from the container)

data/examples/tollfree_verification.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require "plivo"
+
+include Plivo
+include Plivo::Exceptions
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+api = RestClient.new(AUTH_ID, AUTH_TOKEN)
+
+begin
+  response = api.tollfree_verifications.get('uuid')
+      puts response
+rescue PlivoRESTError => e
+    puts 'Exception: ' + e.message
+end
+
+
+begin
+  response = api.tollfree_verifications.create('18773582986', '2FA', 'dasas', 
+    'd5a9c4d4-d086-42db-940f-e798d480d064', 'VERBAL', 'https://www.aa.com,http://google.com', 
+    '100', 'qwqwq')
+      puts response
+rescue PlivoRESTError => e
+    puts 'Exception: ' + e.message
+end
+
+begin
+response = api.tollfree_verifications.update('uuid', usecase: '2FA')
+    puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+begin
+response = api.tollfree_verifications.delete('uuid')
+    puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end

data/lib/plivo/base/resource_interface.rb

@@ -97,7 +97,7 @@ module Plivo
           objects: @_resource_list
         }
       end
-      
+
       def perform_action(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
         response = @_client.send_request(resource_path, method, params, nil, false, is_voice_request: @_is_voice_request)

data/lib/plivo/resources/numbers.rb

@@ -37,7 +37,9 @@ module Plivo
           voice_rate: @voice_rate,
           tendlc_campaign_id: @tendlc_campaign_id,
           tendlc_registration_status: @tendlc_registration_status,
-          toll_free_sms_verification: @toll_free_sms_verification
+          toll_free_sms_verification: @toll_free_sms_verification,
+          toll_free_sms_verification_id: @toll_free_sms_verification_id,
+          toll_free_sms_verification_order_status: @toll_free_sms_verification_order_status
         }.to_s
       end
     end
@@ -185,7 +187,9 @@ module Plivo
           tendlc_registration_status: @tendlc_registration_status,
           toll_free_sms_verification: @toll_free_sms_verification,
           renewal_date: @renewal_date,
-          cnam_lookup: @cnam_lookup
+          cnam_lookup: @cnam_lookup,
+          toll_free_sms_verification_id: @toll_free_sms_verification_id,
+          toll_free_sms_verification_order_status: @toll_free_sms_verification_order_status
         }.to_s
       end
     end
@@ -231,6 +235,8 @@ module Plivo
       # @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
+      # @option options [String] :toll_free_sms_verification_id The id of tollfree verification that the number is currently linked with.
+      # @option options [String] :toll_free_sms_verification_order_status Indicates the tollfree verification status of a number.
       def list(options = nil)
         return perform_list if options.nil?
 
@@ -238,7 +244,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 cnam_lookup].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 toll_free_sms_verification_order_status].each do |param|
           if options.key?(param) &&
              valid_param?(param, options[param], [String, Symbol], true)
             params[param] = options[param]

data/lib/plivo/resources/tollfree_verification.rb

@@ -0,0 +1,178 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+
+    class TollfreeVerification < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'TollfreeVerification'
+        @_identifier_string = 'tollfree_verification'
+        super
+      end
+
+      def update(options = nil)
+        return perform_update({}) if options.nil?
+
+        valid_param?(:options, options, Hash, true)
+
+        params = {}
+        params_expected = %i[ usecase usecase_summary profile_uuid optin_type optin_image_url volume message_sample callback_method callback_url extra_data additional_information ]
+        params_expected.each do |param|
+          if options.key?(param) &&
+             valid_param?(param, options[param], [String, Symbol], false)
+            params[param] = options[param]
+          end
+        end
+
+        perform_update(params)
+      end
+
+      def delete
+        perform_delete
+      end
+
+      def to_s
+        {
+          api_id: @api_id,
+          uuid: @uuid,
+          number: @number,
+          created_at: @created_at,
+          updated_at: @updated_at,
+          callback_method: @callback_url,
+          callback_url: @callback_url,
+          extra_data: @extra_data,
+          additional_information: @additional_information,
+          message_sample: @message_sample,
+          optin_image_url: @optin_image_url,
+          optin_type: @optin_type,
+          profile_uuid: @profile_uuid,
+          rejection_reason: @rejection_reason,
+          status: @status,
+          usecase: @usecase,
+          usecase_summary: @usecase_summary,
+          volume: @volume
+        }.delete_if { |key, value| value.nil? }.to_s
+      end
+    end
+
+    class TollfreeVerificationsInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'TollfreeVerification'
+        @_resource_type = TollfreeVerification
+        @_identifier_string = 'tollfree_verification'
+        super
+      end
+
+      ##
+      # Get an TollfreeVerification
+      # @param [String] uuid
+      # return [TollfreeVerification]
+      def get(uuid)
+        valid_param?(:uuid, uuid, [String, Symbol], true)
+        perform_get(uuid)
+      end
+
+      ##
+      # List all TollfreeVerification
+      # @param [Hash] options
+      # @option options [Int] :offset
+      # @option options [Int] :limit
+      # @return [Hash]
+      def list(options = nil)
+        return perform_list if options.nil?
+        valid_param?(:options, options, Hash, true)
+
+        params = {}
+        params_expected = %i[ profile_uuid number status created__lt created__gt usecase created__lte created__gte ]
+        params_expected.each do |param|
+          if options.key?(param) &&
+             valid_param?(param, options[param], [String, Symbol], true)
+            params[param] = options[param]
+          end
+        end
+
+        %i[offset limit].each do |param|
+          if options.key?(param) && valid_param?(param, options[param],
+                                                 [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)
+          raise_invalid_request('The maximum number of results that can be '\
+          "fetched is 20. limit can't be more than 20 or less than 1")
+        end
+
+        perform_list(params)
+      end
+
+      ##
+      # Create an TollfreeVerification
+      # @param [String] number
+      # @param [String] usecase
+      # @param [String] usecase_summary
+      # @param [String] profile_uuid
+      # @param [String] optin_type
+      # @param [String] optin_image_url
+      # @param [String] volume
+      # @param [String] message_sample
+      # @param [String] callback_url
+      # @param [String] callback_method
+      # @param [String] extra_data
+      # @param [String] additional_information
+      # return [TollfreeVerification] TollfreeVerification
+      def create(number, usecase, usecase_summary, profile_uuid, optin_type, optin_image_url, volume, message_sample, callback_url = nil, callback_method = nil, extra_data = nil, additional_information = nil)
+        valid_param?(:number, number, [String, Symbol], true)
+        valid_param?(:usecase, usecase, [String, Symbol], true)
+        valid_param?(:usecase_summary, usecase_summary, [String, Symbol], true)
+        valid_param?(:profile_uuid, profile_uuid, [String, Symbol], true)
+        valid_param?(:optin_type, optin_type, [String, Symbol], true)
+        valid_param?(:optin_image_url, optin_image_url, [String, Symbol], true)
+        valid_param?(:volume, volume, [String, Symbol], true)
+        valid_param?(:message_sample, message_sample, [String, Symbol], true)
+        valid_param?(:callback_url, callback_url, [String, Symbol], false)
+        valid_param?(:callback_method, callback_method, [String, Symbol], false)
+        valid_param?(:extra_data, extra_data, [String, Symbol], false)
+        valid_param?(:additional_information, additional_information, [String, Symbol], false)
+
+        params = {
+        number: number,
+        usecase: usecase,
+        usecase_summary: usecase_summary,
+        profile_uuid: profile_uuid,
+        optin_type: optin_type,
+        optin_image_url: optin_image_url,
+        volume: volume,
+        message_sample: message_sample,
+        callback_url: callback_url,
+        callback_method: callback_method,
+        extra_data: extra_data,
+        additional_information: additional_information
+        }.delete_if { |key, value| value.nil? }
+
+        return perform_create(params)
+      end
+
+      ##
+      # Update an TollfreeVerification
+      # @param [String] uuid
+      # @param [Hash] options
+      # return [TollfreeVerification]
+      def update(uuid, options = nil)
+        valid_param?(:uuid, uuid, [String, Symbol], true)
+        TollfreeVerification.new(@_client,
+                        resource_id: uuid).update(options)
+      end
+
+      ##
+      # Delete an TollfreeVerification.
+      # @param [String] uuid
+      def delete(uuid)
+        valid_param?(:uuid, uuid, [String, Symbol], true)
+        TollfreeVerification.new(@_client,
+                        resource_id: uuid).delete
+      end
+    end
+  end
+end

data/lib/plivo/resources/verify_session.rb

@@ -0,0 +1,106 @@
+module Plivo
+    module Resources
+        include Plivo::Utils
+        class Session < Base::Resource
+            def initialize(client, options = nil)
+                @_name = 'Session'
+                @_identifier_string = 'session_uuid'
+                super
+            end
+            def to_s
+                {
+                  api_id: @api_id,
+                  session_uuid: @session_uuid,
+                  app_uuid: @app_uuid,
+                  alias: @alias,
+                  recipient: @recipient,
+                  channel: @channel,
+                  status: @status,
+                  count: @count,
+                  requestor_ip: @requestor_ip,
+                  destination_country_iso2: @destination_country_iso2,
+                  destination_network: @destination_network,
+                  attempt_details: @attempt_details,
+                  charges: @charges,
+                  created_at: @created_at,
+                  updated_at: @updated_at
+                }.to_s
+            end
+        end    
+
+        class SessionInterface < Base::ResourceInterface
+            def initialize(client, resource_list_json = nil)
+                @_name = 'Verify/Session'
+                @_resource_type = Session
+                @_identifier_string = 'session_uuid'
+                super
+            end
+
+            # @param [String] session_uuid
+            def get(session_uuid)
+                perform_get(session_uuid)
+            end
+
+            def create(app_uuid = nil, recipient = nil,channel = nil,url = nil, method = nil)
+                valid_param?(:app_uuid, app_uuid, [String, Symbol], false)
+                valid_param?(:recipient, recipient, [Integer, String, Symbol], true)
+                valid_param?(:channel, channel, [String, Symbol], false)
+                valid_param?(:url, url, [String], false)
+                valid_param?(:method, method, String, false, %w[POST GET])
+
+                params = {
+                    app_uuid: app_uuid,
+                    recipient: recipient,
+                    channel: channel,
+                    url: url,
+                    method: method
+                }
+                perform_create(params)
+            end   
+            
+            def list(options = nil)
+                return perform_list if options.nil?
+                valid_param?(:options, options, Hash, true)
+                params = {}
+                params_expected = %i[
+                subaccount status session_time__gt session_time__gte
+                session_time__lt session_time__lte session_time country alias app_uuid recipient
+                ]
+
+                params_expected.each do |param|
+                    if options.key?(param) &&
+                       valid_param?(param, options[param], [String, Symbol], true)
+                      params[param] = options[param]
+                    end
+                end
+          
+                %i[offset limit].each do |param|
+                    if options.key?(param) &&
+                        valid_param?(param, options[param], [Integer, Integer], true)
+                        params[param] = options[param]
+                    end
+                end
+                
+                if options.key?(:limit) &&
+                    (options[:limit] > 20 || options[:limit] <= 0)
+                   raise_invalid_request('The maximum number of results that can be '\
+                   "fetched is 20. limit can't be more than 20 or less than 1")
+                end
+
+                raise_invalid_request("Offset can't be negative") if options.key?(:offset) && options[:offset] < 0
+
+                perform_list_without_object(params)
+            end
+            
+            def validate(session_uuid = nil, otp = nil)
+                valid_param?(:session_uuid, session_uuid, [String, Symbol], true)
+                valid_param?(:otp, otp, [String], true)
+                id = session_uuid
+                params = {
+                    otp: otp
+                }
+                perform_action_with_identifier(id, 'POST', params)
+            end    
+        end    
+    end    
+end    

data/lib/plivo/resources.rb

@@ -22,6 +22,8 @@ require_relative 'resources/profile'
 require_relative 'resources/lookup'
 require_relative 'resources/regulatory_compliance'
 require_relative 'resources/multipartycalls'
+require_relative 'resources/verify_session'
+require_relative 'resources/tollfree_verification'
 
 module Plivo
   module Resources

data/lib/plivo/rest_client.rb

@@ -18,6 +18,8 @@ module Plivo
     attr_reader :brand, :campaign, :profile
     attr_reader :end_users
     attr_reader :compliance_document_types, :compliance_documents, :compliance_requirements, :compliance_applications
+    attr_reader :verify_session
+    attr_reader :tollfree_verifications
 
     def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout = 5)
       configure_base_uri
@@ -64,6 +66,8 @@ module Plivo
       @compliance_documents = Resources::ComplianceDocumentsInterface.new(self)
       @compliance_requirements = Resources::ComplianceRequirementsInterface.new(self)
       @compliance_applications = Resources::ComplianceApplicationsInterface.new(self)
+      @verify_session = Resources::SessionInterface.new(self)
+      @tollfree_verifications = Resources::TollfreeVerificationsInterface.new(self)
     end
   end
 end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.51.0".freeze
+  VERSION = "4.53.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.51.0
+  version: 4.53.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,6 +158,7 @@ files:
 - examples/multi_party_call.rb
 - examples/phlos.rb
 - examples/regulatory_compliance.rb
+- examples/tollfree_verification.rb
 - lib/plivo.rb
 - lib/plivo/base.rb
 - lib/plivo/base/resource.rb
@@ -192,6 +193,8 @@ files:
 - lib/plivo/resources/recordings.rb
 - lib/plivo/resources/regulatory_compliance.rb
 - lib/plivo/resources/token.rb
+- lib/plivo/resources/tollfree_verification.rb
+- lib/plivo/resources/verify_session.rb
 - lib/plivo/rest_client.rb
 - lib/plivo/template.rb
 - lib/plivo/utils.rb