stytch 9.9.0 → 9.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dbe1acf900692dfab76ad6a2a915b6d0aa570c86b49548a5adb158791b456e8
-  data.tar.gz: 56b31a4337f5b38f5540046c8183556686d4315cb591c470b0770f18f719d523
+  metadata.gz: 4023ae6cace52f9372e689380961ea0720c243425f8ed54b17f56dd24cb5395a
+  data.tar.gz: 0bd37c0c1b7d57c50ea7150aee027b88dbc59bab2ceafc4b43253b8d7db837d9
 SHA512:
-  metadata.gz: 25ef246a9e7aa615977da5ed743b24b533c9bc94925fb69d33ad79090c70582c05e8e983b5f39f46a5edd54ffcc840a29a715470a67cfe1cb78019e2115b7d97
-  data.tar.gz: fb6a211871535e2269d951b10e009a3051ecdfa09ed3ab879de7436662800fc4678b8d457e628a09d203ecc395e55cfb026de75b0b03def56864d1cc1e798aa3
+  metadata.gz: 962257a3f4012c7ff59140a8d9adb0b0bdff54a3038b9cf5e9410ec24bfc3361daae2cf0100f21cf3c7b4c7f9bf4ac312082fda641a4f089a2931e75beea8677
+  data.tar.gz: d2f9fb55899bb104dcd12e34b1c662362490d2c2175607b61ed7a5505051b844df61aaea422bd7fbb5e4ca2aa43b3e436056ab8f4d0affa16016de81ec88a105

data/lib/stytch/b2b_discovery.rb

@@ -163,12 +163,6 @@ module StytchB2B
       # intermediate_session_token::
       #   The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
       #   The type of this field is +String+.
-      # organization_name::
-      #   The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain.
-      #   The type of this field is +String+.
-      # organization_slug::
-      #   The unique URL slug of the Organization. A minimum of two characters is required. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. If the slug is not specified, a default slug will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization slug will be generated based on the name portion of the email. Otherwise, the organization slug will be generated based on the email domain.
-      #   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
@@ -187,6 +181,12 @@ module StytchB2B
       #   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+.
+      # organization_name::
+      #   The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain.
+      #   The type of this field is nilable +String+.
+      # organization_slug::
+      #   The unique URL slug of the Organization. A minimum of two characters is required. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. If the slug is not specified, a default slug will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization slug will be generated based on the name portion of the email. Otherwise, the organization slug will be generated based on the email domain.
+      #   The type of this field is nilable +String+.
       # organization_logo_url::
       #   The image URL of the Organization logo.
       #   The type of this field is nilable +String+.
@@ -319,10 +319,10 @@ module StytchB2B
       #   The type of this field is nilable +PrimaryRequired+ (+object+).
       def create(
         intermediate_session_token:,
-        organization_name:,
-        organization_slug:,
         session_duration_minutes: nil,
         session_custom_claims: nil,
+        organization_name: nil,
+        organization_slug: nil,
         organization_logo_url: nil,
         trusted_metadata: nil,
         sso_jit_provisioning: nil,
@@ -340,12 +340,12 @@ module StytchB2B
       )
         headers = {}
         request = {
-          intermediate_session_token: intermediate_session_token,
-          organization_name: organization_name,
-          organization_slug: organization_slug
+          intermediate_session_token: intermediate_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?
+        request[:organization_name] = organization_name unless organization_name.nil?
+        request[:organization_slug] = organization_slug unless organization_slug.nil?
         request[:organization_logo_url] = organization_logo_url unless organization_logo_url.nil?
         request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
         request[:sso_jit_provisioning] = sso_jit_provisioning unless sso_jit_provisioning.nil?

data/lib/stytch/b2b_sso.rb

@@ -311,7 +311,9 @@ module StytchB2B
       #   A human-readable display name for the connection.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +CreateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:
@@ -394,7 +396,9 @@ module StytchB2B
       #   The location of the IdP's JSON Web Key Set, used to verify credentials issued by the IdP. This will be provided by the IdP.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +UpdateConnectionRequestIdentityProvider+ (string enum).
       # custom_scopes::
       #   Include a space-separated list of custom scopes that you'd like to include. Note that this list must be URL encoded, e.g. the spaces must be expressed as %20.
@@ -548,7 +552,9 @@ module StytchB2B
       #   A human-readable display name for the connection.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +CreateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:
@@ -624,7 +630,9 @@ module StytchB2B
       #   An alternative URL to use for the Audience Restriction. This value can be used when you wish to migrate an existing SAML integration to Stytch with zero downtime. Read our [SSO migration guide](https://stytch.com/docs/b2b/guides/migrations/additional-migration-considerations) for more info.
       #   The type of this field is nilable +String+.
       # identity_provider::
-      #   The identity provider of this connection. For OIDC, the accepted values are `generic`, `okta`, and `microsoft-entra`. For SAML, the accepted values are `generic`, `okta`, `microsoft-entra`, and `google-workspace`.
+      #   Name of the IdP. Enum with possible values: `classlink`, `cyberark`, `duo`, `google-workspace`, `jumpcloud`, `keycloak`, `miniorange`, `microsoft-entra`, `okta`, `onelogin`, `pingfederate`, `rippling`, `salesforce`, `shibboleth`, or `generic`.
+      #
+      # Specifying a known provider allows Stytch to handle any provider-specific logic.
       #   The type of this field is nilable +UpdateConnectionRequestIdentityProvider+ (string enum).
       #
       # == Returns:

data/lib/stytch/otps.rb

@@ -485,10 +485,10 @@ module Stytch
       #   The `session_jwt` associated with a User's existing Session.
       #   The type of this field is nilable +String+.
       # 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.
+      #   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 OTP - Login.
       #   The type of this field is nilable +String+.
       # 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.
+      #   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 OTP - Sign-up.
       #   The type of this field is nilable +String+.
       #
       # == Returns:

data/lib/stytch/users.rb

@@ -156,7 +156,15 @@ module Stytch
       get_request(request, headers)
     end
 
-    # Search for Users within your Stytch Project. Submit an empty `query` in the request to return all Users.
+    # Search for Users within your Stytch Project.
+    #
+    # Use the `query` object to filter by different fields. See the `query.operands.filter_value` documentation below for a list of available filters.
+    #
+    # ### Export all User data
+    #
+    # Submit an empty `query` in your Search Users request to return all of your Stytch Project's Users.
+    #
+    # [This Github repository](https://github.com/stytchauth/stytch-node-export-users) contains a utility that leverages the Search Users endpoint to export all of your User data to a CSV or JSON file.
     #
     # == Parameters:
     # cursor::

data/lib/stytch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 9.9.0
+  version: 9.10.0
 platform: ruby
 authors:
 - stytch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday