stytch 5.0.2 → 6.0.0

data/lib/stytch/sessions.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+# !!!
+# WARNING: This file is autogenerated
+# Only modify code within MANUAL() sections
+# or your changes may be overwritten later!
+# !!!
+
 require 'jwt'
 require 'json/jwt'
-
 require_relative 'errors'
 require_relative 'request_helper'
 
@@ -10,10 +15,9 @@ module Stytch
   class Sessions
     include Stytch::RequestHelper
 
-    PATH = '/v1/sessions'
-
     def initialize(connection, project_id)
       @connection = connection
+
       @project_id = project_id
       @cache_last_update = 0
       @jwks_loader = lambda do |options|
@@ -21,7 +25,7 @@ module Stytch
         @cached_keys ||= begin
           @cache_last_update = Time.now.to_i
           keys = []
-          jwks(project_id: @project_id)['keys'].each do |r|
+          get_jwks(project_id: @project_id)['keys'].each do |r|
             keys << r
           end
           { keys: keys }
@@ -29,51 +33,155 @@ module Stytch
       end
     end
 
-    def get(user_id:)
+    # List all active Sessions for a given `user_id`. All timestamps are formatted according to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
+    #
+    # == Parameters:
+    # user_id::
+    #   The `user_id` to get active Sessions for.
+    #   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+.
+    # sessions::
+    #   An array of Session objects.
+    #   The type of this field is list of +Session+ (+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 get(
+      user_id:
+    )
       query_params = {
         user_id: user_id
       }
-
-      request = request_with_query_params(PATH, query_params)
-
+      request = request_with_query_params('/v1/sessions', query_params)
       get_request(request)
     end
 
+    # Authenticate a session token and retrieve associated session data. If `session_duration_minutes` is included, update the lifetime of the session to be that many minutes from now. All timestamps are formatted according to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. This endpoint requires exactly one `session_jwt` or `session_token` as part of the request. If both are included you will receive a `too_many_session_arguments` error.
+    #
+    # == Parameters:
+    # session_token::
+    #   The session token to authenticate.
+    #   The type of this field is nilable +String+.
+    # session_duration_minutes::
+    #   Set the session lifetime to be this many minutes from now; minimum of 5 and a maximum of 527040 minutes (366 days). Note that a successful authentication will continue to extend the session this many minutes.
+    #   The type of this field is nilable +Integer+.
+    # session_jwt::
+    #   The JWT to authenticate. You may provide a JWT that has expired according to its `exp` claim and needs to be refreshed. If the signature is valid and the underlying session is still active then Stytch will return a new JWT.
+    #   The type of this field is nilable +String+.
+    # 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+.
+    # 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::
+    #   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_jwt: nil,
       session_duration_minutes: nil,
+      session_jwt: nil,
       session_custom_claims: nil
     )
       request = {}
-
       request[:session_token] = session_token unless session_token.nil?
-      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request("#{PATH}/authenticate", request)
+      post_request('/v1/sessions/authenticate', request)
     end
 
+    # Revoke a Session, immediately invalidating all of its session tokens. You can revoke a session in three ways: using its ID, or using one of its session tokens, or one of its JWTs. This endpoint requires exactly one of those to be included in the request. It will return an error if multiple are present.
+    #
+    # == Parameters:
+    # session_id::
+    #   The `session_id` to revoke.
+    #   The type of this field is nilable +String+.
+    # session_token::
+    #   The session token to revoke.
+    #   The type of this field is nilable +String+.
+    # session_jwt::
+    #   A JWT for the session to revoke.
+    #   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+.
+    # 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 revoke(
       session_id: nil,
       session_token: nil,
       session_jwt: nil
     )
       request = {}
-
       request[:session_id] = session_id unless session_id.nil?
       request[:session_token] = session_token unless session_token.nil?
       request[:session_jwt] = session_jwt unless session_jwt.nil?
 
-      post_request("#{PATH}/revoke", request)
+      post_request('/v1/sessions/revoke', request)
     end
 
-    def jwks(project_id:)
-      request_path = "#{PATH}/jwks/" + project_id
-      get_request(request_path)
+    # Get the JSON Web Key Set (JWKS) for a Stytch Project.
+    #
+    # == Parameters:
+    # project_id::
+    #   The `project_id` to get the JWKS for.
+    #   The type of this field is +String+.
+    #
+    # == Returns:
+    # An object with the following fields:
+    # keys::
+    #   The JWK
+    #   The type of this field is list of +JWK+ (+object+).
+    # 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 get_jwks(
+      project_id:
+    )
+      query_params = {}
+      request = request_with_query_params("/v1/sessions/jwks/#{project_id}", query_params)
+      get_request(request)
     end
 
