Package model

Class OnboardingFormOnboardingLink

java.lang.Object

model.OnboardingFormOnboardingLink

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class OnboardingFormOnboardingLink
extends Object

The information of the initial onboarding link. This is only provided when creating an `onboarding_form`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OnboardingFormOnboardingLink.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_EXPIRES_AT
static String	SERIALIZED_NAME_LINK_URL

Constructor Summary

Constructors

Constructor	Description
OnboardingFormOnboardingLink()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
OnboardingFormOnboardingLink	expiresAt(String expiresAt)
static OnboardingFormOnboardingLink	fromJson(String jsonString)	Create an instance of OnboardingFormOnboardingLink given an JSON string
String	getExpiresAt()	A UTC timestamp detailing when the onboarding form expires and will no longer be available via `link_url`.
String	getLinkUrl()	The URL of the user's Finix Onboarding Form.
int	hashCode()
OnboardingFormOnboardingLink	linkUrl(String linkUrl)
void	setExpiresAt(String expiresAt)
void	setLinkUrl(String linkUrl)
String	toJson()	Convert an instance of OnboardingFormOnboardingLink 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_EXPIRES_AT

public static final String SERIALIZED_NAME_EXPIRES_AT

See Also:

Constant Field Values

SERIALIZED_NAME_LINK_URL

public static final String SERIALIZED_NAME_LINK_URL

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

OnboardingFormOnboardingLink

public OnboardingFormOnboardingLink()

Method Detail

expiresAt

public OnboardingFormOnboardingLink expiresAt(String expiresAt)

getExpiresAt

@Nullable
public String getExpiresAt()

A UTC timestamp detailing when the onboarding form expires and will no longer be available via `link_url`. To generate a new link to the same form, see [Get an Onboarding Form URL](/guides/onboarding/onboarding-form/#get-an-onboarding-form-url).

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(String expiresAt)

linkUrl

public OnboardingFormOnboardingLink linkUrl(String linkUrl)

getLinkUrl

@Nullable
public String getLinkUrl()

The URL of the user's Finix Onboarding Form. Users can use the `link_url` to return to the form until the link expires.

Returns:

linkUrl

setLinkUrl

public void setLinkUrl(String linkUrl)

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 OnboardingFormOnboardingLink

fromJson

public static OnboardingFormOnboardingLink fromJson(String jsonString)
                                             throws IOException

Create an instance of OnboardingFormOnboardingLink given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OnboardingFormOnboardingLink

Throws:

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

toJson

public String toJson()

Convert an instance of OnboardingFormOnboardingLink to an JSON string

Returns:

JSON string