stytch 6.0.0 → 6.2.0

data/lib/stytch/magic_links.rb

@@ -172,7 +172,7 @@ module Stytch
       # Adding a new email to an existing Stytch User requires the user to be present and validate the email via magic link. This requirement is in place to prevent account takeover attacks.
       #
       # ### Next steps
-      # The user is emailed a magic link which redirects them to the provided [redirect URL](https://stytch.com/docs/magic-links#email-magic-links_redirect-routing). Collect the `token` from the URL query parameters, and call [Authenticate magic link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
+      # The user is emailed a magic link which redirects them to the provided [redirect URL](https://stytch.com/docs/guides/magic-links/email-magic-links/redirect-routing). Collect the `token` from the URL query parameters, and call [Authenticate magic link](https://stytch.com/docs/api/authenticate-magic-link) to complete authentication.
       #
       # == Parameters:
       # email::
@@ -215,7 +215,7 @@ module Stytch
       #
       # 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+ (+object+).
+      #   The type of this field is nilable +SendRequestLocale+ (string enum).
       # signup_template_id::
       #   Use a custom template for sign-up 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 - Sign-up.
       #   The type of this field is nilable +String+.
@@ -315,7 +315,7 @@ module Stytch
       #
       # 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 +LoginOrCreateRequestLocale+ (+object+).
+      #   The type of this field is nilable +LoginOrCreateRequestLocale+ (string enum).
       #
       # == Returns:
       # An object with the following fields:
@@ -395,7 +395,7 @@ module Stytch
       #
       # 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 +InviteRequestLocale+ (+object+).
+      #   The type of this field is nilable +InviteRequestLocale+ (string enum).
       #
       # == Returns:
       # An object with the following fields:

data/lib/stytch/otps.rb

@@ -141,7 +141,7 @@ module Stytch
       #   The phone number to use for one-time passcodes. The phone number should be in E.164 format. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -153,7 +153,7 @@ module Stytch
       #
       # 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+ (+object+).
+      #   The type of this field is nilable +SendRequestLocale+ (string enum).
       # user_id::
       #   The unique ID of a specific User.
       #   The type of this field is nilable +String+.
@@ -211,7 +211,7 @@ module Stytch
       #   The phone number to use for one-time passcodes. The phone number should be in E.164 format. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -230,7 +230,7 @@ module Stytch
       #
       # 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 +LoginOrCreateRequestLocale+ (+object+).
+      #   The type of this field is nilable +LoginOrCreateRequestLocale+ (string enum).
       #
       # == Returns:
       # An object with the following fields:
@@ -294,7 +294,7 @@ module Stytch
       #   The phone number to use for one-time passcodes. The phone number should be in E.164 format. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -306,7 +306,7 @@ module Stytch
       #
       # 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+ (+object+).
+      #   The type of this field is nilable +SendRequestLocale+ (string enum).
       # user_id::
       #   The unique ID of a specific User.
       #   The type of this field is nilable +String+.
@@ -364,7 +364,7 @@ module Stytch
       #   The phone number to use for one-time passcodes. The phone number should be in E.164 format. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). You may use +10000000000 to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -383,7 +383,7 @@ module Stytch
       #
       # 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 +LoginOrCreateRequestLocale+ (+object+).
+      #   The type of this field is nilable +LoginOrCreateRequestLocale+ (string enum).
       #
       # == Returns:
       # An object with the following fields:
@@ -443,7 +443,7 @@ module Stytch
       #   The email address of the user to send the one-time passcode to. You may use sandbox@stytch.com to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -455,7 +455,7 @@ module Stytch
       #
       # 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+ (+object+).
+      #   The type of this field is nilable +SendRequestLocale+ (string enum).
       # user_id::
       #   The unique ID of a specific User.
       #   The type of this field is nilable +String+.
@@ -523,7 +523,7 @@ module Stytch
       #   The email address of the user to send the one-time passcode to. You may use sandbox@stytch.com to test this endpoint, see [Testing](https://stytch.com/docs/home#resources_testing) for more detail.
       #   The type of this field is +String+.
       # expiration_minutes::
-      #   Set the expiration for the Magic Link `token` in minutes. By default, it expires in 1 hour. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
+      #   Set the expiration for the one-time passcode, in minutes. The minimum expiration is 1 minute and the maximum is 10 minutes. The default expiration is 2 minutes.
       #   The type of this field is nilable +Integer+.
       # attributes::
       #   Provided attributes help with fraud detection.
@@ -542,7 +542,7 @@ module Stytch
       #
       # 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 +LoginOrCreateRequestLocale+ (+object+).
+      #   The type of this field is nilable +LoginOrCreateRequestLocale+ (string enum).
       # 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 Magic links - Login.
       #   The type of this field is nilable +String+.

data/lib/stytch/passwords.rb

@@ -197,7 +197,7 @@ module Stytch
 
     # This API allows you to check whether or not the user’s provided password is valid, and to provide feedback to the user on how to increase the strength of their password.
     #
-    # This endpoint adapts to your Project's password strength configuration. If you're using [zxcvbn](https://stytch.com/docs/passwords#strength-requirements), the default, your passwords are considered valid if the strength score is >= 3. If you're using [LUDS](https://stytch.com/docs/passwords#strength-requirements), your passwords are considered valid if they meet the requirements that you've set with Stytch. You may update your password strength configuration in the [stytch dashboard](https://stytch.com/dashboard/password-strength-config).
+    # This endpoint adapts to your Project's password strength configuration. If you're using [zxcvbn](https://stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid if the strength score is >= 3. If you're using [LUDS](https://stytch.com/docs/guides/passwords/strength-policy), your passwords are considered valid if they meet the requirements that you've set with Stytch. You may update your password strength configuration in the [stytch dashboard](https://stytch.com/dashboard/password-strength-config).
     #
     #
     # ### Password feedback
@@ -265,7 +265,7 @@ module Stytch
     #   The type of this field is +String+.
     # hash_type::
     #   The password hash used. Currently `bcrypt`, `scrypt`, `argon_2i`, `argon_2id`, `md_5`, `sha_1`, and `pbkdf_2` are supported.
-    #   The type of this field is +MigrateRequestHashType+ (+object+).
+    #   The type of this field is +MigrateRequestHashType+ (string enum).
     # md_5_config::
     #   Optional parameters for MD-5 hash types.
     #   The type of this field is nilable +MD5Config+ (+object+).
@@ -383,7 +383,7 @@ module Stytch
       #
       # 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 +ResetStartRequestLocale+ (+object+).
+      #   The type of this field is nilable +ResetStartRequestLocale+ (string enum).
       # reset_password_template_id::
       #   Use a custom template for password reset 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 - Password reset.
@@ -624,7 +624,7 @@ module Stytch
         @connection = connection
       end
 
-      # Reset the user’s password using their existing session. The endpoint will error if the session does not have a password, email magic link, or email OTP authentication factor that has been issued within the last 5 minutes.
+      # Reset the user’s password using their existing session. The endpoint will error if the session does not have a password, email magic link, or email OTP authentication factor that has been issued within the last 5 minutes. This endpoint requires either a `session_jwt` or `session_token` be included in the request.
       #
       # == Parameters:
       # password::

data/lib/stytch/sessions.rb

@@ -84,6 +84,12 @@ module Stytch
     # 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+.
+    # 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 +Session+ (+object+).
     # session_token::
     #   A secret token for a given Stytch Session.
     #   The type of this field is +String+.
@@ -96,12 +102,6 @@ module Stytch
     # 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+.
-    # 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 authenticate(
       session_token: nil,
       session_duration_minutes: nil,
@@ -177,7 +177,7 @@ module Stytch
       get_request(request)
     end
 
-    # MANUAL(authenticate_jwt)(SERVICE_METHOD)
+    # MANUAL(Sessions::authenticate_jwt)(SERVICE_METHOD)
     # ADDIMPORT: require 'jwt'
     # ADDIMPORT: require 'json/jwt'
     # ADDIMPORT: require_relative 'errors'
@@ -262,6 +262,6 @@ module Stytch
         'custom_claims' => custom_claims
       }
     end
-    # ENDMANUAL(authenticate_jwt)
+    # ENDMANUAL(Sessions::authenticate_jwt)
   end
 end

data/lib/stytch/version.rb

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

data/lib/stytch.rb

@@ -8,4 +8,5 @@ require_relative 'stytch/middleware'
 require_relative 'stytch/version'
 
 module Stytch end
+
 module StytchB2B end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.2.0
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/auto-publish.yml"
+- ".github/workflows/check-links.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -97,13 +98,16 @@ files:
 - lib/stytch/b2b_client.rb
 - lib/stytch/b2b_discovery.rb
 - lib/stytch/b2b_magic_links.rb
+- lib/stytch/b2b_oauth.rb
 - lib/stytch/b2b_organizations.rb
+- lib/stytch/b2b_otp.rb
 - lib/stytch/b2b_passwords.rb
 - lib/stytch/b2b_sessions.rb
 - lib/stytch/b2b_sso.rb
 - lib/stytch/client.rb
 - lib/stytch/crypto_wallets.rb
 - lib/stytch/errors.rb
+- lib/stytch/m2m.rb
 - lib/stytch/magic_links.rb
 - lib/stytch/middleware.rb
 - lib/stytch/oauth.rb