AFCore/com.advantahealth.api.activeperks.model/ActivePerksEnrollment

ActivePerksEnrollment

data class ActivePerksEnrollment(val isEnrolled: Boolean, val email: String?, val enrollmentState: ActivePerksEnrollmentState?, val enrollmentStatusValue: String?, val needsRecovery: Boolean)

Enrollment status of the authenticated member in ActivePerks.

Returned by AFCore.activePerks().getEnrollment() and by signUp(...) (the signup response is this same shape).

Constructors

constructor(isEnrolled: Boolean, email: String?, enrollmentState: ActivePerksEnrollmentState?, enrollmentStatusValue: String?, needsRecovery: Boolean)

Properties

val email: String?

The email tied to the ActivePerks account, or null when the member has no account and no recoverable profile.

enrollmentState

val enrollmentState: ActivePerksEnrollmentState?

Typed enrollment state, or null when the server sent no status - which is normal right after a successful signup and on the recovery branch, not an error.

enrollmentStatusValue

val enrollmentStatusValue: String?

The verbatim status string from the server ("PENDING", "ACTIVE", "FAILED", "NEEDS_RECOVERY", or a future value), kept so no server state is lost when enrollmentState is ActivePerksEnrollmentState.UNRECOGNIZED.

isEnrolled

val isEnrolled: Boolean

Whether the member has an active ActivePerks account.

needsRecovery

val needsRecovery: Boolean

true when an ActivePerks account exists upstream but the local credentials are missing, so the app should run the recovery flow instead of a fresh signup.