stytch 10.11.1 → 10.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8813da25b767802037b6606d40b3162d7f9662056b568ae7045085351f79c7c
-  data.tar.gz: 7f06f0905ac8a3fb31ed38f418a082dcea9ff83272bf9bdb51583ecfb2b611c6
+  metadata.gz: 6f42067344609f05614a791857f6483761c11ac60e7d97a2b7e26b9710f3c85b
+  data.tar.gz: 8a2a1627bc56f8a7c64923ac96684e09fb18e44d2c054165db45ff386ef33fda
 SHA512:
-  metadata.gz: 49c847a6c8de5d9d2daf9aa9cbed4a3883a334243518938272fe80cc437f97e7996b75f374edffd0b494070ebfacbe9ee5414c75941648cee818cbd825d165a1
-  data.tar.gz: 96f1d4f126272781a76e7172f48b9884332ade3f99d718111a9b85043be5756261d4338687b610d74f673a2d698505d83049347cceb7df99dbd5c70dbc91a820
+  metadata.gz: 664e0ed90b2ba4d7dbfde9ca507d1c2c0897525065a464423088a801d9918d330783334d8e24ca2f5e097e5b562e6d929c0020e67de808163fe3bf504a33a9ff
+  data.tar.gz: 242470dc150145878d90fdf3bd660d8d4c1b8bd732c7a64c1a5130a67a13d67f848567bb0803d091a04c6dceca04431e26a182e8f45dcf4c8ea852663a65ef64

data/lib/stytch/b2b_oauth.rb

@@ -222,6 +222,9 @@ module StytchB2B
       # provider_tenant_ids::
       #   All tenant IDs returned by the OAuth provider. These is typically used to identify organizations or groups within the provider's domain. For example, in HubSpot this is a Hub ID, in Slack this is the Workspace ID, and in GitHub this is an organization ID. Some OAuth providers do not return tenant IDs, some providers are guaranteed to return one, and some may return multiple. This field will always be populated if at least one tenant ID was returned from the OAuth provider and developers should prefer this field over `provider_tenant_id`.
       #   The type of this field is list of +String+.
+      # full_name::
+      #   The full name of the authenticated end user, if available.
+      #   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+.

data/lib/stytch/b2b_organizations.rb

@@ -792,6 +792,9 @@ module StytchB2B
       #
       # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.email` action on the `stytch.member` Resource. Members cannot update their own email address.
       #   The type of this field is nilable +String+.
+      # external_id::
+      #   An identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+      #   The type of this field is nilable +String+.
       #
       # == Returns:
       # An object with the following fields:
@@ -826,6 +829,7 @@ module StytchB2B
         preserve_existing_sessions: nil,
         default_mfa_method: nil,
         email_address: nil,
+        external_id: nil,
         method_options: nil
       )
         headers = {}
@@ -841,6 +845,7 @@ module StytchB2B
         request[:preserve_existing_sessions] = preserve_existing_sessions unless preserve_existing_sessions.nil?
         request[:default_mfa_method] = default_mfa_method unless default_mfa_method.nil?
         request[:email_address] = email_address unless email_address.nil?
+        request[:external_id] = external_id unless external_id.nil?
 
         put_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}", request, headers)
       end
@@ -1290,6 +1295,9 @@ module StytchB2B
       #   Roles to explicitly assign to this Member. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)
       #    for more information about role assignment.
       #   The type of this field is nilable list of +String+.
+      # external_id::
+      #   An identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+      #   The type of this field is nilable +String+.
       #
       # == Returns:
       # An object with the following fields:
@@ -1322,6 +1330,7 @@ module StytchB2B
         mfa_phone_number: nil,
         mfa_enrolled: nil,
         roles: nil,
+        external_id: nil,
         method_options: nil
       )
         headers = {}
@@ -1337,6 +1346,7 @@ module StytchB2B
         request[:mfa_phone_number] = mfa_phone_number unless mfa_phone_number.nil?
         request[:mfa_enrolled] = mfa_enrolled unless mfa_enrolled.nil?
         request[:roles] = roles unless roles.nil?
+        request[:external_id] = external_id unless external_id.nil?
 
         post_request("/v1/b2b/organizations/#{organization_id}/members", request, headers)
       end

data/lib/stytch/b2b_passwords.rb

@@ -152,6 +152,9 @@ module StytchB2B
     # set_phone_number_verified::
     #   (no documentation yet)
     #   The type of this field is nilable +Boolean+.
+    # external_id::
+    #   If a new member is created, this will set an identifier that can be used in API calls wherever a member_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project. Note that if a member already exists, this field will be ignored.
+    #   The type of this field is nilable +String+.
     #
     # == Returns:
     # An object with the following fields:
@@ -189,7 +192,8 @@ module StytchB2B
       roles: nil,
       preserve_existing_sessions: nil,
       mfa_phone_number: nil,
-      set_phone_number_verified: nil
+      set_phone_number_verified: nil,
+      external_id: nil
     )
       headers = {}
       request = {
@@ -210,6 +214,7 @@ module StytchB2B
       request[:preserve_existing_sessions] = preserve_existing_sessions unless preserve_existing_sessions.nil?
       request[:mfa_phone_number] = mfa_phone_number unless mfa_phone_number.nil?
       request[:set_phone_number_verified] = set_phone_number_verified unless set_phone_number_verified.nil?
+      request[:external_id] = external_id unless external_id.nil?
 
       post_request('/v1/b2b/passwords/migrate', request, headers)
     end
@@ -404,10 +409,11 @@ module StytchB2B
       #
       #   The type of this field is nilable +ResetStartRequestLocale+ (string enum).
       # reset_password_template_id::
-      #   Use a custom template for reset password 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 Magic Links - Reset Password.
+      #   Use a custom template for reset password 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 Passwords - Reset Password.
       #   The type of this field is nilable +String+.
       # verify_email_template_id::
-      #   (no documentation yet)
+      #   Use a custom template for verification emails sent during password reset flows. This template will be used the first time a user sets a password via a
+      #   password reset flow. 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 Passwords - Email Verification.
       #   The type of this field is nilable +String+.
       #
       # == Returns:
@@ -973,7 +979,7 @@ module StytchB2B
         #   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+.
         # reset_password_template_id::
-        #   Use a custom template for reset password 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 Magic Links - Reset Password.
+        #   Use a custom template for reset password 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 Passwords - Reset Password.
         #   The type of this field is nilable +String+.
         # reset_password_expiration_minutes::
         #   Sets a time limit after which the email link to reset the member's password will no longer be valid.
@@ -990,7 +996,8 @@ module StytchB2B
         #
         #   The type of this field is nilable +String+.
         # verify_email_template_id::
-        #   (no documentation yet)
+        #   Use a custom template for verification emails sent during password reset flows. This template will be used the first time a user sets a password via a
+        #   password reset flow. 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 Passwords - Email Verification.
         #   The type of this field is nilable +String+.
         #
         # == Returns:

data/lib/stytch/fraud.rb

@@ -148,7 +148,7 @@ module Stytch
       #   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+.
       # action::
-      #   The action that will be returned for the specified fingerprint or ID.
+      #   The action that will be returned for the specified identifier.
       #   The type of this field is +RuleAction+ (string enum).
       # 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.

data/lib/stytch/passwords.rb

@@ -307,6 +307,9 @@ module Stytch
     #   Whether to set the user's phone number as verified. This is a dangerous field. This flag should only be set if you can attest that
     #    the user owns the phone number in question. Access to this field is restricted. To enable it, please send us a note at support@stytch.com.
     #   The type of this field is nilable +Boolean+.
+    # external_id::
+    #   If a new user is created, this will set an identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project. Note that if a user already exists, this field will be ignored.
+    #   The type of this field is nilable +String+.
     #
     # == Returns:
     # An object with the following fields:
@@ -342,7 +345,8 @@ module Stytch
       set_email_verified: nil,
       name: nil,
       phone_number: nil,
-      set_phone_number_verified: nil
+      set_phone_number_verified: nil,
+      external_id: nil
     )
       headers = {}
       request = {
@@ -361,6 +365,7 @@ module Stytch
       request[:name] = name unless name.nil?
       request[:phone_number] = phone_number unless phone_number.nil?
       request[:set_phone_number_verified] = set_phone_number_verified unless set_phone_number_verified.nil?
+      request[:external_id] = external_id unless external_id.nil?
 
       post_request('/v1/passwords/migrate', request, headers)
     end

data/lib/stytch/users.rb

@@ -44,6 +44,9 @@ module Stytch
     # untrusted_metadata::
     #   The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
     #   The type of this field is nilable +object+.
+    # external_id::
+    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+    #   The type of this field is nilable +String+.
     #
     # == Returns:
     # An object with the following fields:
@@ -75,7 +78,8 @@ module Stytch
       phone_number: nil,
       create_user_as_pending: nil,
       trusted_metadata: nil,
-      untrusted_metadata: nil
+      untrusted_metadata: nil,
+      external_id: nil
     )
       headers = {}
       request = {}
@@ -86,6 +90,7 @@ module Stytch
       request[:create_user_as_pending] = create_user_as_pending unless create_user_as_pending.nil?
       request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
+      request[:external_id] = external_id unless external_id.nil?
 
       post_request('/v1/users', request, headers)
     end
@@ -147,6 +152,9 @@ module Stytch
     # untrusted_metadata::
     #   The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
     #   The type of this field is nilable +object+.
+    # external_id::
+    #   (no documentation yet)
+    #   The type of this field is nilable +String+.
     def get(
       user_id:
     )
@@ -225,6 +233,9 @@ module Stytch
     # untrusted_metadata::
     #   The `untrusted_metadata` field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and **cannot be used to store critical information.** See the [Metadata](https://stytch.com/docs/api/metadata) reference for complete field behavior details.
     #   The type of this field is nilable +object+.
+    # external_id::
+    #   An identifier that can be used in API calls wherever a user_id is expected. This is a string consisting of alphanumeric, `.`, `_`, or `-` characters with a maximum length of 128 characters. External IDs must be unique within an organization, but may be reused across different organizations in the same project.
+    #   The type of this field is nilable +String+.
     #
     # == Returns:
     # An object with the following fields:
@@ -254,7 +265,8 @@ module Stytch
       name: nil,
       attributes: nil,
       trusted_metadata: nil,
-      untrusted_metadata: nil
+      untrusted_metadata: nil,
+      external_id: nil
     )
       headers = {}
       request = {}
@@ -262,6 +274,7 @@ module Stytch
       request[:attributes] = attributes unless attributes.nil?
       request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
       request[:untrusted_metadata] = untrusted_metadata unless untrusted_metadata.nil?
+      request[:external_id] = external_id unless external_id.nil?
 
       put_request("/v1/users/#{user_id}", request, headers)
     end

data/lib/stytch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 10.11.1
+  version: 10.13.0
 platform: ruby
 authors:
 - stytch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday