Class: TelesignEnterprise::OmniVerifyClient

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

Overview

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.

Instance Method Summary collapse

Constructor Details

#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) ⇒ OmniVerifyClient

Returns a new instance of OmniVerifyClient.



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

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

Instance Method Details

#create_verification_process(phone_number, **params) ⇒ Object

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.



36
37
38
39
40
 
# File 'lib/telesignenterprise/omniverify.rb', line 36

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

#retrieve_verification_process(reference_id, **params) ⇒ Object

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.



45
46
47
 
# File 'lib/telesignenterprise/omniverify.rb', line 45

def retrieve_verification_process(reference_id, **params)
  self.get(PATH_RETRIEVE_VERIFICATION_PROCESS % {:reference_id => reference_id}, **params)
end

#update_verification_process(reference_id, **params) ⇒ Object

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.



52
53
54
 
# File 'lib/telesignenterprise/omniverify.rb', line 52

def update_verification_process(reference_id, **params)
  self.patch(PATH_UPDATE_VERIFICATION_PROCESS % {:reference_id => reference_id}, auth_method: 'Basic', **params)
end