com.infobip.api

Class TfaApi

java.lang.Object

com.infobip.api.TfaApi

public class TfaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TfaApi()
TfaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TfaApplicationResponse	createTfaApplication(TfaApplicationRequest tfaApplicationRequest) Create 2FA application.
okhttp3.Call	createTfaApplicationAsync(TfaApplicationRequest tfaApplicationRequest, ApiCallback<TfaApplicationResponse> _callback) Create 2FA application (asynchronously).
okhttp3.Call	createTfaApplicationCall(TfaApplicationRequest tfaApplicationRequest, ApiCallback _callback) Build call for createTfaApplication.
ApiResponse<TfaApplicationResponse>	createTfaApplicationWithHttpInfo(TfaApplicationRequest tfaApplicationRequest) Create 2FA application.
TfaMessage	createTfaMessageTemplate(String appId, TfaCreateMessageRequest tfaCreateMessageRequest) Create 2FA message template.
okhttp3.Call	createTfaMessageTemplateAsync(String appId, TfaCreateMessageRequest tfaCreateMessageRequest, ApiCallback<TfaMessage> _callback) Create 2FA message template (asynchronously).
okhttp3.Call	createTfaMessageTemplateCall(String appId, TfaCreateMessageRequest tfaCreateMessageRequest, ApiCallback _callback) Build call for createTfaMessageTemplate.
ApiResponse<TfaMessage>	createTfaMessageTemplateWithHttpInfo(String appId, TfaCreateMessageRequest tfaCreateMessageRequest) Create 2FA message template.
ApiClient	getApiClient()
TfaApplicationResponse	getTfaApplication(String appId) Get 2FA application.
okhttp3.Call	getTfaApplicationAsync(String appId, ApiCallback<TfaApplicationResponse> _callback) Get 2FA application (asynchronously).
okhttp3.Call	getTfaApplicationCall(String appId, ApiCallback _callback) Build call for getTfaApplication.
List<TfaApplicationResponse>	getTfaApplications() Get 2FA applications.
okhttp3.Call	getTfaApplicationsAsync(ApiCallback<List<TfaApplicationResponse>> _callback) Get 2FA applications (asynchronously).
okhttp3.Call	getTfaApplicationsCall(ApiCallback _callback) Build call for getTfaApplications.
ApiResponse<List<TfaApplicationResponse>>	getTfaApplicationsWithHttpInfo() Get 2FA applications.
ApiResponse<TfaApplicationResponse>	getTfaApplicationWithHttpInfo(String appId) Get 2FA application.
TfaMessage	getTfaMessageTemplate(String appId, String msgId) Get 2FA message template.
okhttp3.Call	getTfaMessageTemplateAsync(String appId, String msgId, ApiCallback<TfaMessage> _callback) Get 2FA message template (asynchronously).
okhttp3.Call	getTfaMessageTemplateCall(String appId, String msgId, ApiCallback _callback) Build call for getTfaMessageTemplate.
List<TfaMessage>	getTfaMessageTemplates(String appId) Get 2FA message templates.
okhttp3.Call	getTfaMessageTemplatesAsync(String appId, ApiCallback<List<TfaMessage>> _callback) Get 2FA message templates (asynchronously).
okhttp3.Call	getTfaMessageTemplatesCall(String appId, ApiCallback _callback) Build call for getTfaMessageTemplates.
ApiResponse<List<TfaMessage>>	getTfaMessageTemplatesWithHttpInfo(String appId) Get 2FA message templates.
ApiResponse<TfaMessage>	getTfaMessageTemplateWithHttpInfo(String appId, String msgId) Get 2FA message template.
TfaVerificationResponse	getTfaVerificationStatus(String msisdn, String appId, Boolean verified, Boolean sent) Get 2FA verification status.
okhttp3.Call	getTfaVerificationStatusAsync(String msisdn, String appId, Boolean verified, Boolean sent, ApiCallback<TfaVerificationResponse> _callback) Get 2FA verification status (asynchronously).
okhttp3.Call	getTfaVerificationStatusCall(String msisdn, String appId, Boolean verified, Boolean sent, ApiCallback _callback) Build call for getTfaVerificationStatus.
ApiResponse<TfaVerificationResponse>	getTfaVerificationStatusWithHttpInfo(String msisdn, String appId, Boolean verified, Boolean sent) Get 2FA verification status.
TfaStartAuthenticationResponse	resendTfaPinCodeOverSms(String pinId, TfaResendPinRequest tfaResendPinRequest) Resend 2FA PIN code over SMS.
okhttp3.Call	resendTfaPinCodeOverSmsAsync(String pinId, TfaResendPinRequest tfaResendPinRequest, ApiCallback<TfaStartAuthenticationResponse> _callback) Resend 2FA PIN code over SMS (asynchronously).
okhttp3.Call	resendTfaPinCodeOverSmsCall(String pinId, TfaResendPinRequest tfaResendPinRequest, ApiCallback _callback) Build call for resendTfaPinCodeOverSms.
ApiResponse<TfaStartAuthenticationResponse>	resendTfaPinCodeOverSmsWithHttpInfo(String pinId, TfaResendPinRequest tfaResendPinRequest) Resend 2FA PIN code over SMS.
TfaStartAuthenticationResponse	resendTfaPinCodeOverVoice(String pinId, TfaResendPinRequest tfaResendPinRequest) Resend 2FA PIN code over Voice.
okhttp3.Call	resendTfaPinCodeOverVoiceAsync(String pinId, TfaResendPinRequest tfaResendPinRequest, ApiCallback<TfaStartAuthenticationResponse> _callback) Resend 2FA PIN code over Voice (asynchronously).
okhttp3.Call	resendTfaPinCodeOverVoiceCall(String pinId, TfaResendPinRequest tfaResendPinRequest, ApiCallback _callback) Build call for resendTfaPinCodeOverVoice.
ApiResponse<TfaStartAuthenticationResponse>	resendTfaPinCodeOverVoiceWithHttpInfo(String pinId, TfaResendPinRequest tfaResendPinRequest) Resend 2FA PIN code over Voice.
TfaStartAuthenticationResponse	sendTfaPinCodeOverSms(Boolean ncNeeded, TfaStartAuthenticationRequest tfaStartAuthenticationRequest) Send 2FA PIN code over SMS.
okhttp3.Call	sendTfaPinCodeOverSmsAsync(Boolean ncNeeded, TfaStartAuthenticationRequest tfaStartAuthenticationRequest, ApiCallback<TfaStartAuthenticationResponse> _callback) Send 2FA PIN code over SMS (asynchronously).
okhttp3.Call	sendTfaPinCodeOverSmsCall(Boolean ncNeeded, TfaStartAuthenticationRequest tfaStartAuthenticationRequest, ApiCallback _callback) Build call for sendTfaPinCodeOverSms.
ApiResponse<TfaStartAuthenticationResponse>	sendTfaPinCodeOverSmsWithHttpInfo(Boolean ncNeeded, TfaStartAuthenticationRequest tfaStartAuthenticationRequest) Send 2FA PIN code over SMS.
TfaStartAuthenticationResponse	sendTfaPinCodeOverVoice(TfaStartAuthenticationRequest tfaStartAuthenticationRequest) Send 2FA PIN code over Voice.
okhttp3.Call	sendTfaPinCodeOverVoiceAsync(TfaStartAuthenticationRequest tfaStartAuthenticationRequest, ApiCallback<TfaStartAuthenticationResponse> _callback) Send 2FA PIN code over Voice (asynchronously).
okhttp3.Call	sendTfaPinCodeOverVoiceCall(TfaStartAuthenticationRequest tfaStartAuthenticationRequest, ApiCallback _callback) Build call for sendTfaPinCodeOverVoice.
ApiResponse<TfaStartAuthenticationResponse>	sendTfaPinCodeOverVoiceWithHttpInfo(TfaStartAuthenticationRequest tfaStartAuthenticationRequest) Send 2FA PIN code over Voice.
void	setApiClient(ApiClient apiClient)
TfaApplicationResponse	updateTfaApplication(String appId, TfaApplicationRequest tfaApplicationRequest) Update 2FA application.
okhttp3.Call	updateTfaApplicationAsync(String appId, TfaApplicationRequest tfaApplicationRequest, ApiCallback<TfaApplicationResponse> _callback) Update 2FA application (asynchronously).
okhttp3.Call	updateTfaApplicationCall(String appId, TfaApplicationRequest tfaApplicationRequest, ApiCallback _callback) Build call for updateTfaApplication.
ApiResponse<TfaApplicationResponse>	updateTfaApplicationWithHttpInfo(String appId, TfaApplicationRequest tfaApplicationRequest) Update 2FA application.
TfaMessage	updateTfaMessageTemplate(String appId, String msgId, TfaUpdateMessageRequest tfaUpdateMessageRequest) Update 2FA message template.
okhttp3.Call	updateTfaMessageTemplateAsync(String appId, String msgId, TfaUpdateMessageRequest tfaUpdateMessageRequest, ApiCallback<TfaMessage> _callback) Update 2FA message template (asynchronously).
okhttp3.Call	updateTfaMessageTemplateCall(String appId, String msgId, TfaUpdateMessageRequest tfaUpdateMessageRequest, ApiCallback _callback) Build call for updateTfaMessageTemplate.
ApiResponse<TfaMessage>	updateTfaMessageTemplateWithHttpInfo(String appId, String msgId, TfaUpdateMessageRequest tfaUpdateMessageRequest) Update 2FA message template.
TfaVerifyPinResponse	verifyTfaPhoneNumber(String pinId, TfaVerifyPinRequest tfaVerifyPinRequest) Verify phone number.
okhttp3.Call	verifyTfaPhoneNumberAsync(String pinId, TfaVerifyPinRequest tfaVerifyPinRequest, ApiCallback<TfaVerifyPinResponse> _callback) Verify phone number (asynchronously).
okhttp3.Call	verifyTfaPhoneNumberCall(String pinId, TfaVerifyPinRequest tfaVerifyPinRequest, ApiCallback _callback) Build call for verifyTfaPhoneNumber.
ApiResponse<TfaVerifyPinResponse>	verifyTfaPhoneNumberWithHttpInfo(String pinId, TfaVerifyPinRequest tfaVerifyPinRequest) Verify phone number.