+    # MANUAL(authenticate_jwt)(SERVICE_METHOD)
+    # ADDIMPORT: require 'jwt'
+    # ADDIMPORT: require 'json/jwt'
+    # ADDIMPORT: require_relative 'errors'
+
     # Parse a JWT and verify the signature. If max_token_age_seconds is unset, call the API directly
     # If max_token_age_seconds is set and the JWT was issued (based on the "iat" claim) less than
     # max_token_age_seconds seconds ago, then just verify locally and don't call the API
@@ -88,28 +196,28 @@ module Stytch
         return authenticate(
           session_jwt: session_jwt,
           session_duration_minutes: session_duration_minutes,
-          session_custom_claims: session_custom_claims,
+          session_custom_claims: session_custom_claims
         )
       end
 
       decoded_jwt = authenticate_jwt_local(session_jwt)
-      iat_time = Time.at(decoded_jwt["iat"]).to_datetime
+      iat_time = Time.at(decoded_jwt['iat']).to_datetime
       if iat_time + max_token_age_seconds >= Time.now
         session = marshal_jwt_into_session(decoded_jwt)
-        return {"session" => session}
+        { 'session' => session }
       else
-        return authenticate(
+        authenticate(
           session_jwt: session_jwt,
           session_duration_minutes: session_duration_minutes,
-          session_custom_claims: session_custom_claims,
+          session_custom_claims: session_custom_claims
         )
       end
     rescue StandardError
       # JWT could not be verified locally. Check with the Stytch API.
-      return authenticate(
+      authenticate(
         session_jwt: session_jwt,
         session_duration_minutes: session_duration_minutes,
-        session_custom_claims: session_custom_claims,
+        session_custom_claims: session_custom_claims
       )
     end
 
@@ -118,11 +226,11 @@ module Stytch
     # function to get the JWK
     # This method never authenticates a JWT directly with the API
     def authenticate_jwt_local(session_jwt)
-      issuer = "stytch.com/" + @project_id
+      issuer = 'stytch.com/' + @project_id
       begin
         decoded_token = JWT.decode session_jwt, nil, true,
-        { jwks: @jwks_loader, iss: issuer, verify_iss: true, aud: @project_id, verify_aud: true, algorithms: ["RS256"]}
-        return decoded_token[0]
+                                   { jwks: @jwks_loader, iss: issuer, verify_iss: true, aud: @project_id, verify_aud: true, algorithms: ['RS256'] }
+        decoded_token[0]
       rescue JWT::InvalidIssuerError
         raise JWTInvalidIssuerError
       rescue JWT::InvalidAudError
@@ -135,24 +243,25 @@ module Stytch
     end
 
     def marshal_jwt_into_session(jwt)
-      stytch_claim = "https://stytch.com/session"
-      expires_at = jwt[stytch_claim]["expires_at"] || Time.at(jwt["exp"]).to_datetime.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+      stytch_claim = 'https://stytch.com/session'
+      expires_at = jwt[stytch_claim]['expires_at'] || Time.at(jwt['exp']).to_datetime.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
       # The custom claim set is all the claims in the payload except for the standard claims and
       # the Stytch session claim. The cleanest way to collect those seems to be naming what we want
       # to omit and filtering the rest to collect the custom claims.
       reserved_claims = ['aud', 'exp', 'iat', 'iss', 'jti', 'nbf', 'sub', stytch_claim]
       custom_claims = jwt.reject { |key, _| reserved_claims.include?(key) }
-      return {
-        "session_id" => jwt[stytch_claim]["id"],
-        "user_id" => jwt["sub"],
-        "started_at" => jwt[stytch_claim]["started_at"],
-        "last_accessed_at" => jwt[stytch_claim]["last_accessed_at"],
+      {
+        'session_id' => jwt[stytch_claim]['id'],
+        'user_id' => jwt['sub'],
+        'started_at' => jwt[stytch_claim]['started_at'],
+        'last_accessed_at' => jwt[stytch_claim]['last_accessed_at'],
         # For JWTs that include it, prefer the inner expires_at claim.
-        "expires_at" => expires_at,
-        "attributes" => jwt[stytch_claim]["attributes"],
-        "authentication_factors" => jwt[stytch_claim]["authentication_factors"],
-        "custom_claims" => custom_claims,
+        'expires_at' => expires_at,
+        'attributes' => jwt[stytch_claim]['attributes'],
+        'authentication_factors' => jwt[stytch_claim]['authentication_factors'],
+        'custom_claims' => custom_claims
       }
     end
+    # ENDMANUAL(authenticate_jwt)
   end
 end

data/lib/stytch/totps.rb

@@ -1,17 +1,57 @@
 # frozen_string_literal: true
 
+# !!!
+# WARNING: This file is autogenerated
+# Only modify code within MANUAL() sections
+# or your changes may be overwritten later!
+# !!!
+
 require_relative 'request_helper'
 
 module Stytch
   class TOTPs
     include Stytch::RequestHelper
 
-    PATH = '/v1/totps'
-
     def initialize(connection)
       @connection = connection
     end
 
+    # Create a new TOTP instance for a user. The user can use the authenticator application of their choice to scan the QR code or enter the secret.
+    #
+    # == Parameters:
+    # user_id::
+    #   The `user_id` of an active user the TOTP registration should be tied to.
+    #   The type of this field is +String+.
+    # expiration_minutes::
+    #   The expiration for the TOTP instance. If the newly created TOTP is not authenticated within this time frame the TOTP will be unusable. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 1440.
+    #   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+.
+    # totp_id::
+    #   The unique ID for a TOTP instance.
+    #   The type of this field is +String+.
+    # secret::
+    #   The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.
+    #   The type of this field is +String+.
+    # qr_code::
+    #   The QR code image encoded in base64.
+    #   The type of this field is +String+.
+    # recovery_codes::
+    #   The recovery codes used to authenticate the user without an authenticator app.
+    #   The type of this field is list of +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+).
+    # user_id::
+    #   The unique ID of the affected User.
+    #   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 create(
       user_id:,
       expiration_minutes: nil
@@ -19,33 +59,113 @@ module Stytch
       request = {
         user_id: user_id
       }
-
       request[:expiration_minutes] = expiration_minutes unless expiration_minutes.nil?
 
-      post_request(PATH, request)
+      post_request('/v1/totps', request)
     end
 
+    # Authenticate a TOTP code entered by a user.
+    #
+    # == Parameters:
+    # user_id::
+    #   The `user_id` of an active user the TOTP registration should be tied to.
+    #   The type of this field is +String+.
+    # totp_code::
+    #   The TOTP code to authenticate. The TOTP code should consist of 6 digits.
+    #   The type of this field is +String+.
+    # session_token::
+    #   The `session_token` associated with a User's existing Session.
+    #   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 not be created.
+    #   The type of this field is nilable +Integer+.
+    # session_jwt::
+    #   The `session_jwt` associated with a User's existing Session.
+    #   The type of this field is nilable +String+.
+    # 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+.
+    # totp_id::
+    #   The unique ID for a TOTP instance.
+    #   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::
+    #   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(
       user_id:,
       totp_code:,
       session_token: nil,
-      session_jwt: nil,
       session_duration_minutes: nil,
+      session_jwt: nil,
       session_custom_claims: nil
     )
       request = {
         user_id: user_id,
         totp_code: totp_code
       }
-
       request[:session_token] = session_token unless session_token.nil?
-      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request("#{PATH}/authenticate", request)
+      post_request('/v1/totps/authenticate', request)
     end
 
+    # Retrieve the recovery codes for a TOTP instance tied to a User.
+    #
+    # == Parameters:
+    # user_id::
+    #   The `user_id` of an active user the TOTP registration should be tied to.
+    #   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+.
+    # user_id::
+    #   The unique ID of the affected User.
+    #   The type of this field is +String+.
+    # totps::
+    #   An array containing a list of all TOTP instances (along with their recovery codes) for a given User in the Stytch API.
+    #   The type of this field is list of +TOTP+ (+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 recovery_codes(
       user_id:
     )
@@ -53,28 +173,88 @@ module Stytch
         user_id: user_id
       }
 
