class Stytch::Passwords::Email

The type of this field is +Integer+.
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.
status_code::
The type of this field is +String+.
The unique ID of a specific email address.
email_id::
The type of this field is +String+.
The unique ID of the affected User.
user_id::
The type of this field is +String+.
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.
request_id::
An object with the following fields:
== Returns:

The type of this field is nilable +String+.
Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in customization options or custom HTML templates with type “Passwords - Password reset”.
Use a custom template for password reset emails. By default, it will use your default email template.
reset_password_template_id::
The type of this field is nilable +ResetStartRequestLocale+ (string enum).

Request support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link")!

Currently supported languages are English (`"en"`), Spanish (`"es"`), French (`"fr"`) and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.

Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.
locale::
The type of this field is nilable +String+.
After Users are redirected to the login redirect URL, your application should retrieve the `token` value from the URL parameters and call the [Magic Link Authenticate endpoint](https://stytch.com/docs/api/authenticate-magic-link) to log the User in without requiring a password reset. If this value is not provided, your project's default login redirect URL will be used. If you have not set a default login redirect URL, an error will be returned.

The URL that Users are redirected to upon clicking the "Log in without password" button in password reset emails.
login_redirect_url::
The type of this field is nilable +Attributes+ (+object+).
Provided attributes to help with fraud detection. These values are pulled and passed into Stytch endpoints by your application.
attributes::
The type of this field is nilable +String+.
A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device.
code_challenge::
The type of this field is nilable +Integer+.
The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
Set the expiration for the password reset, in minutes. By default, it expires in 30 minutes.
reset_password_expiration_minutes::
The type of this field is nilable +String+.
If this parameter is not specified, the default Reset Password redirect URL configured in the Dashboard will be used. If you have not set a default Reset Password redirect URL, an error is returned.
Before rendering the reset page, extract the `token` from the query parameters. On the reset page, collect the new password and complete the flow by calling the corresponding Password Reset by Email endpoint.
The URL that the User is redirected to from the reset password magic link. This URL should display your application's reset password page.
reset_password_redirect_url::
The type of this field is +String+.
The email of the User that requested the password reset.
email::
== Parameters:

Initiates a password reset for the email address provided. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.

def reset_start(
  email:,
  reset_password_redirect_url: nil,
  reset_password_expiration_minutes: nil,
  code_challenge: nil,
  attributes: nil,
  login_redirect_url: nil,
  locale: nil,
  reset_password_template_id: nil
)
  headers = {}
  request = {
    email: email
  }
  request[:reset_password_redirect_url] = reset_password_redirect_url unless reset_password_redirect_url.nil?
  request[:reset_password_expiration_minutes] = reset_password_expiration_minutes unless reset_password_expiration_minutes.nil?
  request[:code_challenge] = code_challenge unless code_challenge.nil?
  request[:attributes] = attributes unless attributes.nil?
  request[:login_redirect_url] = login_redirect_url unless login_redirect_url.nil?
  request[:locale] = locale unless locale.nil?
  request[:reset_password_template_id] = reset_password_template_id unless reset_password_template_id.nil?
  post_request('/v1/passwords/email/reset/start', request, headers)
end