Package com.adyen.model.legalentitymanagement

Class OnboardingLinkInfo

java.lang.Object

com.adyen.model.legalentitymanagement.OnboardingLinkInfo

public class OnboardingLinkInfo
extends Object

OnboardingLinkInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OnboardingLinkInfo.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_LOCALE
static String	SERIALIZED_NAME_REDIRECT_URL
static String	SERIALIZED_NAME_SETTINGS
static String	SERIALIZED_NAME_THEME_ID

Constructor Summary

Constructors

Constructor	Description
OnboardingLinkInfo()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static OnboardingLinkInfo	fromJson(String jsonString)	Create an instance of OnboardingLinkInfo given an JSON string
String	getLocale()	The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
String	getRedirectUrl()	The URL where the user is redirected after they complete hosted onboarding.
Map<String,Boolean>	getSettings()	Boolean key-value pairs indicating the settings for the hosted onboarding page.
String	getThemeId()	The unique identifier of the hosted onboarding theme.
int	hashCode()
OnboardingLinkInfo	locale(String locale)
OnboardingLinkInfo	putSettingsItem(String key, Boolean settingsItem)
OnboardingLinkInfo	redirectUrl(String redirectUrl)
void	setLocale(String locale)
void	setRedirectUrl(String redirectUrl)
void	setSettings(Map<String,Boolean> settings)
void	setThemeId(String themeId)
OnboardingLinkInfo	settings(Map<String,Boolean> settings)
OnboardingLinkInfo	themeId(String themeId)
String	toJson()	Convert an instance of OnboardingLinkInfo to an JSON string
String	toString()
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_LOCALE

public static final String SERIALIZED_NAME_LOCALE

See Also:

Constant Field Values

SERIALIZED_NAME_REDIRECT_URL

public static final String SERIALIZED_NAME_REDIRECT_URL

See Also:

Constant Field Values

SERIALIZED_NAME_SETTINGS

public static final String SERIALIZED_NAME_SETTINGS

See Also:

Constant Field Values

SERIALIZED_NAME_THEME_ID

public static final String SERIALIZED_NAME_THEME_ID

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

OnboardingLinkInfo

public OnboardingLinkInfo()

Method Detail

locale

public OnboardingLinkInfo locale(String locale)

getLocale

public String getLocale()

The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. See [possible values](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted#supported-languages). If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.

Returns:

locale

setLocale

public void setLocale(String locale)

redirectUrl

public OnboardingLinkInfo redirectUrl(String redirectUrl)

getRedirectUrl

public String getRedirectUrl()

The URL where the user is redirected after they complete hosted onboarding.

Returns:

redirectUrl

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

settings

public OnboardingLinkInfo settings(Map<String,Boolean> settings)

putSettingsItem

public OnboardingLinkInfo putSettingsItem(String key,
                                          Boolean settingsItem)

getSettings

public Map<String,Boolean> getSettings()

Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings. By default, the values are set to **true**. Set to **false** to not allow the action. Possible keys: - **changeLegalEntityType**: The user can change their legal entity type. - **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.

Returns:

settings

setSettings

public void setSettings(Map<String,Boolean> settings)

themeId

public OnboardingLinkInfo themeId(String themeId)

getThemeId

public String getThemeId()

The unique identifier of the hosted onboarding theme.

Returns:

themeId

setThemeId

public void setThemeId(String themeId)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonObject

public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException

Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to OnboardingLinkInfo

fromJson

public static OnboardingLinkInfo fromJson(String jsonString)
                                   throws IOException

Create an instance of OnboardingLinkInfo given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OnboardingLinkInfo

Throws:

IOException - if the JSON string is invalid with respect to OnboardingLinkInfo

toJson

public String toJson()

Convert an instance of OnboardingLinkInfo to an JSON string

Returns:

JSON string