Package io.tokenchannel

Class TokenChannel

java.lang.Object

io.tokenchannel.TokenChannel

public class TokenChannel
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOKENCHANNEL_BASE_URI

Constructor Summary

Constructors

Constructor	Description
TokenChannel(TokenChannelProperties properties, com.google.gson.Gson gson)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AuthenticateResponse>	authenticate(String requestId, String authCode)	Verifies a previously created challenge
CompletableFuture<ChallengeResponse>	challenge(ChannelType channel, String identifier, ChallengeOptions options)	Creates a challenge, ie, generates a token to be sent by a given a channel to a given identifier
CompletableFuture<List<SMSPriceItem>>	getSMSPrices()	Retrieves the SMS pricing list for supported countries
CompletableFuture<List<String>>	getSupportedCountries()	Retrieves the countries TokenChannel service is available
CompletableFuture<List<String>>	getSupportedLanguages()	Retrieves the available languages or locales for the token notification templates
CompletableFuture<TestResponse>	getValidationCodeByTestChallengeId(String requestId)	Retrieves the validation code of a challenge that was previously created with test mode enabled
CompletableFuture<List<VoicePriceItem>>	getVoicePrices()	Retrieves the voice call pricing list for supported countries
CompletableFuture<List<WhatsappPriceItem>>	getWhatsappPrices()	Retrieves the Whatsapp pricing list for supported countries

Methods inherited from class java.lang.Object

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

Field Detail

TOKENCHANNEL_BASE_URI

public static final String TOKENCHANNEL_BASE_URI

See Also:

Constant Field Values

Constructor Detail

TokenChannel

public TokenChannel(TokenChannelProperties properties,
                    com.google.gson.Gson gson)

Method Detail

challenge

public CompletableFuture<ChallengeResponse> challenge(ChannelType channel,
                                                      String identifier,
                                                      ChallengeOptions options)

Creates a challenge, ie, generates a token to be sent by a given a channel to a given identifier

Parameters:

channel - - The channel the token is being delivered

identifier - - the customer identifier in the given channel

options - - The challenge workflow configuration

Throws:

InvalidIdentifierException - whether the identifier is invalid for the given channel

TargetOptOutException - whether the target user opted out this service via this channel

BadRequestException - whether there is an invalid value in the request. The field errorInfo in the BadRequestError describes the invalid value

OutOfBalanceException - whether there is not enough balance to attend a balance consumer challenge creation

ForbiddenException - whether requesting an action that provided api key is not allowed

UnauthorizedException - whether an invalid api key value is provided

QuotaExceededException - whether Sandbox quota, QPS o QPM have been exceeded

authenticate

public CompletableFuture<AuthenticateResponse> authenticate(String requestId,
                                                            String authCode)

Verifies a previously created challenge

Parameters:

requestId - - The handle to a given challenge

authCode - - The token or validation code to try challenge authentication

Throws:

InvalidCodeException - whether the token or validation code provide is invalid

BadRequestException - whether the requestId format is invalid

ChallengeClosedException - whether the challenge is closed and no interaction is expected

ChallengeExpiredException - whether the challenge validity is over

ChallengeNotFoundException - whether the requestId is well formatted but a challenge for that id cannot be found

MaxAttemptsExceededException - whether the max number ot attempts allowed has been reached

ForbiddenException - whether requesting an action that provided api key is not allowed to perform

UnauthorizedException - whether an invalid api key value is provided

QuotaExceededException - whether Sandbox quota, QPS o QPM have been exceeded

getValidationCodeByTestChallengeId

public CompletableFuture<TestResponse> getValidationCodeByTestChallengeId(String requestId)

Retrieves the validation code of a challenge that was previously created with test mode enabled

Parameters:

requestId - - The handle to a given challenge

Throws:

BadRequestException - whether the requestId format is invalid

ForbiddenException - whether requesting an action that provided api key is not allowed to perform

UnauthorizedException - whether an invalid api key value is provided

QuotaExceededException - whether QPS o QPM have been exceeded

getSupportedCountries

public CompletableFuture<List<String>> getSupportedCountries()

Retrieves the countries TokenChannel service is available

Throws:

QuotaExceededException - whether QPS o QPM have been exceeded

getSupportedLanguages

public CompletableFuture<List<String>> getSupportedLanguages()

Retrieves the available languages or locales for the token notification templates

Throws:

QuotaExceededException - whether QPS o QPM have been exceeded

getSMSPrices

public CompletableFuture<List<SMSPriceItem>> getSMSPrices()

Retrieves the SMS pricing list for supported countries

Throws:

QuotaExceededException - whether QPS o QPM have been exceeded

getVoicePrices

public CompletableFuture<List<VoicePriceItem>> getVoicePrices()

Retrieves the voice call pricing list for supported countries

Throws:

QuotaExceededException - whether QPS o QPM have been exceeded

getWhatsappPrices

public CompletableFuture<List<WhatsappPriceItem>> getWhatsappPrices()

Retrieves the Whatsapp pricing list for supported countries

Throws:

QuotaExceededException - whether QPS o QPM have been exceeded