main.com.stytch.java.b2b.models.magiclinksemaildiscovery.MagicLinksEmailDiscovery.kt Maven / Gradle / Ivy
package com.stytch.java.b2b.models.magiclinksemaildiscovery
// !!!
// WARNING: This file is autogenerated
// Only modify code within MANUAL() sections
// or your changes may be overwritten later!
// !!!
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
@JsonClass(generateAdapter = false)
public enum class SendRequestLocale {
@Json(name = "en")
EN,
@Json(name = "es")
ES,
@Json(name = "ptbr")
PTBR,
}
/**
* Request type for `Discovery.send`.
*/
@JsonClass(generateAdapter = true)
public data class SendRequest
@JvmOverloads
constructor(
/**
* The email address of the Member.
*/
@Json(name = "email_address")
val emailAddress: String,
/**
* The URL that the end user clicks from the discovery Magic Link. This URL should be an endpoint in the backend server
* that
* verifies the request by querying Stytch's discovery authenticate endpoint and continues the flow. If this value is
* not passed, the default
* discovery redirect URL that you set in your Dashboard is used. If you have not set a default discovery redirect URL,
* an error is returned.
*/
@Json(name = "discovery_redirect_url")
val discoveryRedirectURL: String? = null,
/**
* A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same
* device.
*/
@Json(name = "pkce_code_challenge")
val pkceCodeChallenge: String? = null,
/**
* Use a custom template for discovery emails. By default, it will use your default email template. The template must be
* from Stytch's
* built-in customizations or a custom HTML email for Magic Links - Login.
*/
@Json(name = "login_template_id")
val loginTemplateId: String? = null,
/**
* Used to determine which language to use when sending the user this delivery method. Parameter is a
* [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
*
* Currently supported languages are English (`"en"`), Spanish (`"es"`), and Brazilian Portuguese (`"pt-br"`); if no value
* is provided, the copy defaults to English.
*
* Request support for additional languages
* [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!
*
*/
@Json(name = "locale")
val locale: SendRequestLocale? = null,
)
/**
* Response type for `Discovery.send`.
*/
@JsonClass(generateAdapter = true)
public data class SendResponse
@JvmOverloads
constructor(
/**
* Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we
* may ask for this value to help identify a specific API call when helping you debug an issue.
*/
@Json(name = "request_id")
val requestId: String,
/**
* The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values
* equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
*/
@Json(name = "status_code")
val statusCode: Int,
)