Stytch Android/com.stytch.sdk.b2b.magicLinks/B2BMagicLinks/EmailMagicLinks

EmailMagicLinks

interface EmailMagicLinks

Provides all possible ways to call EmailMagicLinks endpoints

Types

Link copied to clipboard
data class DiscoverySendParameters @JvmOverloads constructor(val emailAddress: String, val discoveryRedirectUrl: String? = null, val loginTemplateId: String? = null, val locale: Locale? = null)

A data class used for wrapping paramaters used for sending a discovery magic link

Link copied to clipboard
data class InviteParameters @JvmOverloads constructor(val emailAddress: String, val inviteRedirectUrl: String? = null, val inviteTemplateId: String? = null, val name: String? = null, val untrustedMetadata: Map<String, Any?>? = null, val locale: Locale? = null, val roles: List<String>? = null)

A data class used for wrapping paramaters used for sending an invite magic link

Link copied to clipboard
data class Parameters @JvmOverloads constructor(val email: String, val organizationId: String, val loginRedirectUrl: String? = null, val signupRedirectUrl: String? = null, val loginTemplateId: String? = null, val signupTemplateId: String? = null, val locale: Locale? = null)

Data class used for wrapping parameters used with requesting an email magic link

Functions

Link copied to clipboard
abstract suspend fun discoverySend(parameters: B2BMagicLinks.EmailMagicLinks.DiscoverySendParameters): BaseResponse
abstract fun discoverySend(parameters: B2BMagicLinks.EmailMagicLinks.DiscoverySendParameters, callback: (BaseResponse) -> Unit)

Send a discovery magic link to an email address

Link copied to clipboard
abstract fun discoverySendCompletable(parameters: B2BMagicLinks.EmailMagicLinks.DiscoverySendParameters): CompletableFuture<BaseResponse>

Send a discovery magic link to an email address

Link copied to clipboard
abstract suspend fun invite(parameters: B2BMagicLinks.EmailMagicLinks.InviteParameters): MemberResponse
abstract fun invite(parameters: B2BMagicLinks.EmailMagicLinks.InviteParameters, callback: (MemberResponse) -> Unit)

Send an invite email to a new Member to join an Organization. The Member will be created with an invited status until they successfully authenticate. Sending invites to pending Members will update their status to invited. Sending invites to already active Members will return an error.

Link copied to clipboard
abstract fun inviteCompletable(parameters: B2BMagicLinks.EmailMagicLinks.InviteParameters): CompletableFuture<MemberResponse>

Send an invite email to a new Member to join an Organization. The Member will be created with an invited status until they successfully authenticate. Sending invites to pending Members will update their status to invited. Sending invites to already active Members will return an error.

Link copied to clipboard
abstract suspend fun loginOrSignup(parameters: B2BMagicLinks.EmailMagicLinks.Parameters): BaseResponse
abstract fun loginOrSignup(parameters: B2BMagicLinks.EmailMagicLinks.Parameters, callback: (BaseResponse) -> Unit)

Send either a login or signup magic link to a Member. A new or pending Member will receive a signup Email Magic Link. An active Member will receive a login Email Magic Link.

Link copied to clipboard
abstract fun loginOrSignupCompletable(parameters: B2BMagicLinks.EmailMagicLinks.Parameters): CompletableFuture<BaseResponse>

Send either a login or signup magic link to a Member. A new or pending Member will receive a signup Email Magic Link. An active Member will receive a login Email Magic Link.