Methods inherited from class java.lang.Object

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

Constructor Detail

TfaApi

public TfaApi()

TfaApi

public TfaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createTfaApplicationCall

public okhttp3.Call createTfaApplicationCall(TfaApplicationRequest tfaApplicationRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for createTfaApplication.

Parameters:

tfaApplicationRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

createTfaApplication

public TfaApplicationResponse createTfaApplication(TfaApplicationRequest tfaApplicationRequest)
                                            throws ApiException

Create 2FA application. Create and configure a new 2FA application.

Parameters:

tfaApplicationRequest - (optional)

Returns:

TfaApplicationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

createTfaApplicationWithHttpInfo

public ApiResponse<TfaApplicationResponse> createTfaApplicationWithHttpInfo(TfaApplicationRequest tfaApplicationRequest)
                                                                     throws ApiException

Create 2FA application. Create and configure a new 2FA application.

Parameters:

tfaApplicationRequest - (optional)

Returns:

ApiResponse<TfaApplicationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

createTfaApplicationAsync

public okhttp3.Call createTfaApplicationAsync(TfaApplicationRequest tfaApplicationRequest,
                                              ApiCallback<TfaApplicationResponse> _callback)
                                       throws ApiException

Create 2FA application (asynchronously). Create and configure a new 2FA application.

Parameters:

tfaApplicationRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

createTfaMessageTemplateCall

public okhttp3.Call createTfaMessageTemplateCall(String appId,
                                                 TfaCreateMessageRequest tfaCreateMessageRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for createTfaMessageTemplate.

Parameters:

appId - ID of application for which requested message was created. (required)

tfaCreateMessageRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

createTfaMessageTemplate

public TfaMessage createTfaMessageTemplate(String appId,
                                           TfaCreateMessageRequest tfaCreateMessageRequest)
                                    throws ApiException

Create 2FA message template. Once you have your [2FA application](#channels/sms/create-2fa-message-template), create one or more message templates where your PIN will be dynamically included when you send the PIN message.

Parameters:

appId - ID of application for which requested message was created. (required)

tfaCreateMessageRequest - (optional)

Returns:

TfaMessage

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

createTfaMessageTemplateWithHttpInfo

public ApiResponse<TfaMessage> createTfaMessageTemplateWithHttpInfo(String appId,
                                                                    TfaCreateMessageRequest tfaCreateMessageRequest)
                                                             throws ApiException

Create 2FA message template. Once you have your [2FA application](#channels/sms/create-2fa-message-template), create one or more message templates where your PIN will be dynamically included when you send the PIN message.

Parameters:

appId - ID of application for which requested message was created. (required)

tfaCreateMessageRequest - (optional)

Returns:

ApiResponse<TfaMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

createTfaMessageTemplateAsync

public okhttp3.Call createTfaMessageTemplateAsync(String appId,
                                                  TfaCreateMessageRequest tfaCreateMessageRequest,
                                                  ApiCallback<TfaMessage> _callback)
                                           throws ApiException

Create 2FA message template (asynchronously). Once you have your [2FA application](#channels/sms/create-2fa-message-template), create one or more message templates where your PIN will be dynamically included when you send the PIN message.

Parameters:

appId - ID of application for which requested message was created. (required)

tfaCreateMessageRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

getTfaApplicationCall

public okhttp3.Call getTfaApplicationCall(String appId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getTfaApplication.

Parameters:

appId - ID of application for which configuration view was requested. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

getTfaApplication

public TfaApplicationResponse getTfaApplication(String appId)
                                         throws ApiException

Get 2FA application. Get a single 2FA application to see its configuration details.

Parameters:

appId - ID of application for which configuration view was requested. (required)

Returns:

TfaApplicationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaApplicationWithHttpInfo

public ApiResponse<TfaApplicationResponse> getTfaApplicationWithHttpInfo(String appId)
                                                                  throws ApiException

Get 2FA application. Get a single 2FA application to see its configuration details.

Parameters:

appId - ID of application for which configuration view was requested. (required)

Returns:

ApiResponse<TfaApplicationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaApplicationAsync

public okhttp3.Call getTfaApplicationAsync(String appId,
                                           ApiCallback<TfaApplicationResponse> _callback)
                                    throws ApiException

Get 2FA application (asynchronously). Get a single 2FA application to see its configuration details.

Parameters:

appId - ID of application for which configuration view was requested. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

getTfaApplicationsCall

public okhttp3.Call getTfaApplicationsCall(ApiCallback _callback)
                                    throws ApiException

Build call for getTfaApplications.

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

getTfaApplications

public List<TfaApplicationResponse> getTfaApplications()
                                                throws ApiException

Get 2FA applications. An application is a container for 2FA message templates. Use this method to list your applications.

Returns:

List<TfaApplicationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaApplicationsWithHttpInfo

public ApiResponse<List<TfaApplicationResponse>> getTfaApplicationsWithHttpInfo()
                                                                         throws ApiException

Get 2FA applications. An application is a container for 2FA message templates. Use this method to list your applications.

Returns:

ApiResponse<List<TfaApplicationResponse>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaApplicationsAsync

public okhttp3.Call getTfaApplicationsAsync(ApiCallback<List<TfaApplicationResponse>> _callback)
                                     throws ApiException

Get 2FA applications (asynchronously). An application is a container for 2FA message templates. Use this method to list your applications.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplateCall

public okhttp3.Call getTfaMessageTemplateCall(String appId,
                                              String msgId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getTfaMessageTemplate.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplate

public TfaMessage getTfaMessageTemplate(String appId,
                                        String msgId)
                                 throws ApiException

Get 2FA message template. Get a single 2FA message template from an application to see its configuration details.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

Returns:

TfaMessage

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplateWithHttpInfo

public ApiResponse<TfaMessage> getTfaMessageTemplateWithHttpInfo(String appId,
                                                                 String msgId)
                                                          throws ApiException

Get 2FA message template. Get a single 2FA message template from an application to see its configuration details.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

Returns:

ApiResponse<TfaMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplateAsync

public okhttp3.Call getTfaMessageTemplateAsync(String appId,
                                               String msgId,
                                               ApiCallback<TfaMessage> _callback)
                                        throws ApiException

Get 2FA message template (asynchronously). Get a single 2FA message template from an application to see its configuration details.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplatesCall

public okhttp3.Call getTfaMessageTemplatesCall(String appId,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getTfaMessageTemplates.

Parameters:

appId - ID of application for which requested message was created. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplates

public List<TfaMessage> getTfaMessageTemplates(String appId)
                                        throws ApiException

Get 2FA message templates. List all message templates in a 2FA application.

Parameters:

appId - ID of application for which requested message was created. (required)

Returns:

List<TfaMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplatesWithHttpInfo

public ApiResponse<List<TfaMessage>> getTfaMessageTemplatesWithHttpInfo(String appId)
                                                                 throws ApiException

Get 2FA message templates. List all message templates in a 2FA application.

Parameters:

appId - ID of application for which requested message was created. (required)

Returns:

ApiResponse<List<TfaMessage>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaMessageTemplatesAsync

public okhttp3.Call getTfaMessageTemplatesAsync(String appId,
                                                ApiCallback<List<TfaMessage>> _callback)
                                         throws ApiException

Get 2FA message templates (asynchronously). List all message templates in a 2FA application.

Parameters:

appId - ID of application for which requested message was created. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

getTfaVerificationStatusCall

public okhttp3.Call getTfaVerificationStatusCall(String msisdn,
                                                 String appId,
                                                 Boolean verified,
                                                 Boolean sent,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for getTfaVerificationStatus.

Parameters:

msisdn - Filter by msisdn (phone number) for which verification status is checked. (required)

appId - ID of 2-FA application for which phone number verification status is requested. (required)

verified - Filter by verified (true or false). (optional)

sent - Filter by message sent status (true or false). (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

getTfaVerificationStatus

public TfaVerificationResponse getTfaVerificationStatus(String msisdn,
                                                        String appId,
                                                        Boolean verified,
                                                        Boolean sent)
                                                 throws ApiException

Get 2FA verification status. Check if a phone number is already verified for a specific 2FA application.

Parameters:

msisdn - Filter by msisdn (phone number) for which verification status is checked. (required)

appId - ID of 2-FA application for which phone number verification status is requested. (required)

verified - Filter by verified (true or false). (optional)

sent - Filter by message sent status (true or false). (optional)

Returns:

TfaVerificationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaVerificationStatusWithHttpInfo

public ApiResponse<TfaVerificationResponse> getTfaVerificationStatusWithHttpInfo(String msisdn,
                                                                                 String appId,
                                                                                 Boolean verified,
                                                                                 Boolean sent)
                                                                          throws ApiException

Get 2FA verification status. Check if a phone number is already verified for a specific 2FA application.

Parameters:

msisdn - Filter by msisdn (phone number) for which verification status is checked. (required)

appId - ID of 2-FA application for which phone number verification status is requested. (required)

verified - Filter by verified (true or false). (optional)

sent - Filter by message sent status (true or false). (optional)

Returns:

ApiResponse<TfaVerificationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

getTfaVerificationStatusAsync

public okhttp3.Call getTfaVerificationStatusAsync(String msisdn,
                                                  String appId,
                                                  Boolean verified,
                                                  Boolean sent,
                                                  ApiCallback<TfaVerificationResponse> _callback)
                                           throws ApiException

Get 2FA verification status (asynchronously). Check if a phone number is already verified for a specific 2FA application.

Parameters:

msisdn - Filter by msisdn (phone number) for which verification status is checked. (required)

appId - ID of 2-FA application for which phone number verification status is requested. (required)

verified - Filter by verified (true or false). (optional)

sent - Filter by message sent status (true or false). (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverSmsCall

public okhttp3.Call resendTfaPinCodeOverSmsCall(String pinId,
                                                TfaResendPinRequest tfaResendPinRequest,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for resendTfaPinCodeOverSms.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverSms

public TfaStartAuthenticationResponse resendTfaPinCodeOverSms(String pinId,
                                                              TfaResendPinRequest tfaResendPinRequest)
                                                       throws ApiException

Resend 2FA PIN code over SMS. If needed, you can resend the same (previously sent) PIN code over SMS.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

Returns:

TfaStartAuthenticationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverSmsWithHttpInfo

public ApiResponse<TfaStartAuthenticationResponse> resendTfaPinCodeOverSmsWithHttpInfo(String pinId,
                                                                                       TfaResendPinRequest tfaResendPinRequest)
                                                                                throws ApiException

Resend 2FA PIN code over SMS. If needed, you can resend the same (previously sent) PIN code over SMS.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

Returns:

ApiResponse<TfaStartAuthenticationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverSmsAsync

public okhttp3.Call resendTfaPinCodeOverSmsAsync(String pinId,
                                                 TfaResendPinRequest tfaResendPinRequest,
                                                 ApiCallback<TfaStartAuthenticationResponse> _callback)
                                          throws ApiException

Resend 2FA PIN code over SMS (asynchronously). If needed, you can resend the same (previously sent) PIN code over SMS.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverVoiceCall

public okhttp3.Call resendTfaPinCodeOverVoiceCall(String pinId,
                                                  TfaResendPinRequest tfaResendPinRequest,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for resendTfaPinCodeOverVoice.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverVoice

public TfaStartAuthenticationResponse resendTfaPinCodeOverVoice(String pinId,
                                                                TfaResendPinRequest tfaResendPinRequest)
                                                         throws ApiException

Resend 2FA PIN code over Voice. If needed, you can resend the same (previously sent) PIN code over Voice.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

Returns:

TfaStartAuthenticationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverVoiceWithHttpInfo

public ApiResponse<TfaStartAuthenticationResponse> resendTfaPinCodeOverVoiceWithHttpInfo(String pinId,
                                                                                         TfaResendPinRequest tfaResendPinRequest)
                                                                                  throws ApiException

Resend 2FA PIN code over Voice. If needed, you can resend the same (previously sent) PIN code over Voice.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

Returns:

ApiResponse<TfaStartAuthenticationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

resendTfaPinCodeOverVoiceAsync

public okhttp3.Call resendTfaPinCodeOverVoiceAsync(String pinId,
                                                   TfaResendPinRequest tfaResendPinRequest,
                                                   ApiCallback<TfaStartAuthenticationResponse> _callback)
                                            throws ApiException

Resend 2FA PIN code over Voice (asynchronously). If needed, you can resend the same (previously sent) PIN code over Voice.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaResendPinRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverSmsCall

public okhttp3.Call sendTfaPinCodeOverSmsCall(Boolean ncNeeded,
                                              TfaStartAuthenticationRequest tfaStartAuthenticationRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for sendTfaPinCodeOverSms.

Parameters:

ncNeeded - Indicates if Number Lookup is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`. (optional)

tfaStartAuthenticationRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverSms

public TfaStartAuthenticationResponse sendTfaPinCodeOverSms(Boolean ncNeeded,
                                                            TfaStartAuthenticationRequest tfaStartAuthenticationRequest)
                                                     throws ApiException

Send 2FA PIN code over SMS. Send a PIN code over SMS using a previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

ncNeeded - Indicates if Number Lookup is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`. (optional)

tfaStartAuthenticationRequest - (optional)

Returns:

TfaStartAuthenticationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverSmsWithHttpInfo

public ApiResponse<TfaStartAuthenticationResponse> sendTfaPinCodeOverSmsWithHttpInfo(Boolean ncNeeded,
                                                                                     TfaStartAuthenticationRequest tfaStartAuthenticationRequest)
                                                                              throws ApiException

Send 2FA PIN code over SMS. Send a PIN code over SMS using a previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

ncNeeded - Indicates if Number Lookup is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`. (optional)

tfaStartAuthenticationRequest - (optional)

Returns:

ApiResponse<TfaStartAuthenticationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverSmsAsync

public okhttp3.Call sendTfaPinCodeOverSmsAsync(Boolean ncNeeded,
                                               TfaStartAuthenticationRequest tfaStartAuthenticationRequest,
                                               ApiCallback<TfaStartAuthenticationResponse> _callback)
                                        throws ApiException

Send 2FA PIN code over SMS (asynchronously). Send a PIN code over SMS using a previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

ncNeeded - Indicates if Number Lookup is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`. (optional)

tfaStartAuthenticationRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverVoiceCall

public okhttp3.Call sendTfaPinCodeOverVoiceCall(TfaStartAuthenticationRequest tfaStartAuthenticationRequest,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for sendTfaPinCodeOverVoice.

Parameters:

tfaStartAuthenticationRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverVoice

public TfaStartAuthenticationResponse sendTfaPinCodeOverVoice(TfaStartAuthenticationRequest tfaStartAuthenticationRequest)
                                                       throws ApiException

Send 2FA PIN code over Voice. Send a PIN code over Voice using previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

tfaStartAuthenticationRequest - (optional)

Returns:

TfaStartAuthenticationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverVoiceWithHttpInfo

public ApiResponse<TfaStartAuthenticationResponse> sendTfaPinCodeOverVoiceWithHttpInfo(TfaStartAuthenticationRequest tfaStartAuthenticationRequest)
                                                                                throws ApiException

Send 2FA PIN code over Voice. Send a PIN code over Voice using previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

tfaStartAuthenticationRequest - (optional)

Returns:

ApiResponse<TfaStartAuthenticationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

sendTfaPinCodeOverVoiceAsync

public okhttp3.Call sendTfaPinCodeOverVoiceAsync(TfaStartAuthenticationRequest tfaStartAuthenticationRequest,
                                                 ApiCallback<TfaStartAuthenticationResponse> _callback)
                                          throws ApiException

Send 2FA PIN code over Voice (asynchronously). Send a PIN code over Voice using previously created [message template](#channels/sms/create-2fa-message-template).

Parameters:

tfaStartAuthenticationRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

updateTfaApplicationCall

public okhttp3.Call updateTfaApplicationCall(String appId,
                                             TfaApplicationRequest tfaApplicationRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for updateTfaApplication.

Parameters:

appId - ID of application that should be updated. (required)

tfaApplicationRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

updateTfaApplication

public TfaApplicationResponse updateTfaApplication(String appId,
                                                   TfaApplicationRequest tfaApplicationRequest)
                                            throws ApiException

Update 2FA application. Change configuration options for your existing 2FA application.

Parameters:

appId - ID of application that should be updated. (required)

tfaApplicationRequest - (optional)

Returns:

TfaApplicationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

updateTfaApplicationWithHttpInfo

public ApiResponse<TfaApplicationResponse> updateTfaApplicationWithHttpInfo(String appId,
                                                                            TfaApplicationRequest tfaApplicationRequest)
                                                                     throws ApiException

Update 2FA application. Change configuration options for your existing 2FA application.

Parameters:

appId - ID of application that should be updated. (required)

tfaApplicationRequest - (optional)

Returns:

ApiResponse<TfaApplicationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

updateTfaApplicationAsync

public okhttp3.Call updateTfaApplicationAsync(String appId,
                                              TfaApplicationRequest tfaApplicationRequest,
                                              ApiCallback<TfaApplicationResponse> _callback)
                                       throws ApiException

Update 2FA application (asynchronously). Change configuration options for your existing 2FA application.

Parameters:

appId - ID of application that should be updated. (required)

tfaApplicationRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

updateTfaMessageTemplateCall

public okhttp3.Call updateTfaMessageTemplateCall(String appId,
                                                 String msgId,
                                                 TfaUpdateMessageRequest tfaUpdateMessageRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for updateTfaMessageTemplate.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

tfaUpdateMessageRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

updateTfaMessageTemplate

public TfaMessage updateTfaMessageTemplate(String appId,
                                           String msgId,
                                           TfaUpdateMessageRequest tfaUpdateMessageRequest)
                                    throws ApiException

Update 2FA message template. Change configuration options for your existing 2FA application message template.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

tfaUpdateMessageRequest - (optional)

Returns:

TfaMessage

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

updateTfaMessageTemplateWithHttpInfo

public ApiResponse<TfaMessage> updateTfaMessageTemplateWithHttpInfo(String appId,
                                                                    String msgId,
                                                                    TfaUpdateMessageRequest tfaUpdateMessageRequest)
                                                             throws ApiException

Update 2FA message template. Change configuration options for your existing 2FA application message template.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

tfaUpdateMessageRequest - (optional)

Returns:

ApiResponse<TfaMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

updateTfaMessageTemplateAsync

public okhttp3.Call updateTfaMessageTemplateAsync(String appId,
                                                  String msgId,
                                                  TfaUpdateMessageRequest tfaUpdateMessageRequest,
                                                  ApiCallback<TfaMessage> _callback)
                                           throws ApiException

Update 2FA message template (asynchronously). Change configuration options for your existing 2FA application message template.

Parameters:

appId - ID of application for which requested message was created. (required)

msgId - Requested message ID. (required)

tfaUpdateMessageRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases

verifyTfaPhoneNumberCall

public okhttp3.Call verifyTfaPhoneNumberCall(String pinId,
                                             TfaVerifyPinRequest tfaVerifyPinRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for verifyTfaPhoneNumber.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaVerifyPinRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Read me first: Introduction and use cases

verifyTfaPhoneNumber

public TfaVerifyPinResponse verifyTfaPhoneNumber(String pinId,
                                                 TfaVerifyPinRequest tfaVerifyPinRequest)
                                          throws ApiException

Verify phone number. Verify a phone number to confirm successful 2FA authentication.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaVerifyPinRequest - (optional)

Returns:

TfaVerifyPinResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

verifyTfaPhoneNumberWithHttpInfo

public ApiResponse<TfaVerifyPinResponse> verifyTfaPhoneNumberWithHttpInfo(String pinId,
                                                                          TfaVerifyPinRequest tfaVerifyPinRequest)
                                                                   throws ApiException

Verify phone number. Verify a phone number to confirm successful 2FA authentication.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaVerifyPinRequest - (optional)

Returns:

ApiResponse<TfaVerifyPinResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Read me first: Introduction and use cases

verifyTfaPhoneNumberAsync

public okhttp3.Call verifyTfaPhoneNumberAsync(String pinId,
                                              TfaVerifyPinRequest tfaVerifyPinRequest,
                                              ApiCallback<TfaVerifyPinResponse> _callback)
                                       throws ApiException

Verify phone number (asynchronously). Verify a phone number to confirm successful 2FA authentication.

Parameters:

pinId - ID of the pin code that has to be verified. (required)

tfaVerifyPinRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Read me first: Introduction and use cases