telesignenterprise 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6191e800b2db71c8347b25dba8bd6f67ff9dbee5f99095b695eae42cec617fe5
-  data.tar.gz: b2508dbf8afcea352a4d07121f1eb25a0cb84fd17d207e7ceb64e9f5602683cc
+  metadata.gz: 57a7ee869e419bfea9fd94a001db56d9dd61764857264e18628f3c3f0fea7bfb
+  data.tar.gz: a1df7143c43f8f11d0573f5830caa60660ae37c45f9341ad045ffceb16c0a040
 SHA512:
-  metadata.gz: 90a134293ca73111f070ccb22ac265ec40d382060db91a12c0b23b28997bc13f7353ed3be28ba981b3c0fa59077683df82cee18ddf3da887bfb9fab786a82e1f
-  data.tar.gz: ac76e3d3569df0a26bcf8d4be1f910bc8ee7ae5ea533af9108bd4f459c650fa033203e02c7c903f81a8dc8739ad5db792bea65fbb13ee7c04a76d53948db8bbf
+  metadata.gz: b2ca1901cbb29959549cfae04448810b1d9b2f818e173fe5a7e298c90cedabc9f70038dec95bb26a239ad571b01bf5cd12a6c7af19234592a8ebb5817788c4c2
+  data.tar.gz: daa66ef1f5c272a1ceff1a5eb6c7e038c43a5f8b68d29702e17c83210048fe2704a3c8a576c0d60d59938b9a329646da22348977f4efb6c273e9bd277ba606d3

data/lib/telesignenterprise/appverify.rb

@@ -1,4 +1,5 @@
 require 'telesign'
+require_relative 'constants'
 
 module TelesignEnterprise
 
@@ -11,7 +12,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,

data/lib/telesignenterprise/constants.rb

@@ -0,0 +1,3 @@
+module TelesignEnterprise
+    SDK_VERSION = '3.0.0'
+end

data/lib/telesignenterprise/messaging.rb

@@ -1,4 +1,5 @@
 require 'telesign'
+require_relative 'constants'
 
 OMNI_MESSAGING_RESOURCE = '/v1/omnichannel'
 module TelesignEnterprise
@@ -11,7 +12,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,

data/lib/telesignenterprise/omniverify.rb

@@ -0,0 +1,63 @@
+
+require 'telesign/rest'
+require_relative 'constants'
+
+PATH_CREATE_VERIFICATION_PROCESS = '/verification'
+PATH_UPDATE_VERIFICATION_PROCESS = '/verification/%{reference_id}/state'
+PATH_RETRIEVE_VERIFICATION_PROCESS = '/verification/%{reference_id}'
+
+module TelesignEnterprise
+
+  # The Telesign Verify API makes it easy for you to set up phone-based, multi-factor authentication (MFA) using multiple channels and methods.
+  # See https://developer.telesign.com/enterprise/docs/verify-api-overview for detailed product documentation.
+
+  class OmniVerifyClient < Telesign::RestClient
+
+    def initialize(customer_id,
+                   api_key,
+                   rest_endpoint: 'https://verify.telesign.com',
+                   timeout: nil,
+                   source: 'ruby_telesign_enterprise',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
+                   sdk_version_dependency: Gem.loaded_specs['telesign'].version)
+
+      super(customer_id,
+            api_key,
+            rest_endpoint: rest_endpoint,
+            timeout: timeout,
+            source: source,
+            sdk_version_origin: sdk_version_origin,
+            sdk_version_dependency: sdk_version_dependency)
+    end
+
+    # Use this action to create a verification process for the specified phone number.
+    #
+    # See https://developer.telesign.com/enterprise/reference/createverificationprocess for detailed API documentation.
+    def create_verification_process(phone_number, **params)
+      params = params.merge({ recipient: { phone_number: phone_number } })
+      params[:verification_policy] ||= [{ method: 'sms', fallback_time: 30 }]
+      self.post(PATH_CREATE_VERIFICATION_PROCESS, **params)
+    end
+
+    # Use this action to retrieve a verification process for the specified reference_id.
+    #
+    # See https://developer.telesign.com/enterprise/reference/getverificationprocess for detailed API documentation.
+    def retrieve_verification_process(reference_id, **params)
+      self.get(PATH_RETRIEVE_VERIFICATION_PROCESS % {:reference_id => reference_id}, **params)
+    end
+
+    # Use this action to update a verification process for the specified reference_id.
+    #
+    # See https://developer.telesign.com/enterprise/reference/updateverificationprocess for detailed API documentation.
+    def update_verification_process(reference_id, **params)
+      self.patch(PATH_UPDATE_VERIFICATION_PROCESS % {:reference_id => reference_id}, auth_method: 'Basic', **params)
+    end
+
+    private
+
+    def content_type
+      "application/json"
+    end
+
+  end
+end

data/lib/telesignenterprise/phoneid.rb

@@ -1,10 +1,11 @@
 require 'telesign/phoneid'
+require_relative 'constants'
 
 PHONEID_STANDARD_RESOURCE = '/v1/phoneid/standard/%{phone_number}'
 PHONEID_SCORE_RESOURCE = '/v1/phoneid/score/%{phone_number}'
-PHONEID_CONTACT_RESOURCE = '/v1/phoneid/contact/%{phone_number}'
 PHONEID_LIVE_RESOURCE = '/v1/phoneid/live/%{phone_number}'
-PHONEID_NUMBER_DEACTIVATION_RESOURCE = '/v1/phoneid/number_deactivation/%{phone_number}'
+PHONEID_GET_INFO_PATH = '/v1/phoneid/%{phone_number}'
+PHONEID_GET_INFO_PATH_ALT = '/v1/phoneid'
 
 module TelesignEnterprise
 
@@ -21,7 +22,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,
@@ -48,23 +49,11 @@ module TelesignEnterprise
     #
     # See https://developer.telesign.com/docs/rest_api-phoneid-score for detailed API documentation.
     def score(phone_number, ucid, **params)
-
       self.get(PHONEID_SCORE_RESOURCE % {:phone_number => phone_number},
                ucid: ucid,
                **params)
     end
 
-    # The PhoneID Contact API delivers contact information related to the subscriber's phone number to provide another
-    # set of indicators for established risk engines.
-    #
-    # See https://developer.telesign.com/docs/rest_api-phoneid-contact for detailed API documentation.
-    def contact(phone_number, ucid, **params)
-
-      self.get(PHONEID_CONTACT_RESOURCE % {:phone_number => phone_number},
-               ucid: ucid,
-               **params)
-    end
-
     # The PhoneID Live API delivers insights such as whether a phone is active or disconnected, a device is reachable
     # or unreachable and its roaming status.
     #
@@ -76,16 +65,25 @@ module TelesignEnterprise
                **params)
     end
 
-    # The PhoneID Number Deactivation API determines whether a phone number has been deactivated and when, based on
-    # carriers' phone number data and TeleSign's proprietary analysis.
+    # Enter a phone number with country code to receive detailed information about carrier, location, and other details.
+    # Phone number provided in URL path: POST /v1/phoneid/{phone_number}
     #
-    # See https://developer.telesign.com/docs/rest_api-phoneid-number-deactivation for detailed API documentation.
-    def number_deactivation(phone_number, ucid, **params)
-
-      self.get(PHONEID_NUMBER_DEACTIVATION_RESOURCE % {:phone_number => phone_number},
-               ucid: ucid,
-               **params)
+    # See https://developer.telesign.com/enterprise/reference/submitphonenumberforidentity for detailed API documentation.
+    def phone_id_path(phone_number, **params)
+      params['consent'] ||= { 'method' => 1 }
+      
+      self.post(PHONEID_GET_INFO_PATH % {:phone_number => phone_number}, **params)
     end
 
+    # Enter a phone number with country code to receive detailed information about carrier, location, and other details.
+    # Phone number provided in body: POST /v1/phoneid
+    #
+    # See https://developer.telesign.com/enterprise/reference/submitphonenumberforidentityalt for detailed API documentation.
+    def phone_id_body(phone_number, **params)
+      params['phone_number'] = phone_number
+      params['consent'] ||= { 'method' => 1 }
+  
+      self.post(PHONEID_GET_INFO_PATH_ALT, **params)
+    end
   end
 end

data/lib/telesignenterprise/score.rb

@@ -1,4 +1,5 @@
 require 'telesign'
+require_relative 'constants'
 
 module TelesignEnterprise
 
@@ -10,7 +11,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,

