stytch 6.5.1 → 6.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b550936fb7076aad0eb10a1551f50440e8855c5042e6d1173a68d5eaf8df7b7d
-  data.tar.gz: afa5981979e47b49868ce2be6f701d3d94102365f2565e8f1c42889d548b8af5
+  metadata.gz: 3a2f460766302fa45dac9429da80a2c35f3bf81fdf699f1facd9b604c63ce29e
+  data.tar.gz: 997dc4dfddfdf15912a7d9c6b80ce2064264f7c27dc2530cb0a1868b9001cb42
 SHA512:
-  metadata.gz: 48fb733f974b3f66b0f11d62aa0215ddf162f8d3f715d63c750e3820c261fffb33a1a04668370b66b28f2fb5d7311bd0608d3b6cc421d48629b93bb287dba814
-  data.tar.gz: 6f05e0e6dad871dd162c45007c2e9cf8a303b721d8a81aa1f74dfbe785f317cf14cabdeedfce2abe2d42523773e260998a372644c4fa8da7f1e362b3f186815c
+  metadata.gz: 700ed564d563b810f48284d25a7d4a73857ed8807c192f38e30d6f1db75da6eb67265453579f1d4477f58a0c5544c30498fb2b7528c81b96fc4bb194dd972230
+  data.tar.gz: c9e904425177ec57295efebed39e6b10b1ef6e7dc223f8d86466590c50cbc4bebd5498b57d5a851d4a8c71ffc69b7bd87233362ab7bb72d789b498fe51e82052

data/lib/stytch/version.rb

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

data/lib/stytch/webauthn.rb

@@ -33,6 +33,9 @@ module Stytch
     # authenticator_type::
     #   The requested authenticator type of the WebAuthn device. The two valid value are platform and cross-platform. If no value passed, we assume both values are allowed.
     #   The type of this field is nilable +String+.
+    # return_passkey_credential_options::
+    #   If true, the public_key_credential_creation_options returned will be optimized for Passkeys.
+    #   The type of this field is nilable +Boolean+.
     #
     # == Returns:
     # An object with the following fields:
@@ -52,7 +55,8 @@ module Stytch
       user_id:,
       domain:,
       user_agent: nil,
-      authenticator_type: nil
+      authenticator_type: nil,
+      return_passkey_credential_options: nil
     )
       request = {
         user_id: user_id,
@@ -60,6 +64,7 @@ module Stytch
       }
       request[:user_agent] = user_agent unless user_agent.nil?
       request[:authenticator_type] = authenticator_type unless authenticator_type.nil?
+      request[:return_passkey_credential_options] = return_passkey_credential_options unless return_passkey_credential_options.nil?
 
       post_request('/v1/webauthn/register/start', request)
     end
@@ -75,6 +80,20 @@ module Stytch
     # public_key_credential::
     #   The response of the [navigator.credentials.create()](https://www.w3.org/TR/webauthn-2/#sctn-createCredential).
     #   The type of this field is +String+.
+    # 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:
@@ -87,17 +106,40 @@ module Stytch
     # webauthn_registration_id::
     #   The unique ID for the WebAuthn registration.
     #   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 register(
       user_id:,
-      public_key_credential:
+      public_key_credential:,
+      session_token: nil,
+      session_duration_minutes: nil,
+      session_jwt: nil,
+      session_custom_claims: nil
     )
       request = {
         user_id: user_id,
         public_key_credential: public_key_credential
       }
+      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_custom_claims] = session_custom_claims unless session_custom_claims.nil?
 
       post_request('/v1/webauthn/register', request)
     end
@@ -107,12 +149,15 @@ module Stytch
     # If you are not using the [webauthn-json](https://github.com/github/webauthn-json) library, `the public_key_credential_request_options` will need to be converted to a suitable public key by unmarshalling the JSON and converting some the fields to array buffers.
     #
     # == Parameters:
-    # user_id::
-    #   The `user_id` of an active user the WebAuthn registration should be tied to.
-    #   The type of this field is +String+.
     # domain::
     #   The domain for WebAuthn. Defaults to `window.location.hostname`.
     #   The type of this field is +String+.
+    # user_id::
+    #   The `user_id` of an active user the WebAuthn registration should be tied to.
+    #   The type of this field is nilable +String+.
+    # return_passkey_credential_options::
+    #   If true, the public_key_credential_creation_options returned will be optimized for Passkeys.
+    #   The type of this field is nilable +Boolean+.
     #
     # == Returns:
     # An object with the following fields:
@@ -129,13 +174,15 @@ module Stytch
     #   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_start(
-      user_id:,
-      domain:
+      domain:,
+      user_id: nil,
+      return_passkey_credential_options: nil
     )
       request = {
-        user_id: user_id,
         domain: domain
       }
+      request[:user_id] = user_id unless user_id.nil?
+      request[:return_passkey_credential_options] = return_passkey_credential_options unless return_passkey_credential_options.nil?
 
       post_request('/v1/webauthn/authenticate/start', request)
     end
@@ -217,5 +264,16 @@ module Stytch
 
       post_request('/v1/webauthn/authenticate', request)
     end
+
+    def update(
+      webauthn_registration_id:,
+      name:
+    )
+      request = {
+        name: name
+      }
+
+      put_request("/v1/webauthn/#{webauthn_registration_id}", request)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 6.5.1
+  version: 6.5.2
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday