Package dev.resms.services.otp

Class Otp

java.lang.Object

dev.resms.core.service.BaseService

dev.resms.services.otp.Otp

public class Otp
extends BaseService

Field Summary

Fields inherited from class dev.resms.core.service.BaseService

apiKey, httpClient, reSMSMapper

Constructor Summary

Constructors

Constructor	Description
Otp(String apiKey)	Constructs an instance of the Otp class.

Method Summary

Modifier and Type	Method	Description
SendOtpResponse	send(SendOtpOptions sendOtpOptions)	Send an OTP based on the provided OTP request
VerifyOtpResponse	verify(VerifyOtpOptions verifyOtpOptions)	Verify an OTP based on the provided OTP verify request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Otp

public Otp(String apiKey)

Constructs an instance of the Otp class.

Parameters:

apiKey - The apiKey used for authentication.

Method Details

send

public SendOtpResponse send(SendOtpOptions sendOtpOptions)
                     throws ReSMSException

Send an OTP based on the provided OTP request

Parameters:

sendOtpOptions - The request containing OTP details.

Returns:

The response indicating the status of the OTP.

Throws:

ReSMSException - If an error occurs while sending the OTP.

verify

public VerifyOtpResponse verify(VerifyOtpOptions verifyOtpOptions)
                         throws ReSMSException

Verify an OTP based on the provided OTP verify request

Parameters:

verifyOtpOptions - The request containing OTP verify details.

Returns:

The response indicating the status of the OTP verification.

Throws:

ReSMSException - If an error occurs while verifying the OTP.