Package io.moov.sdk.models.components

Class OnboardingInvite.Builder

java.lang.Object

io.moov.sdk.models.components.OnboardingInvite.Builder

Enclosing class:

OnboardingInvite

public static final class OnboardingInvite.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
OnboardingInvite	build()
OnboardingInvite.Builder	capabilities(java.util.List<CapabilityID> capabilities)	List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this account.
OnboardingInvite.Builder	code(java.lang.String code)	A unique code that identifies an onboarding invite.
OnboardingInvite.Builder	createdOn(java.time.OffsetDateTime createdOn)
OnboardingInvite.Builder	feePlanCodes(java.util.List<java.lang.String> feePlanCodes)	List of fee plan codes to assign the account created by the invitee.
OnboardingInvite.Builder	link(java.lang.String link)	A unique URL, including the invite code, that the recipient can follow to redeem the invitation.
OnboardingInvite.Builder	partner(OnboardingPartnerAccount partner)	The account that created the onboarding invite.
OnboardingInvite.Builder	partner(java.util.Optional<? extends OnboardingPartnerAccount> partner)	The account that created the onboarding invite.
OnboardingInvite.Builder	prefill(CreateAccount prefill)
OnboardingInvite.Builder	prefill(java.util.Optional<? extends CreateAccount> prefill)
OnboardingInvite.Builder	redeemedAccountID(java.lang.String redeemedAccountID)	The account ID of the account that redeemed the invite.
OnboardingInvite.Builder	redeemedAccountID(java.util.Optional<java.lang.String> redeemedAccountID)	The account ID of the account that redeemed the invite.
OnboardingInvite.Builder	redeemedOn(java.time.OffsetDateTime redeemedOn)
OnboardingInvite.Builder	redeemedOn(java.util.Optional<java.time.OffsetDateTime> redeemedOn)
OnboardingInvite.Builder	returnURL(java.lang.String returnURL)	The scopes requested by the inviter.
OnboardingInvite.Builder	returnURL(java.util.Optional<java.lang.String> returnURL)	The scopes requested by the inviter.
OnboardingInvite.Builder	revokedOn(java.time.OffsetDateTime revokedOn)
OnboardingInvite.Builder	revokedOn(java.util.Optional<java.time.OffsetDateTime> revokedOn)
OnboardingInvite.Builder	scopes(java.util.List<ApplicationScope> scopes)	List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this account.
OnboardingInvite.Builder	termsOfServiceURL(java.lang.String termsOfServiceURL)	The terms of service URL set by the inviter.
OnboardingInvite.Builder	termsOfServiceURL(java.util.Optional<java.lang.String> termsOfServiceURL)	The terms of service URL set by the inviter.

Methods inherited from class java.lang.Object

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

Method Detail

code

public OnboardingInvite.Builder code(java.lang.String code)

A unique code that identifies an onboarding invite.

link

public OnboardingInvite.Builder link(java.lang.String link)

A unique URL, including the invite code, that the recipient can follow to redeem the invitation.

returnURL

public OnboardingInvite.Builder returnURL(java.lang.String returnURL)

The scopes requested by the inviter.

returnURL

public OnboardingInvite.Builder returnURL(java.util.Optional<java.lang.String> returnURL)

The scopes requested by the inviter.

termsOfServiceURL

public OnboardingInvite.Builder termsOfServiceURL(java.lang.String termsOfServiceURL)

The terms of service URL set by the inviter.

termsOfServiceURL

public OnboardingInvite.Builder termsOfServiceURL(java.util.Optional<java.lang.String> termsOfServiceURL)

The terms of service URL set by the inviter.

scopes

public OnboardingInvite.Builder scopes(java.util.List<ApplicationScope> scopes)

List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this account. These values are used to determine what can be done with the account onboarded.

capabilities

public OnboardingInvite.Builder capabilities(java.util.List<CapabilityID> capabilities)

List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this account. These values are used to determine what information to collect from the user during onboarding.

feePlanCodes

public OnboardingInvite.Builder feePlanCodes(java.util.List<java.lang.String> feePlanCodes)

List of fee plan codes to assign the account created by the invitee.

redeemedAccountID

public OnboardingInvite.Builder redeemedAccountID(java.lang.String redeemedAccountID)

The account ID of the account that redeemed the invite.

redeemedAccountID

public OnboardingInvite.Builder redeemedAccountID(java.util.Optional<java.lang.String> redeemedAccountID)

The account ID of the account that redeemed the invite.

prefill

public OnboardingInvite.Builder prefill(CreateAccount prefill)

prefill

public OnboardingInvite.Builder prefill(java.util.Optional<? extends CreateAccount> prefill)

partner

public OnboardingInvite.Builder partner(OnboardingPartnerAccount partner)

The account that created the onboarding invite.

partner

public OnboardingInvite.Builder partner(java.util.Optional<? extends OnboardingPartnerAccount> partner)

The account that created the onboarding invite.

createdOn

public OnboardingInvite.Builder createdOn(java.time.OffsetDateTime createdOn)

revokedOn

public OnboardingInvite.Builder revokedOn(java.time.OffsetDateTime revokedOn)

revokedOn

public OnboardingInvite.Builder revokedOn(java.util.Optional<java.time.OffsetDateTime> revokedOn)

redeemedOn

public OnboardingInvite.Builder redeemedOn(java.time.OffsetDateTime redeemedOn)

redeemedOn

public OnboardingInvite.Builder redeemedOn(java.util.Optional<java.time.OffsetDateTime> redeemedOn)

build

public OnboardingInvite build()