stytch 9.10.0 → 9.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4023ae6cace52f9372e689380961ea0720c243425f8ed54b17f56dd24cb5395a
-  data.tar.gz: 0bd37c0c1b7d57c50ea7150aee027b88dbc59bab2ceafc4b43253b8d7db837d9
+  metadata.gz: 5c0d28f978709f9fd734d22ec07b9ead2cff5784bf2236e6f7a814ac6112bd4f
+  data.tar.gz: 99d3ef7c666a37a4bdb62717e4f95f10d5e62a5b4acdd30b53b1bc3b8bcc2fa3
 SHA512:
-  metadata.gz: 962257a3f4012c7ff59140a8d9adb0b0bdff54a3038b9cf5e9410ec24bfc3361daae2cf0100f21cf3c7b4c7f9bf4ac312082fda641a4f089a2931e75beea8677
-  data.tar.gz: d2f9fb55899bb104dcd12e34b1c662362490d2c2175607b61ed7a5505051b844df61aaea422bd7fbb5e4ca2aa43b3e436056ab8f4d0affa16016de81ec88a105
+  metadata.gz: 5a313477adea0a21456f16ab46658d2cd2a218414a4b36bea7078be9c35b7c703bbab26b3453906ec0e0f3cf718230c002c92335bf43174a82018dd4125a0173
+  data.tar.gz: 016de94dc4b6eefac4f061e03f6269088fb5e5936a2fcf43085f96ee278e0859a190a81e8ccee361da8925862509fc9d3f84e5ab46b03fc030a997ae428a8e39

data/lib/stytch/b2b_otp.rb

@@ -11,12 +11,13 @@ require_relative 'request_helper'
 module StytchB2B
   class OTPs
     include Stytch::RequestHelper
-    attr_reader :sms
+    attr_reader :sms, :email
 
     def initialize(connection)
       @connection = connection
 
       @sms = StytchB2B::OTPs::Sms.new(@connection)
+      @email = StytchB2B::OTPs::Email.new(@connection)
     end
 
     class Sms
@@ -237,5 +238,307 @@ module StytchB2B
         post_request('/v1/b2b/otps/sms/authenticate', request, headers)
       end
     end
+
+    class Email
+      include Stytch::RequestHelper
+      attr_reader :discovery
+
+      def initialize(connection)
+        @connection = connection
+
+        @discovery = StytchB2B::OTPs::Email::Discovery.new(@connection)
+      end
+
+      # Send either a login or signup email OTP to a Member. A new, pending, or invited Member will receive a signup email OTP. Non-active members will have a pending status until they successfully authenticate. An active Member will receive a login email OTP.
+      #
+      # The OTP is valid for 10 minutes. Only the most recently sent OTP is valid: when an OTP is sent, all OTPs previously sent to the same email address are invalidated, even if unused or unexpired.
+      #
+      # == Parameters:
+      # organization_id::
+      #   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.
+      #   The type of this field is +String+.
+      # email_address::
+      #   The email address of the Member.
+      #   The type of this field is +String+.
+      # login_template_id::
+      #   Use a custom template for login emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - Login.
+      #   The type of this field is nilable +String+.
+      # signup_template_id::
+      #   Use a custom template for signup emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - Signup.
+      #   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](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")!
+      #
+      #   The type of this field is nilable +LoginOrSignupRequestLocale+ (string enum).
+      #
+      # == 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+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member.
+      #   The type of this field is +String+.
+      # member_created::
+      #   A flag indicating `true` if a new Member object was created and `false` if the Member object already existed.
+      #   The type of this field is +Boolean+.
+      # member::
+      #   The [Member object](https://stytch.com/docs/b2b/api/member-object)
+      #   The type of this field is +Member+ (+object+).
+      # organization::
+      #   The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
+      #   The type of this field is +Organization+ (+object+).
+      # 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+.
+      def login_or_signup(
+        organization_id:,
+        email_address:,
+        login_template_id: nil,
+        signup_template_id: nil,
+        locale: nil
+      )
+        headers = {}
+        request = {
+          organization_id: organization_id,
+          email_address: email_address
+        }
+        request[:login_template_id] = login_template_id unless login_template_id.nil?
+        request[:signup_template_id] = signup_template_id unless signup_template_id.nil?
+        request[:locale] = locale unless locale.nil?
+
+        post_request('/v1/b2b/otps/email/login_or_signup', request, headers)
+      end
+
+      # Authenticate a with a one-time passcode (OTP). This endpoint requires an OTP that is not expired or previously used.
+      # OTPs have a default expiry of 10 minutes. If the Member’s status is `pending` or `invited`, they will be updated to `active`.
+      # 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.
+      #
+      # If the Member is required to complete MFA to log in to the, the returned value of `member_authenticated` will be `false`, and an `intermediate_session_token` will be returned.
+      # The `intermediate_session_token` can be passed into the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp),
+      # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA step and acquire a full member session.
+      # 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 `session_duration_minutes` and `session_custom_claims` parameters will be ignored.
+      #
+      # If a valid `session_token` or `session_jwt` is passed in, the Member will not be required to complete an MFA step.
+      #
+      # == Parameters:
+      # organization_id::
+      #   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.
+      #   The type of this field is +String+.
+      # email_address::
+      #   The email address of the Member.
+      #   The type of this field is +String+.
+      # code::
+      #   The code to authenticate.
+      #   The type of this field is +String+.
+      # session_token::
+      #   A secret token for a given Stytch Session.
+      #   The type of this field is nilable +String+.
+      # session_jwt::
+      #   The JSON Web Token (JWT) for a given Stytch Session.
+      #   The type of this field is nilable +String+.
+      # intermediate_session_token::
+      #   The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
+      #   The type of this field is nilable +String+.
+      # session_duration_minutes::
+      #   Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,
+      #   returning both an opaque `session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of
+      #   five minutes regardless of the underlying session duration, and will need to be refreshed over time.
+      #
+      #   This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).
+      #
+      #   If a `session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.
+      #
+      #   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
+      #   to use the Stytch session product, you can ignore the session fields in the response.
+      #   The type of this field is nilable +Integer+.
+      # session_custom_claims::
+      #   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. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored.
+      #   Total custom claims size cannot exceed four kilobytes.
+      #   The type of this field is nilable +object+.
+      # locale::
+      #   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")!
+      #
+      #   The type of this field is nilable +AuthenticateRequestLocale+ (string enum).
+      #
+      # == 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+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member.
+      #   The type of this field is +String+.
+      # method_id::
+      #   The email or device involved in the authentication.
+      #   The type of this field is +String+.
+      # organization_id::
+      #   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.
+      #   The type of this field is +String+.
+      # member::
+      #   The [Member object](https://stytch.com/docs/b2b/api/member-object)
+      #   The type of this field is +Member+ (+object+).
+      # session_token::
+      #   A secret token for a given Stytch Session.
+      #   The type of this field is +String+.
+      # session_jwt::
+      #   The JSON Web Token (JWT) for a given Stytch Session.
+      #   The type of this field is +String+.
+      # member_session::
+      #   The [Session object](https://stytch.com/docs/b2b/api/session-object).
+      #   The type of this field is +MemberSession+ (+object+).
+      # organization::
+      #   The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
+      #   The type of this field is +Organization+ (+object+).
+      # intermediate_session_token::
+      #   The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
+      #   The type of this field is +String+.
+      # member_authenticated::
+      #   Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
+      #   The type of this field is +Boolean+.
+      # 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+.
+      # mfa_required::
+      #   Information about the MFA requirements of the Organization and the Member's options for fulfilling MFA.
+      #   The type of this field is nilable +MfaRequired+ (+object+).
+      def authenticate(
+        organization_id:,
+        email_address:,
+        code:,
+        session_token: nil,
+        session_jwt: nil,
+        intermediate_session_token: nil,
+        session_duration_minutes: nil,
+        session_custom_claims: nil,
+        locale: nil
+      )
+        headers = {}
+        request = {
+          organization_id: organization_id,
+          email_address: email_address,
+          code: code
+        }
+        request[:session_token] = session_token unless session_token.nil?
+        request[:session_jwt] = session_jwt unless session_jwt.nil?
+        request[:intermediate_session_token] = intermediate_session_token unless intermediate_session_token.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/otps/email/authenticate', request, headers)
+      end
+
+      class Discovery
+        include Stytch::RequestHelper
+
+        def initialize(connection)
+          @connection = connection
+        end
+
+        # Send a discovery OTP to an email address. The OTP is valid for 10 minutes. Only the most recently sent OTP is valid: when an OTP is sent, all OTPs previously sent to the same email address are invalidated, even if unused or unexpired.
+        #
+        # == Parameters:
+        # email_address::
+        #   The email address to start the discovery flow for.
+        #   The type of this field is +String+.
+        # login_template_id::
+        #   Use a custom template for login emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for OTP - 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](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")!
+        #
+        #   The type of this field is nilable +SendRequestLocale+ (string enum).
+        #
+        # == 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+.
+        def send(
+          email_address:,
+          login_template_id: nil,
+          locale: nil
+        )
+          headers = {}
+          request = {
+            email_address: email_address
+          }
+          request[:login_template_id] = login_template_id unless login_template_id.nil?
+          request[:locale] = locale unless locale.nil?
+
+          post_request('/v1/b2b/otps/email/discovery/send', request, headers)
+        end
+
+        # Authenticates the OTP and returns an intermediate session token. Intermediate session tokens can be used for various Discovery login flows and are valid for 10 minutes.
+        #
+        # == Parameters:
+        # email_address::
+        #   The email address of the Member.
+        #   The type of this field is +String+.
+        # code::
+        #   The code to authenticate.
+        #   The type of this field is +String+.
+        #
+        # == 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+.
+        # intermediate_session_token::
+        #   The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
+        #   The type of this field is +String+.
+        # email_address::
+        #   The email address.
+        #   The type of this field is +String+.
+        # discovered_organizations::
+        #   An array of `discovered_organization` objects tied to the `intermediate_session_token`, `session_token`, or `session_jwt`. See the [Discovered Organization Object](https://stytch.com/docs/b2b/api/discovered-organization-object) for complete details.
+        #
+        #   Note that Organizations will only appear here under any of the following conditions:
+        #   1. The end user is already a Member of the Organization.
+        #   2. The end user is invited to the Organization.
+        #   3. The end user can join the Organization because:
+        #
+        #       a) The Organization allows JIT provisioning.
+        #
+        #       b) The Organizations' allowed domains list contains the Member's email domain.
+        #
+        #       c) The Organization has at least one other Member with a verified email address with the same domain as the end user (to prevent phishing attacks).
+        #   The type of this field is list of +DiscoveredOrganization+ (+object+).
+        # 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+.
+        def authenticate(
+          email_address:,
+          code:
+        )
+          headers = {}
+          request = {
+            email_address: email_address,
+            code: code
+          }
+
+          post_request('/v1/b2b/otps/email/discovery/authenticate', request, headers)
+        end
+      end
+    end
   end
 end

data/lib/stytch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stytch
-  VERSION = '9.10.0'
+  VERSION = '9.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 9.10.0
+  version: 9.11.0
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday