stytch 9.2.0 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 054cdb1171eff8373e48ab9d77b74170bfaaabd4d77cb2c31657925aca44f632
-  data.tar.gz: 1a0ed91c5bf5ea60160e77402f8724517bbcf9aa10743a38efe83ac0c9b76785
+  metadata.gz: 680830d0bdb86bd92d7341d2ed07519a4a185ccaa64b7caa10d342839de88292
+  data.tar.gz: 2e05ae2dfb502777236daddfe88de208f8c27232144f46a7fcbc57514382a6bc
 SHA512:
-  metadata.gz: 3433370d4868be620088af753c48c378e3d571458240698764813b8e581f935bd1975d8fca86416ffccb3644292f0d1cfa29343b65431462a186573b2eeaa51e
-  data.tar.gz: 5d139670d4e0a04ac7c6d500aa96e18c8b1c42cea8d144187b1396af840d4a103e343f2f95f8445b0f6964767933b057bd82c48e5ac1b98973289c4863ae6d63
+  metadata.gz: '0466802a5065694b7fe51d184d81f70fa869785b6578d389913781cb9d520e6195644a3911b82535cf5cff5c7c41a33ec5e85b099ce36f78e34759406c3368e7'
+  data.tar.gz: 5c26c228ebb6969c0ca476362b611d54ac9cfc7b0e8601640f54e5927c8900dec26c9720cfca9d2b22b8c21e4b748f84816ec17230b3b600f8343f025e1e2613

data/lib/stytch/b2b_organizations.rb

@@ -631,6 +631,25 @@ module StytchB2B
         end
       end
 
+      class UnlinkRetiredEmailRequestOptions
+        # Optional authorization object.
+        # Pass in an active Stytch Member session token or session JWT and the request
+        # will be run using that member's permissions.
+        attr_accessor :authorization
+
+        def initialize(
+          authorization: nil
+        )
+          @authorization = authorization
+        end
+
+        def to_headers
+          headers = {}
+          headers.merge!(@authorization.to_headers) if authorization
+          headers
+        end
+      end
+
       class CreateRequestOptions
         # Optional authorization object.
         # Pass in an active Stytch Member session token or session JWT and the request
@@ -1078,6 +1097,74 @@ module StytchB2B
         get_request(request, headers)
       end
 
+      # Unlinks a retired email address from a Member specified by their `organization_id` and `member_id`. The email address
+      # to be retired can be identified in the request body by either its `email_id`, its `email_address`, or both. If using
+      # both identifiers they must refer to the same email.
+      #
+      # A previously active email address can be marked as retired in one of two ways:
+      #
+      # - It's replaced with a new primary email address during an explicit Member update.
+      # - A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the
+      #   Member's primary email address and the old primary email address is retired.
+      #
+      # A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email
+      # addresses allows them to be subsequently re-used by other Organization Members. Retired email addresses can be viewed
+      # on the [Member object](https://stytch.com/docs/b2b/api/member-object).
+      #  %}
+      #
+      # == 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+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value.
+      #   The type of this field is +String+.
+      # email_id::
+      #   The globally unique UUID of a Member's email.
+      #   The type of this field is nilable +String+.
+      # email_address::
+      #   The email address of the Member.
+      #   The type of this field is nilable +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+.
+      # member_id::
+      #   Globally unique UUID that identifies a specific Member.
+      #   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+).
+      # 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+.
+      #
+      # == Method Options:
+      # This method supports an optional +StytchB2B::Organizations::Members::UnlinkRetiredEmailRequestOptions+ object which will modify the headers sent in the HTTP request.
+      def unlink_retired_email(
+        organization_id:,
+        member_id:,
+        email_id: nil,
+        email_address: nil,
+        method_options: nil
+      )
+        headers = {}
+        headers = headers.merge(method_options.to_headers) unless method_options.nil?
+        request = {}
+        request[:email_id] = email_id unless email_id.nil?
+        request[:email_address] = email_address unless email_address.nil?
+
+        post_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/unlink_retired_email", request, headers)
+      end
+
       # Creates a Member. An `organization_id` and `email_address` are required.
       #
       # == Parameters:

data/lib/stytch/b2b_scim.rb

@@ -194,7 +194,7 @@ module StytchB2B
       #   (no documentation yet)
       #   The type of this field is nilable +UpdateRequestIdentityProvider+ (string enum).
       # scim_group_implicit_role_assignments::
