Class: StytchB2B::MagicLinks::Email::Discovery

Inherits:

Object

• Object
• StytchB2B::MagicLinks::Email::Discovery

Includes:

Stytch::RequestHelper

Defined in:

lib/stytch/b2b_magic_links.rb

Instance Method Summary

• #initialize(connection) ⇒ Discovery constructor

  A new instance of Discovery.

• #send(email_address:, discovery_redirect_url: nil, pkce_code_challenge: nil, login_template_id: nil, locale: nil, discovery_expiration_minutes: nil) ⇒ Object

  Send a discovery magic link to an email address.

Methods included from Stytch::RequestHelper

#delete_request, #get_request, #post_request, #put_request, #request_with_query_params

Constructor Details

#initialize(connection) ⇒ Discovery

Returns a new instance of Discovery.

# File 'lib/stytch/b2b_magic_links.rb', line 398

def initialize(connection)
  @connection = connection
end

Instance Method Details

#send(email_address:, discovery_redirect_url: nil, pkce_code_challenge: nil, login_template_id: nil, locale: nil, discovery_expiration_minutes: nil) ⇒ Object

Send a discovery magic link to an email address. The magic link is valid for 60 minutes.

Parameters:

email_address

The email address of the Member. The type of this field is String.

discovery_redirect_url

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. The type of this field is nilable String.

pkce_code_challenge

A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device. The type of this field is nilable String.

login_template_id

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.

The type of this field is nilable +String+.

locale

Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](www.w3.org/International/articles/language-tags/), e.g. ‘“en”`.

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.

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

The type of this field is nilable +SendRequestLocale+ (string enum).

discovery_expiration_minutes

The expiration time, in minutes, for an discovery magic link email. If not accepted within this time frame, the email will need to be resent. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 10080 (1 week). The type of this field is nilable Integer.

Returns:

An object with the following fields:

request_id

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. The type of this field is String.

status_code

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. The type of this field is Integer.

# File 'lib/stytch/b2b_magic_links.rb', line 440

def send(
  email_address:,
  discovery_redirect_url: nil,
  pkce_code_challenge: nil,
  login_template_id: nil,
  locale: nil,
  discovery_expiration_minutes: nil
)
  headers = {}
  request = {
    email_address: email_address
  }
  request[:discovery_redirect_url] = discovery_redirect_url unless discovery_redirect_url.nil?
  request[:pkce_code_challenge] = pkce_code_challenge unless pkce_code_challenge.nil?
  request[:login_template_id] = login_template_id unless login_template_id.nil?
  request[:locale] = locale unless locale.nil?
  request[:discovery_expiration_minutes] = discovery_expiration_minutes unless discovery_expiration_minutes.nil?

  post_request('/v1/b2b/magic_links/email/discovery/send', request, headers)
end