Package io.moov.sdk.models.components

Class OnboardingInviteRequest

java.lang.Object

io.moov.sdk.models.components.OnboardingInviteRequest

public class OnboardingInviteRequest
extends java.lang.Object

OnboardingInviteRequest

Request to create an onboarding invite.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OnboardingInviteRequest.Builder

Constructor Summary

Constructors

Constructor	Description
OnboardingInviteRequest(java.util.List<ApplicationScope> scopes, java.util.List<CapabilityID> capabilities, java.util.List<java.lang.String> feePlanCodes)
OnboardingInviteRequest(java.util.Optional<java.lang.String> returnURL, java.util.Optional<java.lang.String> termsOfServiceURL, java.util.List<ApplicationScope> scopes, java.util.List<CapabilityID> capabilities, java.util.List<java.lang.String> feePlanCodes, java.util.Optional<? extends CreateAccount> prefill)

Method Summary

Modifier and Type	Method	Description
static OnboardingInviteRequest.Builder	builder()
java.util.List<CapabilityID>	capabilities()	List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this account.
boolean	equals(java.lang.Object o)
java.util.List<java.lang.String>	feePlanCodes()	List of fee plan codes to assign the account created by the invitee.
int	hashCode()
java.util.Optional<CreateAccount>	prefill()
java.util.Optional<java.lang.String>	returnURL()	Optional URL to redirect the user to after they complete the onboarding process.
java.util.List<ApplicationScope>	scopes()	List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this account.
java.util.Optional<java.lang.String>	termsOfServiceURL()	Optional URL to your organization's terms of service.
java.lang.String	toString()
OnboardingInviteRequest	withCapabilities(java.util.List<CapabilityID> capabilities)	List of [capabilities](https://docs.moov.io/guides/accounts/capabilities/) you intend to request for this account.
OnboardingInviteRequest	withFeePlanCodes(java.util.List<java.lang.String> feePlanCodes)	List of fee plan codes to assign the account created by the invitee.
OnboardingInviteRequest	withPrefill(CreateAccount prefill)
OnboardingInviteRequest	withPrefill(java.util.Optional<? extends CreateAccount> prefill)
OnboardingInviteRequest	withReturnURL(java.lang.String returnURL)	Optional URL to redirect the user to after they complete the onboarding process.
OnboardingInviteRequest	withReturnURL(java.util.Optional<java.lang.String> returnURL)	Optional URL to redirect the user to after they complete the onboarding process.
OnboardingInviteRequest	withScopes(java.util.List<ApplicationScope> scopes)	List of [scopes](https://docs.moov.io/api/authentication/scopes/) you request to use on this account.
OnboardingInviteRequest	withTermsOfServiceURL(java.lang.String termsOfServiceURL)	Optional URL to your organization's terms of service.
OnboardingInviteRequest	withTermsOfServiceURL(java.util.Optional<java.lang.String> termsOfServiceURL)	Optional URL to your organization's terms of service.

Methods inherited from class java.lang.Object

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

Constructor Detail

OnboardingInviteRequest

public OnboardingInviteRequest(java.util.Optional<java.lang.String> returnURL,
                               java.util.Optional<java.lang.String> termsOfServiceURL,
                               java.util.List<ApplicationScope> scopes,
                               java.util.List<CapabilityID> capabilities,
                               java.util.List<java.lang.String> feePlanCodes,
                               java.util.Optional<? extends CreateAccount> prefill)

OnboardingInviteRequest

public OnboardingInviteRequest(java.util.List<ApplicationScope> scopes,
                               java.util.List<CapabilityID> capabilities,
                               java.util.List<java.lang.String> feePlanCodes)

Method Detail

returnURL

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

Optional URL to redirect the user to after they complete the onboarding process.

termsOfServiceURL

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

Optional URL to your organization's terms of service.

scopes

public 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 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 java.util.List<java.lang.String> feePlanCodes()

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

prefill

public java.util.Optional<CreateAccount> prefill()

builder

public static final OnboardingInviteRequest.Builder builder()

withReturnURL

public OnboardingInviteRequest withReturnURL(java.lang.String returnURL)

Optional URL to redirect the user to after they complete the onboarding process.

withReturnURL

public OnboardingInviteRequest withReturnURL(java.util.Optional<java.lang.String> returnURL)

Optional URL to redirect the user to after they complete the onboarding process.

withTermsOfServiceURL

public OnboardingInviteRequest withTermsOfServiceURL(java.lang.String termsOfServiceURL)

Optional URL to your organization's terms of service.

withTermsOfServiceURL

public OnboardingInviteRequest withTermsOfServiceURL(java.util.Optional<java.lang.String> termsOfServiceURL)

Optional URL to your organization's terms of service.

withScopes

public OnboardingInviteRequest withScopes(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.

withCapabilities

public OnboardingInviteRequest withCapabilities(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.

withFeePlanCodes

public OnboardingInviteRequest withFeePlanCodes(java.util.List<java.lang.String> feePlanCodes)

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

withPrefill

public OnboardingInviteRequest withPrefill(CreateAccount prefill)

withPrefill

public OnboardingInviteRequest withPrefill(java.util.Optional<? extends CreateAccount> prefill)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object