Package com.bandwidth.sdk.api

Class MfaApi

java.lang.Object

com.bandwidth.sdk.api.MfaApi

public class MfaApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MfaApi()
MfaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
MessagingCodeResponse	generateMessagingCode(String accountId, CodeRequest codeRequest)	Messaging Authentication Code Send an MFA code via text message (SMS).
okhttp3.Call	generateMessagingCodeAsync(String accountId, CodeRequest codeRequest, ApiCallback<MessagingCodeResponse> _callback)	Messaging Authentication Code (asynchronously) Send an MFA code via text message (SMS).
okhttp3.Call	generateMessagingCodeCall(String accountId, CodeRequest codeRequest, ApiCallback _callback)	Build call for generateMessagingCode
ApiResponse<MessagingCodeResponse>	generateMessagingCodeWithHttpInfo(String accountId, CodeRequest codeRequest)	Messaging Authentication Code Send an MFA code via text message (SMS).
VoiceCodeResponse	generateVoiceCode(String accountId, CodeRequest codeRequest)	Voice Authentication Code Send an MFA Code via a phone call.
okhttp3.Call	generateVoiceCodeAsync(String accountId, CodeRequest codeRequest, ApiCallback<VoiceCodeResponse> _callback)	Voice Authentication Code (asynchronously) Send an MFA Code via a phone call.
okhttp3.Call	generateVoiceCodeCall(String accountId, CodeRequest codeRequest, ApiCallback _callback)	Build call for generateVoiceCode
ApiResponse<VoiceCodeResponse>	generateVoiceCodeWithHttpInfo(String accountId, CodeRequest codeRequest)	Voice Authentication Code Send an MFA Code via a phone call.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
VerifyCodeResponse	verifyCode(String accountId, VerifyCodeRequest verifyCodeRequest)	Verify Authentication Code Verify a previously sent MFA code.
okhttp3.Call	verifyCodeAsync(String accountId, VerifyCodeRequest verifyCodeRequest, ApiCallback<VerifyCodeResponse> _callback)	Verify Authentication Code (asynchronously) Verify a previously sent MFA code.
okhttp3.Call	verifyCodeCall(String accountId, VerifyCodeRequest verifyCodeRequest, ApiCallback _callback)	Build call for verifyCode
ApiResponse<VerifyCodeResponse>	verifyCodeWithHttpInfo(String accountId, VerifyCodeRequest verifyCodeRequest)	Verify Authentication Code Verify a previously sent MFA code.

Methods inherited from class java.lang.Object

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

Constructor Detail

MfaApi

public MfaApi()

MfaApi

public MfaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

generateMessagingCodeCall

public okhttp3.Call generateMessagingCodeCall(String accountId,
                                              CodeRequest codeRequest,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for generateMessagingCode

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateMessagingCode

public MessagingCodeResponse generateMessagingCode(String accountId,
                                                   CodeRequest codeRequest)
                                            throws ApiException

Messaging Authentication Code Send an MFA code via text message (SMS).

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

Returns:

MessagingCodeResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateMessagingCodeWithHttpInfo

public ApiResponse<MessagingCodeResponse> generateMessagingCodeWithHttpInfo(String accountId,
                                                                            CodeRequest codeRequest)
                                                                     throws ApiException

Messaging Authentication Code Send an MFA code via text message (SMS).

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

Returns:

ApiResponse<MessagingCodeResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateMessagingCodeAsync

public okhttp3.Call generateMessagingCodeAsync(String accountId,
                                               CodeRequest codeRequest,
                                               ApiCallback<MessagingCodeResponse> _callback)
                                        throws ApiException

Messaging Authentication Code (asynchronously) Send an MFA code via text message (SMS).

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateVoiceCodeCall

public okhttp3.Call generateVoiceCodeCall(String accountId,
                                          CodeRequest codeRequest,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for generateVoiceCode

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateVoiceCode

public VoiceCodeResponse generateVoiceCode(String accountId,
                                           CodeRequest codeRequest)
                                    throws ApiException

Voice Authentication Code Send an MFA Code via a phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

Returns:

VoiceCodeResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateVoiceCodeWithHttpInfo

public ApiResponse<VoiceCodeResponse> generateVoiceCodeWithHttpInfo(String accountId,
                                                                    CodeRequest codeRequest)
                                                             throws ApiException

Voice Authentication Code Send an MFA Code via a phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (required)

Returns:

ApiResponse<VoiceCodeResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

generateVoiceCodeAsync

public okhttp3.Call generateVoiceCodeAsync(String accountId,
                                           CodeRequest codeRequest,
                                           ApiCallback<VoiceCodeResponse> _callback)
                                    throws ApiException

Voice Authentication Code (asynchronously) Send an MFA Code via a phone call.

Parameters:

accountId - Your Bandwidth Account ID. (required)

codeRequest - MFA code request body. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
500	Internal Server Error	-

verifyCodeCall

public okhttp3.Call verifyCodeCall(String accountId,
                                   VerifyCodeRequest verifyCodeRequest,
                                   ApiCallback _callback)
                            throws ApiException

Build call for verifyCode

Parameters:

accountId - Your Bandwidth Account ID. (required)

verifyCodeRequest - MFA code verify request body. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
500	Internal Server Error	-

verifyCode

public VerifyCodeResponse verifyCode(String accountId,
                                     VerifyCodeRequest verifyCodeRequest)
                              throws ApiException

Verify Authentication Code Verify a previously sent MFA code.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verifyCodeRequest - MFA code verify request body. (required)

Returns:

VerifyCodeResponse

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
500	Internal Server Error	-

verifyCodeWithHttpInfo

public ApiResponse<VerifyCodeResponse> verifyCodeWithHttpInfo(String accountId,
                                                              VerifyCodeRequest verifyCodeRequest)
                                                       throws ApiException

Verify Authentication Code Verify a previously sent MFA code.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verifyCodeRequest - MFA code verify request body. (required)

Returns:

ApiResponse<VerifyCodeResponse>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
500	Internal Server Error	-

verifyCodeAsync

public okhttp3.Call verifyCodeAsync(String accountId,
                                    VerifyCodeRequest verifyCodeRequest,
                                    ApiCallback<VerifyCodeResponse> _callback)
                             throws ApiException

Verify Authentication Code (asynchronously) Verify a previously sent MFA code.

Parameters:

accountId - Your Bandwidth Account ID. (required)

verifyCodeRequest - MFA code verify request body. (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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
429	Too Many Requests	-
500	Internal Server Error	-