Package io.moov.sdk.models.components

Class OnboardingInvite

  • public class OnboardingInvite
extends java.lang.Object

    • Constructor Detail

      • OnboardingInvite

        public OnboardingInvite​(java.lang.String code,
                        java.lang.String link,
                        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<java.lang.String> redeemedAccountID,
                        java.util.Optional<? extends CreateAccount> prefill,
                        java.util.Optional<? extends OnboardingPartnerAccount> partner,
                        java.time.OffsetDateTime createdOn,
                        java.util.Optional<java.time.OffsetDateTime> revokedOn,
                        java.util.Optional<java.time.OffsetDateTime> redeemedOn)

      • OnboardingInvite

        public OnboardingInvite​(java.lang.String code,
                        java.lang.String link,
                        java.util.List<ApplicationScope> scopes,
                        java.util.List<CapabilityID> capabilities,
                        java.util.List<java.lang.String> feePlanCodes,
                        java.time.OffsetDateTime createdOn)

    • Method Detail

      • code

        public java.lang.String code()
        A unique code that identifies an onboarding invite.

      • link

        public java.lang.String link()
        A unique URL, including the invite code, that the recipient can follow to redeem the invitation.

      • returnURL

        public java.util.Optional<java.lang.String> returnURL()
        The scopes requested by the inviter.

      • termsOfServiceURL

        public java.util.Optional<java.lang.String> termsOfServiceURL()
        The terms of service URL set by the inviter.

      • 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.

      • redeemedAccountID

        public java.util.Optional<java.lang.String> redeemedAccountID()
        The account ID of the account that redeemed the invite.

      • partner

        public java.util.Optional<OnboardingPartnerAccount> partner()
        The account that created the onboarding invite.

      • createdOn

        public java.time.OffsetDateTime createdOn()

      • revokedOn

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

      • redeemedOn

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

      • withCode

        public OnboardingInvite withCode​(java.lang.String code)
        A unique code that identifies an onboarding invite.

      • withLink

        public OnboardingInvite withLink​(java.lang.String link)
        A unique URL, including the invite code, that the recipient can follow to redeem the invitation.

      • withReturnURL

        public OnboardingInvite withReturnURL​(java.lang.String returnURL)
        The scopes requested by the inviter.

      • withReturnURL

        public OnboardingInvite withReturnURL​(java.util.Optional<java.lang.String> returnURL)
        The scopes requested by the inviter.

      • withTermsOfServiceURL

        public OnboardingInvite withTermsOfServiceURL​(java.lang.String termsOfServiceURL)
        The terms of service URL set by the inviter.

      • withTermsOfServiceURL

        public OnboardingInvite withTermsOfServiceURL​(java.util.Optional<java.lang.String> termsOfServiceURL)
        The terms of service URL set by the inviter.

      • withScopes

        public OnboardingInvite 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 OnboardingInvite 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 OnboardingInvite withFeePlanCodes​(java.util.List<java.lang.String> feePlanCodes)
        List of fee plan codes to assign the account created by the invitee.

      • withRedeemedAccountID

        public OnboardingInvite withRedeemedAccountID​(java.lang.String redeemedAccountID)
        The account ID of the account that redeemed the invite.

      • withRedeemedAccountID

        public OnboardingInvite withRedeemedAccountID​(java.util.Optional<java.lang.String> redeemedAccountID)
        The account ID of the account that redeemed the invite.

      • withCreatedOn

        public OnboardingInvite withCreatedOn​(java.time.OffsetDateTime createdOn)

      • withRevokedOn

        public OnboardingInvite withRevokedOn​(java.time.OffsetDateTime revokedOn)

      • withRevokedOn

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

      • withRedeemedOn

        public OnboardingInvite withRedeemedOn​(java.time.OffsetDateTime redeemedOn)

      • withRedeemedOn

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

      • 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