class Stytch::Passwords::Email

def initialize(connection)
  @connection = connection
end

The type of this field is nilable +DeviceInfo+ (+object+).
If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `user_device` response field will contain information about the user's device attributes.
user_device::
The type of this field is nilable +Session+ (+object+).

See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.

If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response.
session::
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 +User+ (+object+).
The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
user::
The type of this field is +String+.
The JSON Web Token (JWT) for a given Stytch Session.
session_jwt::
The type of this field is +String+.
A secret token for a given Stytch Session.
session_token::
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+.
If the `telemetry_id` is passed, as part of this request, Stytch will call the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints and IPGEO information for the User. Your workspace must be enabled for Device Fingerprinting to use this feature.
telemetry_id::
The type of this field is nilable +Options+ (+object+).
Specify optional security settings.
options::
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 +object+.
Custom claims made with reserved claims ("iss", "sub", "aud", "exp", "nbf", "iat", "jti") will be ignored. Total custom claims size cannot exceed four kilobytes.

Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in `session_duration_minutes`. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To delete a key, supply a null value.
session_custom_claims::
The type of this field is nilable +String+.
A base64url encoded one time secret used to validate that the request starts and ends on the same device.
code_verifier::
The type of this field is nilable +String+.
The `session_jwt` associated with a User's existing Session.
session_jwt::
The type of this field is nilable +Integer+.
If the `session_duration_minutes` parameter is not specified, a Stytch session will not be created.

If a `session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.

This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).

five minutes regardless of the underlying session duration, and will need to be refreshed over time.
returning both an opaque `session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of
Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,
session_duration_minutes::
The type of this field is nilable +String+.
The `session_token` associated with a User's existing Session.
session_token::
The type of this field is +String+.
The password for the user. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characters, etc.
password::
The type of this field is +String+.
See examples and read more about redirect URLs [here](https://stytch.com/docs/workspace-management/redirect-urls).

In the redirect URL, the `stytch_token_type` will be `login` or `reset_password`.

The Passwords `token` from the `?token=` query parameter in the URL.
token::
== Parameters:

Note that a successful password reset by email will revoke all active sessions for the `user_id`.

The provided password needs to meet our password strength requirements, which can be checked in advance with the password strength endpoint. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.

Reset the user's password and authenticate them. This endpoint checks that the magic link `token` is valid, hasn't expired, or already been used – and can optionally require additional security settings, such as the IP address and user agent matching the initial reset request.

def reset(
  token:,
  password:,
  session_token: nil,
  session_duration_minutes: nil,
  session_jwt: nil,
  code_verifier: nil,
  session_custom_claims: nil,
  attributes: nil,
  options: nil,
  telemetry_id: nil
)
  headers = {}
  request = {
    token: token,
    password: password
  }
  request[:session_token] = session_token unless session_token.nil?
  request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
  request[:session_jwt] = session_jwt unless session_jwt.nil?
  request[:code_verifier] = code_verifier unless code_verifier.nil?
  request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
  request[:attributes] = attributes unless attributes.nil?
  request[:options] = options unless options.nil?
  request[:telemetry_id] = telemetry_id unless telemetry_id.nil?
  post_request('/v1/passwords/email/reset', request, headers)
end

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