class StytchB2B::MagicLinks

The type of this field is nilable +MfaRequired+ (+object+).
Information about the MFA requirements of the Organization and the Member's options for fulfilling MFA.
mfa_required::
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 +Boolean+.
Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
member_authenticated::
The type of this field is +String+.
or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization that allows login with Email Magic Links,
The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms) to complete the MFA flow and log in to the Organization.
The returned Intermediate Session Token contains an Email Magic Link factor associated with the Member's email address.
intermediate_session_token::
The type of this field is +Organization+ (+object+).
The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
organization::
The type of this field is +MemberSession+ (+object+).
The [Session object](https://stytch.com/docs/b2b/api/session-object).
member_session::
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 +Member+ (+object+).
The [Member object](https://stytch.com/docs/b2b/api/member-object)
member::
The type of this field is +String+.
Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value.
organization_id::
The type of this field is +Boolean+.
Stytch's Session product. If you are using Stytch's Session product, we revoke the Member’s other Sessions for you.
Indicates if all Sessions linked to the Member need to be reset. You should check this field if you aren't using
reset_sessions::
The type of this field is +String+.
The email or device involved in the authentication.
method_id::
The type of this field is +String+.
Globally unique UUID that identifies a specific Member.
member_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 +AuthenticateRequestLocale+ (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"`), and Brazilian Portuguese (`"pt-br"`); if no value is provided, the copy defaults to English.

Parameter is a [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`.

If the Member needs to complete an MFA step, and the Member has a phone number, this endpoint will pre-emptively send a one-time passcode (OTP) to the Member's phone number. The locale argument will be used to determine which language to use when sending the passcode.
locale::
The type of this field is nilable +object+.
Total custom claims size cannot exceed four kilobytes.
delete a key, supply a null value. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored.
`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
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_custom_claims::
The type of this field is nilable +Integer+.
to use the Stytch session product, you can ignore the session fields in the response.
If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration. If you don't want

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+.
are provided.
and `magic_links_token` belong to different Members, the `session_jwt` will be ignored. This endpoint will error if both `session_token` and `session_jwt`
Reuse an existing session instead of creating a new one. If you provide a `session_jwt`, Stytch will update the session. If the `session_jwt`
session_jwt::
The type of this field is nilable +String+.
both `session_token` and `session_jwt` are provided.
If the `session_token` and `magic_links_token` belong to different Members, the `session_token` will be ignored. This endpoint will error if
Reuse an existing session instead of creating a new one. If you provide a `session_token`, Stytch will update the session.
session_token::
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.
pkce_code_verifier::
The type of this field is +String+.
The Email Magic Link token to authenticate.
magic_links_token::
== Parameters:

If a valid `session_token` or `session_jwt` is passed in, the Member will not be required to complete an MFA step.

The `session_duration_minutes` and `session_custom_claims` parameters will be ignored.
The `intermediate_session_token` can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to join a different Organization or create a new one.
The `intermediate_session_token` can be passed into the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms) to complete the MFA step and acquire a full member session.
If the Member is required to complete MFA to log in to the Organization, the returned value of `member_authenticated` will be `false`, and an `intermediate_session_token` will be returned.

Provide the `session_duration_minutes` parameter to set the lifetime of the session. If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration.
Authenticate a Member with a Magic Link. This endpoint requires a Magic Link token that is not expired or previously used. If the Member’s status is `pending` or `invited`, they will be updated to `active`.

def authenticate(
  magic_links_token:,
  pkce_code_verifier: nil,
  session_token: nil,
  session_jwt: nil,
  session_duration_minutes: nil,
  session_custom_claims: nil,
  locale: nil
)
  headers = {}
  request = {
    magic_links_token: magic_links_token
  }
  request[:pkce_code_verifier] = pkce_code_verifier unless pkce_code_verifier.nil?
  request[:session_token] = session_token unless session_token.nil?
  request[:session_jwt] = session_jwt unless session_jwt.nil?
  request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
  request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
  request[:locale] = locale unless locale.nil?
  post_request('/v1/b2b/magic_links/authenticate', request, headers)
end

def initialize(connection)
  @connection = connection
  @email = StytchB2B::MagicLinks::Email.new(@connection)
  @discovery = StytchB2B::MagicLinks::Discovery.new(@connection)
end