data/lib/telesignenterprise/telebureau.rb

@@ -1,4 +1,5 @@
 require 'telesign/rest'
+require_relative 'constants'
 
 TELEBUREAU_CREATE_RESOURCE = '/v1/telebureau/event'
 TELEBUREAU_RETRIEVE_RESOURCE = '/v1/telebureau/event/%{reference_id}'
@@ -16,7 +17,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,

data/lib/telesignenterprise/verify.rb

@@ -1,4 +1,6 @@
 require 'telesign/rest'
+require_relative 'omniverify'
+require_relative 'constants'
 
 VERIFY_SMS_RESOURCE = '/v1/verify/sms'
 VERIFY_VOICE_RESOURCE = '/v1/verify/call'
@@ -17,9 +19,11 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
-                   sdk_version_dependency: Gem.loaded_specs['telesign'].version)
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
+                   sdk_version_dependency: Gem.loaded_specs['telesign'].version,
+                   rest_endpoint_verify: 'https://verify.telesign.com')
 
+      @omniVerifyClient = OmniVerifyClient.new(customer_id, api_key, rest_endpoint: rest_endpoint_verify)
       super(customer_id,
             api_key,
             rest_endpoint: rest_endpoint,
@@ -29,33 +33,6 @@ module TelesignEnterprise
             sdk_version_dependency: sdk_version_dependency)
     end
 
-    class OmniVerifyClient < Telesign::RestClient
-      def initialize(customer_id,
-        api_key,
-        rest_endpoint: 'https://verify.telesign.com',
-        timeout: nil)
-
-        super(customer_id,
-        api_key,
-        rest_endpoint: rest_endpoint,
-        timeout: timeout)
-      end
-
-      def create_verification_process(phone_number, **params)
-        params = { recipient: { phone_number:phone_number } }
-        if !params.key?("verification_policy")
-          params[:verification_policy] = [{ method: 'sms', fallback_time: 30 }]
-        end
-        self.post(VERIFY_OMNICHANNEL_RESOURCE, **params)
-      end
-
-      private
-
-      def content_type
-        "application/json"
-      end
-
-    end
     # The SMS Verify API delivers phone-based verification and two-factor authentication using a time-based,
     # one-time passcode sent over SMS.
     #
@@ -109,8 +86,7 @@ module TelesignEnterprise
     #
     # See https://developer.telesign.com/enterprise/reference/createverificationprocess for detailed API documentation.
     def create_verification_process(phone_number, **params)
-      omni_verify = OmniVerifyClient.new(@customer_id, @api_key, rest_endpoint: @rest_endpoint)
-      omni_verify.create_verification_process(phone_number, **params)
+      @omniVerifyClient.create_verification_process(phone_number, **params)
     end
 
   end

data/lib/telesignenterprise/voice.rb

@@ -1,4 +1,5 @@
 require 'telesign'
+require_relative 'constants'
 
 module TelesignEnterprise
 
@@ -11,7 +12,7 @@ module TelesignEnterprise
                    rest_endpoint: 'https://rest-ww.telesign.com',
                    timeout: nil,
                    source: 'ruby_telesign_enterprise',
-                   sdk_version_origin: '2.5.0',
+                   sdk_version_origin: TelesignEnterprise::SDK_VERSION,
                    sdk_version_dependency: Gem.loaded_specs['telesign'].version)
 
       super(customer_id,

data/lib/telesignenterprise.rb

@@ -1,6 +1,7 @@
 require 'telesignenterprise/phoneid'
 require 'telesignenterprise/telebureau'
 require 'telesignenterprise/verify'
+require 'telesignenterprise/omniverify'
 require 'telesignenterprise/score'
 require 'telesignenterprise/messaging'
 require 'telesignenterprise/voice'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telesignenterprise
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.0
 platform: ruby
 authors:
 - TeleSign
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,9 @@ extra_rdoc_files: []
 files:
 - lib/telesignenterprise.rb
 - lib/telesignenterprise/appverify.rb
+- lib/telesignenterprise/constants.rb
 - lib/telesignenterprise/messaging.rb
+- lib/telesignenterprise/omniverify.rb
 - lib/telesignenterprise/phoneid.rb
 - lib/telesignenterprise/score.rb
 - lib/telesignenterprise/telebureau.rb