-      #   (no documentation yet)
+      #   An array of SCIM group implicit role assignments. Each object in the array must contain a `group` and a `role_id`.
       #   The type of this field is nilable list of +SCIMGroupImplicitRoleAssignments+.
       #
       # == Returns:

data/lib/stytch/crypto_wallets.rb

@@ -16,7 +16,12 @@ module Stytch
       @connection = connection
     end
 
-    # Initiate the authentication of a crypto wallet. After calling this endpoint, the user will need to sign a message containing only the returned `challenge` field.
+    # Initiate the authentication of a crypto wallet. After calling this endpoint, the user will need to sign a message containing the returned `challenge` field.
+    #
+    # For Ethereum crypto wallets, you can optionally use the Sign In With Ethereum (SIWE) protocol for the message by passing in the `siwe_params`. The only required fields are `domain` and `uri`.
+    # If the crypto wallet detects that the domain in the message does not match the website's domain, it will display a warning to the user.
+    #
+    # If not using the SIWE protocol, the message will simply consist of the project name and a random string.
     #
     # == Parameters:
     # crypto_wallet_type::
@@ -34,6 +39,9 @@ module Stytch
     # session_jwt::
     #   The `session_jwt` associated with a User's existing Session.
     #   The type of this field is nilable +String+.
+    # siwe_params::
+    #   The parameters for a Sign In With Ethereum (SIWE) message. May only be passed if the `crypto_wallet_type` is `ethereum`.
+    #   The type of this field is nilable +SIWEParams+ (+object+).
     #
     # == Returns:
     # An object with the following fields:
@@ -57,7 +65,8 @@ module Stytch
       crypto_wallet_address:,
       user_id: nil,
       session_token: nil,
-      session_jwt: nil
+      session_jwt: nil,
+      siwe_params: nil
     )
       headers = {}
       request = {
@@ -67,6 +76,7 @@ module Stytch
       request[:user_id] = user_id unless user_id.nil?
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
+      request[:siwe_params] = siwe_params unless siwe_params.nil?
 
       post_request('/v1/crypto_wallets/authenticate/start', request, headers)
     end
@@ -132,6 +142,9 @@ module Stytch
     #   See [GET sessions](https://stytch.com/docs/api/session-get) for complete response fields.
     #
     #   The type of this field is nilable +Session+ (+object+).
+    # siwe_params::
+    #   The parameters of the Sign In With Ethereum (SIWE) message that was signed.
+    #   The type of this field is nilable +SIWEParamsResponse+ (+object+).
     def authenticate(
       crypto_wallet_type:,
       crypto_wallet_address:,

data/lib/stytch/sessions.rb

@@ -156,6 +156,70 @@ module Stytch
       post_request('/v1/sessions/revoke', request, headers)
     end
 
+    # Migrate a session from an external OIDC compliant endpoint. Stytch will call the external UserInfo endpoint defined in your Stytch Project settings in the [Dashboard](/dashboard), and then perform a lookup using the `session_token`. If the response contains a valid email address, Stytch will attempt to match that email address with an existing User and create a Stytch Session. You will need to create the user before using this endpoint.
+    #
+    # == Parameters:
+    # session_token::
+    #   The `session_token` associated with a User's existing Session.
+    #   The type of this field is +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 not be created.
+    #   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+.
+    #
+    # == 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+.
+    # user_id::
+    #   The unique ID of the affected User.
+    #   The type of this field is +String+.
+    # 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+.
+    # user::
+    #   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.
+    #   The type of this field is +User+ (+object+).
+    # status_code::
+    #   (no documentation yet)
+    #   The type of this field is +Integer+.
+    # session::
+    #   If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response.
+    #
+    #   See [GET sessions](https://stytch.com/docs/api/session-get) for complete response fields.
+    #
+    #   The type of this field is nilable +Session+ (+object+).
+    def migrate(
+      session_token:,
+      session_duration_minutes: nil,
+      session_custom_claims: nil
+    )
+      headers = {}
+      request = {
+        session_token: session_token
+      }
+      request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
+
+      post_request('/v1/sessions/migrate', request, headers)
+    end
+
     # Get the JSON Web Key Set (JWKS) for a project.
     #
     # JWKS are rotated every ~6 months. Upon rotation, new JWTs will be signed using the new key set, and both key sets will be returned by this endpoint for a period of 1 month.

data/lib/stytch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.4.0
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday