plivo 4.27.1 → 4.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41cd25f112799f4fb4e95c0fadd5b7ba21d22d94
-  data.tar.gz: f8fdff993484bbf582168aaa778e4d36673cec4e
+  metadata.gz: e9dc7434e8982f184b0e1896144431f32fc82a1e
+  data.tar.gz: 975f64c13a825a1aba8558b821fb2032557648a5
 SHA512:
-  metadata.gz: eb2714de044e486a8c098d78ece87266f80c3ce05bdc6db8b5bd87ffd41326c3ef63b1c420be142bd9a1bf4baa7a8b72ceec36114fa9d1e747b247bd42936e7d
-  data.tar.gz: 3e08b774f282d3b92207e0ff7eeaa1e31da0b54461dc705245a8760b448af584ca68b730ac6845341c91ea16ede9ab52f2e44595f87ecc4b0b9b11bb7eb676ab
+  metadata.gz: 24a3cb5257654ae4e8c200cec5ac0291fa407fe669832887258f4e06a7bf9f6715549c4ec0c59f058d6ed9c47d49a387019eae8ee23642725204a54f82bee039
+  data.tar.gz: 65c9323280aa2390745ee00d16e0505ee82802896d3d8fb4b0ef81f8e8d44d6ccf602fb133c8cdc8cf2e588177c02359b5a57fa755ddf9e1e40f768948cc8e06

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [4.30.0](https://github.com/plivo/plivo-go/tree/v4.30.0) (2022-08-26)
+**Feature - 10DLC APIs**
+- Added new 10DLC APIs
+
+## [4.29.0](https://github.com/plivo/plivo-go/tree/v4.29.0) (2022-08-01)
+**Feature - Token Creation**
+- `JWT Token Creation API` added functionality to create a new JWT token.
+
+## [4.28.0](https://github.com/plivo/plivo-go/tree/v4.28.0) (2022-07-11)
+**Feature - STIR Attestation**
+- Add stir attestation param as part of Get CDR and Get live call APIs Response
+
 ## [4.27.1](https://github.com/plivo/plivo-ruby/tree/v4.27.1) (2022-06-30)
 - `from_number`, `to_number` and `stir_verification` added to filter param [Retrieve all calls] (https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)
 

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

data/lib/plivo/base/resource_interface.rb

@@ -54,7 +54,7 @@ module Plivo
 
       def perform_create(params, use_multipart_conn=false)
         Response.new(
-          @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn, is_voice_request: @_is_voice_request),
+          @_client.send_request(@_resource_uri, 'POST', params, 10, use_multipart_conn, is_voice_request: @_is_voice_request),
           @_identifier_string
         )
       end
@@ -98,6 +98,14 @@ module Plivo
         self
       end
 
+      def perform_action_with_identifier(identifier = nil, method = 'GET', params = nil)
+        resource_path = identifier ? @_resource_uri + identifier + '/' : @_resource_uri
+        Response.new(
+          @_client.send_request(resource_path, method, params, nil, false, is_voice_request: @_is_voice_request),
+          @_identifier_string
+        )
+      end
+
       def perform_list_without_object(params = nil)
         response_json = @_client.send_request(@_resource_uri, 'GET', params, nil, false, is_voice_request: @_is_voice_request)
         parse_and_set(response_json)

data/lib/plivo/resources/brand.rb

@@ -38,24 +38,43 @@ module Plivo
         # @param [Hash] options
         # @option options [String] :type
         # @option options [Status] :status
+        # @option options [Status] :limit
+        # @option options [Status] :offset
         # @return [Hash]
       def list(options=nil)
         return perform_list_without_object if options.nil?
   
         params = {}
-        %i[status type].each do |param|
+        %i[status type limit offset].each do |param|
           if options.key?(param) && valid_param?(param, options[param],
-                                                   [String], true)
+                                                   [String, Integer], true)
             params[param] = options[param]
           end
-        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
+        if options.key?(:offset) && options[:offset] < 0
+          raise_invalid_request("Offset can't be negative")
+        end
         perform_list_without_object(params)
       end
   
         ##
         # Create a new brand
-      def create(params)
-        perform_create(params)
+      def create(options=nil)
+        valid_param?(:options, options, Hash, true)
+        if not options[:brand_alias]
+          raise_invalid_request("brand_alias must be provided")
+        end
+        if not options[:brand_type]
+          raise_invalid_request("brand_type must be provided")
+        end
+        if not options[:profile_uuid]
+          raise_invalid_request("profile_uuid must be provided")
+        end
+        perform_create(options)
       end
     end
   end

data/lib/plivo/resources/calls.rb

@@ -231,7 +231,8 @@ module Plivo
           request_uuid: @request_uuid,
           direction: @direction,
           caller_name: @caller_name,
-          stir_verification: @stir_verification
+          stir_verification: @stir_verification,
+          stir_attestation: @stir_attestation
         }
         call_details = call_details.select {|k, v| !v.nil? }
         call_details.to_s

data/lib/plivo/resources/campaign.rb