-      post_request("#{PATH}/recovery_codes", request)
+      post_request('/v1/totps/recovery_codes', request)
     end
 
+    # Authenticate a recovery code for a TOTP instance.
+    #
+    # == Parameters:
+    # user_id::
+    #   The `user_id` of an active user the TOTP registration should be tied to.
+    #   The type of this field is +String+.
+    # recovery_code::
+    #   The recovery code to authenticate.
+    #   The type of this field is +String+.
+    # session_token::
+    #   The `session_token` associated with a User's existing Session.
+    #   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 not be created.
+    #   The type of this field is nilable +Integer+.
+    # session_jwt::
+    #   The `session_jwt` associated with a User's existing Session.
+    #   The type of this field is nilable +String+.
+    # 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+.
+    # totp_id::
+    #   The unique ID for a TOTP instance.
+    #   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::
+    #   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 recover(
       user_id:,
       recovery_code:,
       session_token: nil,
-      session_jwt: nil,
       session_duration_minutes: nil,
+      session_jwt: nil,
       session_custom_claims: nil
     )
       request = {
         user_id: user_id,
         recovery_code: recovery_code
       }
-
       request[:session_token] = session_token unless session_token.nil?
-      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
+      request[:session_jwt] = session_jwt unless session_jwt.nil?
       request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
-      post_request("#{PATH}/recover", request)
+      post_request('/v1/totps/recover', request)
     end
   end
 end