Class: TelesignEnterprise::AppVerifyClient

Inherits:
Telesign::RestClient
  • Object
show all
Defined in:
lib/telesignenterprise/appverify.rb

Overview

App Verify is a secure, lightweight SDK that integrates a frictionless user verification process into existing native mobile applications.

Constant Summary collapse

APP_VERIFY_BASE_RESOURCE = 
"/v1/verify/auto/voice"
INITIATE_RESOURCE = 
"#{APP_VERIFY_BASE_RESOURCE}/initiate"
FINALIZE_RESOURCE = 
"#{APP_VERIFY_BASE_RESOURCE}/finalize"
FINALIZE_CALLERID_RESOURCE = 
"#{APP_VERIFY_BASE_RESOURCE}/finalize/callerid"
FINALIZE_TIMEOUT_RESOURCE = 
"#{APP_VERIFY_BASE_RESOURCE}/finalize/timeout"

Instance Method Summary collapse

Constructor Details

#initialize(customer_id, api_key, rest_endpoint: 'https://rest-ww.telesign.com', timeout: nil, source: 'ruby_telesign_enterprise', sdk_version_origin: TelesignEnterprise::SDK_VERSION, sdk_version_dependency: Gem.loaded_specs['telesign'].version) ⇒ AppVerifyClient

Returns a new instance of AppVerifyClient.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/telesignenterprise/appverify.rb', line 16

def initialize(customer_id,
               api_key,
               rest_endpoint: 'https://rest-ww.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

Instance Method Details

#finalize(reference_id, params = {}) ⇒ Object

End call (Finalize) See https://developer.telesign.com/enterprise/reference/endappverifycall



41
42
43
 
# File 'lib/telesignenterprise/appverify.rb', line 41

def finalize(reference_id, params = {})
  post(FINALIZE_RESOURCE, reference_id: reference_id, **params)
end

#get_transaction_status(reference_id) ⇒ Object

Get transaction status See https://developer.telesign.com/enterprise/reference/getappverifystatus



59
60
61
 
# File 'lib/telesignenterprise/appverify.rb', line 59

def get_transaction_status(reference_id)
  get("#{APP_VERIFY_BASE_RESOURCE}/#{reference_id}")
end

#initiate(phone_number, params = {}) ⇒ Object

Send call with verification code (Initiate) See https://developer.telesign.com/enterprise/reference/sendappverifycode



35
36
37
 
# File 'lib/telesignenterprise/appverify.rb', line 35

def initiate(phone_number, params = {})
  post(INITIATE_RESOURCE, phone_number: phone_number, **params)
end

#report_timeout(reference_id) ⇒ Object

Report timeout See https://developer.telesign.com/enterprise/reference/reportappverifytimeout



53
54
55
 
# File 'lib/telesignenterprise/appverify.rb', line 53

def report_timeout(reference_id)
  post(FINALIZE_TIMEOUT_RESOURCE, reference_id: reference_id)
end

#report_unknown_caller_id(reference_id, unknown_caller_id, params = {}) ⇒ Object

Report unknown caller ID See https://developer.telesign.com/enterprise/reference/reportappverifycallerid



47
48
49
 
# File 'lib/telesignenterprise/appverify.rb', line 47

def report_unknown_caller_id(reference_id, unknown_caller_id, params = {})
  post(FINALIZE_CALLERID_RESOURCE, reference_id: reference_id, unknown_caller_id: unknown_caller_id, **params)
end