@@ -38,25 +38,90 @@ module Plivo
         # @param [Hash] options
         # @option options [String] :brand
         # @option options [Status] :usecase
+        # @option options [Status] :limit
+        # @option options [Status] :offset
         # @return [Hash]
       def list(options=nil)
         return perform_list_without_object if options.nil?
   
         params = {}
-        %i[usecase brand].each do |param|
+        %i[usecase brand limit offset].each do |param|
           if options.key?(param) && valid_param?(param, options[param],
-                                                   [String], true)
+                                                   [String, 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
+        if options.key?(:offset) && options[:offset] < 0
+          raise_invalid_request("Offset can't be negative")
         end  
         perform_list_without_object(params)
       end
   
         ##
         # Create a new Camapign
-      def create(params)
-          perform_create(params)
+      def create(options=nil)
+        valid_param?(:options, options, Hash, true)
+        if not options[:brand_id]
+          raise_invalid_request("brand_id must be provided")
+        end
+        if not options[:vertical]
+          raise_invalid_request("vertical must be provided")
+        end
+        if not options[:usecase]
+          raise_invalid_request("usecase must be provided")
+        end
+        perform_create(options)
+      end
+      ##
+      # campaign number link
+      #
+      def number_link(options=nil)
+        valid_param?(:options, options, Hash, true)
+        if not options[:campaign_id]
+          raise_invalid_request("campaign_id must be provided")
+        end
+        action = options[:campaign_id] + '/Number'
+        perform_action_with_identifier(action, 'POST', options)            
+      end
+      ##
+      #get campaign numbers
+      #
+      def get_numbers(campaign_id, options = nil)
+        params = {}
+        %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
+        if options.key?(:offset) && options[:offset] < 0
+          raise_invalid_request("Offset can't be negative")
+        end
+        action = campaign_id + '/Number'
+        perform_action_with_identifier(action, 'GET', params)
+      end
+      ##
+      #get campaign number
+      #
+      def get_number(campaign_id, number)
+        action = campaign_id + '/Number/' + number
+        perform_action_with_identifier(action, 'GET', nil)
+      end
+      ##
+      #unlink campaign number
+      #
+      def number_unlink(campaign_id, number, options = nil)
+        action = campaign_id + '/Number/' + number
+        perform_action_with_identifier(action, 'DELETE', nil)
       end
     end
   end
-end
+end

data/lib/plivo/resources/profile.rb

@@ -0,0 +1,93 @@
+module Plivo
+    module Resources
+        include Plivo::Utils
+        class Profile < Base::Resource
+            def initialize(client, options = nil)
+              @_name = 'Profile'
+              @_identifier_string = 'profile_uuid'
+              super
+            end
+        
+            def to_s
+              {
+                api_id: @api_id,
+                profile: @profile
+              }.to_s
+            end
+        end
+        class ProfileInterface < Base::ResourceInterface
+            def initialize(client, resource_list_json = nil)
+                @_name = 'Profile'
+                @_resource_type = Profile
+                @_identifier_string = 'profile_uuid'
+                super
+            end
+        
+              ##
+              # Get an Profile
+              # @param [String] profile_uuid
+              # @return [Profile] Profile
+            def get(profile_uuid)
+                valid_param?(:profile_uuid, profile_uuid, [String, Symbol], true)
+                perform_get(profile_uuid)
+            end
+
+              # List all Profile
+            def list(options = nil)
+              return perform_list_without_object if options.nil?
+              params = {}
+              %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
+              if options.key?(:offset) && options[:offset] < 0
+                raise_invalid_request("Offset can't be negative")
+              end
+              perform_list_without_object(params)
+            end
+
+             # Delete an Profile
+             # @param [String] profile_uuid
+            def delete(profile_uuid)
+                valid_param?(:profile_uuid, profile_uuid, [String, Symbol], true)
+                perform_action_with_identifier(profile_uuid, 'DELETE', nil)
+            end
+        
+              ##
+              # Create a new Profile
+            def create(options = nil)
+                valid_param?(:options, options, Hash, true)
+                if not options[:profile_alias]
+                    raise_invalid_request("profile_alias must be provided")
+                end
+                if not options[:customer_type]
+                    raise_invalid_request("customer_type must be provided")
+                end
+                if not options[:entity_type]
+                    raise_invalid_request("entity_type must be provided")
+                end
+                if not options[:company_name]
+                    raise_invalid_request("company_name must be provided")
+                end
+                if not options[:vertical]
+                    raise_invalid_request("vertical must be provided")
+                end
+                perform_create(options)
+            end
+
+            ##
+            # Update a Profile
+            # {'address': {}, 'authorized_contact': {}, 'entity_type':'', 'vertical': '', 'company_name': '', 'website':''} 
+            def update(profile_uuid, options = nil)
+              valid_param?(:options, options, Hash, true)
+              perform_action_with_identifier(profile_uuid, "POST", options)
+            end
+        end
+    end
+end

data/lib/plivo/resources/token.rb

@@ -0,0 +1,66 @@
+module Plivo
+  module Resources
+    include Plivo
+    include Plivo::Utils
+    class Token < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'JWT/Token'
+        super
+        @_is_voice_request = true
+      end
+      def to_s
+        {
+          api_id: @api_id,
+          token: @token
+        }.to_s
+      end
+    end
+
+    class TokenInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'JWT/Token'
+        @_resource_type = Token
+        super
+        @_is_voice_request = true
+      end
+
+
+      def create(iss , options = nil)
+        valid_param?(:iss, iss, [String, Symbol, Hash], true)
+        params = {}
+        params[:iss] = iss
+
+        return perform_create(params, false) if options.nil?
+        # return perform_action('Record', 'POST', nil, true) if options.nil?
+        valid_param?(:options, options, [Hash], false)
+
+
+        if options.key?("sub") && valid_param?("sub", options["sub"], [String, Symbol], false )
+          params[:sub] = options["sub"]
+        end
+        if options.key("nbf") && valid_param?("nbf", options["nbf"], [Integer, Symbol], false )
+          params[:nbf] = options["nbf"]
+        end
+        if options.key("exp") && valid_param?("exp", options["exp"], [Integer, Symbol], false )
+          params[:exp] = options["exp"]
+        end
+        if options.key?("incoming_allow") || options.key?("outgoing_allow")
+          params[:per] = {}
+          params[:per][:voice] = {}
+          if options.key?("incoming_allow") && valid_param?("incoming_allow", options["incoming_allow"], [TrueClass, FalseClass, String,Symbol], false)
+            params[:per][:voice][:incoming_allow] = options["incoming_allow"]
+          end
+          if options.key?("outgoing_allow") && valid_param?("outgoing_allow", options["outgoing_allow"], [TrueClass, FalseClass, String, Symbol], false)
+            params[:per][:voice][:outgoing_allow] = options["outgoing_allow"]
+          end
+        end
+        if options.key?("app") && valid_param?("app", options["app"], [String, Symbol], false)
+          params[:app] = options["app"]
+        end
+
+          perform_create(params.merge(options), false)
+      end
+    end
+  end
+end
+

data/lib/plivo/resources.rb

@@ -7,6 +7,7 @@ require_relative 'resources/pricings'
 require_relative 'resources/numbers'
 require_relative 'resources/conferences'
 require_relative 'resources/calls'
+require_relative 'resources/token'
 require_relative 'resources/endpoints'
 require_relative 'resources/addresses'
 require_relative 'resources/identities'
@@ -17,6 +18,7 @@ require_relative 'resources/call_feedback'
 require_relative 'resources/media'
 require_relative 'resources/brand'
 require_relative 'resources/campaign'
+require_relative 'resources/profile'
 require_relative 'resources/lookup'
 require_relative 'resources/regulatory_compliance'
 require_relative 'resources/multipartycalls'

data/lib/plivo/rest_client.rb

@@ -8,13 +8,14 @@ module Plivo
     # Resources
     attr_reader :messages, :account, :subaccounts, :recordings
     attr_reader :pricings, :numbers, :calls, :conferences
+    attr_reader :token
     attr_reader :phone_numbers, :applications, :endpoints, :multipartycalls
     attr_reader :addresses, :identities
     attr_reader :call_feedback
     attr_reader :powerpacks
     attr_reader :powerpacks, :media
     attr_reader :lookup
-    attr_reader :brand, :campaign
+    attr_reader :brand, :campaign, :profile
     attr_reader :end_users
     attr_reader :compliance_document_types, :compliance_documents, :compliance_requirements, :compliance_applications
 
@@ -42,6 +43,7 @@ module Plivo
       @media = Resources::MediaInterface.new(self)
       @brand = Resources::BrandInterface.new(self)
       @campaign = Resources::CampaignInterface.new(self)
+      @profile = Resources::ProfileInterface.new(self)
       @subaccounts = Resources::SubaccountInterface.new(self)
       @recordings = Resources::RecordingInterface.new(self)
       @pricings = Resources::PricingInterface.new(self)
@@ -49,6 +51,7 @@ module Plivo
       @phone_numbers = Resources::PhoneNumberInterface.new(self)
       @conferences = Resources::ConferenceInterface.new(self)
       @calls = Resources::CallInterface.new(self)
+      @token = Resources::TokenInterface.new(self)
       @endpoints = Resources::EndpointInterface.new(self)
       @applications = Resources::ApplicationInterface.new(self)
       @addresses = Resources::AddressInterface.new(self)

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.27.1".freeze
+  VERSION = "4.30.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.27.1
+  version: 4.30.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -199,8 +199,10 @@ files:
 - lib/plivo/resources/phlos.rb
 - lib/plivo/resources/powerpacks.rb
 - lib/plivo/resources/pricings.rb
+- lib/plivo/resources/profile.rb
 - lib/plivo/resources/recordings.rb
 - lib/plivo/resources/regulatory_compliance.rb
+- lib/plivo/resources/token.rb
 - lib/plivo/rest_client.rb
 - lib/plivo/utils.rb
 - lib/plivo/version.rb