workos 9.4.0 → 10.0.0

data/lib/workos/user_management/magic_auth_send_magic_auth_code_and_return_response.rb

@@ -5,13 +5,38 @@
 module WorkOS
   class MagicAuthSendMagicAuthCodeAndReturnResponse < WorkOS::Types::BaseModel
     HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      user_id: :user_id,
+      email: :email,
+      expires_at: :expires_at,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      code: :code,
       radar_auth_attempt_id: :radar_auth_attempt_id
     }.freeze
 
-    attr_accessor :radar_auth_attempt_id
+    attr_accessor \
+      :object,
+      :id,
+      :user_id,
+      :email,
+      :expires_at,
+      :created_at,
+      :updated_at,
+      :code,
+      :radar_auth_attempt_id
 
     def initialize(json)
       hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @user_id = hash[:user_id]
+      @email = hash[:email]
+      @expires_at = hash[:expires_at]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @code = hash[:code]
       @radar_auth_attempt_id = hash[:radar_auth_attempt_id]
     end
   end

data/lib/workos/user_management/radar_challenge.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class RadarChallenge < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      type: :type,
+      user_id: :user_id,
+      email: :email,
+      expires_at: :expires_at,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      code: :code
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :type,
+      :user_id,
+      :email,
+      :expires_at,
+      :created_at,
+      :updated_at,
+      :code
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @type = hash[:type]
+      @user_id = hash[:user_id]
+      @email = hash[:email]
+      @expires_at = hash[:expires_at]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @code = hash[:code]
+    end
+  end
+end

data/lib/workos/user_management/user_create_response.rb

@@ -3,5 +3,59 @@
 # This file is auto-generated by oagen. Do not edit.
 
 module WorkOS
-  UserCreateResponse = MagicAuthSendMagicAuthCodeAndReturnResponse
+  class UserCreateResponse < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      first_name: :first_name,
+      last_name: :last_name,
+      name: :name,
+      profile_picture_url: :profile_picture_url,
+      email: :email,
+      email_verified: :email_verified,
+      external_id: :external_id,
+      metadata: :metadata,
+      last_sign_in_at: :last_sign_in_at,
+      locale: :locale,
+      created_at: :created_at,
+      updated_at: :updated_at,
+      radar_auth_attempt_id: :radar_auth_attempt_id
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :first_name,
+      :last_name,
+      :name,
+      :profile_picture_url,
+      :email,
+      :email_verified,
+      :external_id,
+      :metadata,
+      :last_sign_in_at,
+      :locale,
+      :created_at,
+      :updated_at,
+      :radar_auth_attempt_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @first_name = hash[:first_name]
+      @last_name = hash[:last_name]
+      @name = hash[:name]
+      @profile_picture_url = hash[:profile_picture_url]
+      @email = hash[:email]
+      @email_verified = hash[:email_verified]
+      @external_id = hash[:external_id]
+      @metadata = hash[:metadata] || {}
+      @last_sign_in_at = hash[:last_sign_in_at]
+      @locale = hash[:locale]
+      @created_at = hash[:created_at]
+      @updated_at = hash[:updated_at]
+      @radar_auth_attempt_id = hash[:radar_auth_attempt_id]
+    end
+  end
 end

data/lib/workos/user_management.rb

@@ -133,6 +133,8 @@ module WorkOS
     # @param ip_address [String, nil]
     # @param device_id [String, nil]
     # @param user_agent [String, nil]
+    # @param signals_id [String, nil]
+    # @param radar_auth_attempt_id [String, nil]
     # @param request_options [Hash] Per-request overrides.
     # @return [WorkOS::AuthenticateResponse]
     def authenticate_with_password(
@@ -142,6 +144,8 @@ module WorkOS
       ip_address: nil,
       device_id: nil,
       user_agent: nil,
+      signals_id: nil,
+      radar_auth_attempt_id: nil,
       request_options: {}
     )
       body = {
@@ -153,7 +157,9 @@ module WorkOS
         "invitation_token" => invitation_token,
         "ip_address" => ip_address,
         "device_id" => device_id,
-        "user_agent" => user_agent
+        "user_agent" => user_agent,
+        "signals_id" => signals_id,
+        "radar_auth_attempt_id" => radar_auth_attempt_id
       }.compact
       response = @client.request(
         method: :post,
@@ -172,6 +178,7 @@ module WorkOS
     # @param ip_address [String, nil]
     # @param device_id [String, nil]
     # @param user_agent [String, nil]
+    # @param signals_id [String, nil]
     # @param request_options [Hash] Per-request overrides.
     # @return [WorkOS::AuthenticateResponse]
     def authenticate_with_code(
@@ -181,6 +188,7 @@ module WorkOS
       ip_address: nil,
       device_id: nil,
       user_agent: nil,
+      signals_id: nil,
       request_options: {}
     )
       body = {
@@ -192,7 +200,8 @@ module WorkOS
         "invitation_token" => invitation_token,
         "ip_address" => ip_address,
         "device_id" => device_id,
-        "user_agent" => user_agent
+        "user_agent" => user_agent,
+        "signals_id" => signals_id
       }.compact
       response = @client.request(
         method: :post,
@@ -247,6 +256,7 @@ module WorkOS
     # @param ip_address [String, nil]
     # @param device_id [String, nil]
     # @param user_agent [String, nil]
+    # @param radar_auth_attempt_id [String, nil]
     # @param request_options [Hash] Per-request overrides.
     # @return [WorkOS::AuthenticateResponse]
     def authenticate_with_magic_auth(
@@ -256,6 +266,7 @@ module WorkOS
       ip_address: nil,
       device_id: nil,
       user_agent: nil,
+      radar_auth_attempt_id: nil,
       request_options: {}
     )
       body = {
@@ -267,7 +278,8 @@ module WorkOS
         "invitation_token" => invitation_token,
         "ip_address" => ip_address,
         "device_id" => device_id,
-        "user_agent" => user_agent
+        "user_agent" => user_agent,
+        "radar_auth_attempt_id" => radar_auth_attempt_id
       }.compact
       response = @client.request(
         method: :post,
@@ -422,6 +434,87 @@ module WorkOS
       WorkOS::AuthenticateResponse.new(response.body)
     end
 
+    # Authenticate with radar email challenge.
+    # @param code [String]
+    # @param radar_challenge_id [String]
+    # @param pending_authentication_token [String]
+    # @param ip_address [String, nil]
+    # @param device_id [String, nil]
+    # @param user_agent [String, nil]
+    # @param request_options [Hash] Per-request overrides.
+    # @return [WorkOS::AuthenticateResponse]
+    def authenticate_with_radar_email_challenge(
+      code:,
+      radar_challenge_id:,
+      pending_authentication_token:,
+      ip_address: nil,
+      device_id: nil,
+      user_agent: nil,
+      request_options: {}
+    )
+      body = {
+        "grant_type" => "urn:workos:oauth:grant-type:radar-email-challenge:code",
+        "client_id" => @client.client_id,
+        "client_secret" => @client.api_key,
+        "code" => code,
+        "radar_challenge_id" => radar_challenge_id,
+        "pending_authentication_token" => pending_authentication_token,
+        "ip_address" => ip_address,
+        "device_id" => device_id,
+        "user_agent" => user_agent
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/user_management/authenticate",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      WorkOS::AuthenticateResponse.new(response.body)
+    end
+
+    # Authenticate with radar sms challenge.
+    # @param code [String]
+    # @param verification_id [String]
+    # @param phone_number [String]
+    # @param pending_authentication_token [String]
+    # @param ip_address [String, nil]
+    # @param device_id [String, nil]
+    # @param user_agent [String, nil]
+    # @param request_options [Hash] Per-request overrides.
+    # @return [WorkOS::AuthenticateResponse]
+    def authenticate_with_radar_sms_challenge(
+      code:,
+      verification_id:,
+      phone_number:,
+      pending_authentication_token:,
+      ip_address: nil,
+      device_id: nil,
+      user_agent: nil,
+      request_options: {}
+    )
+      body = {
+        "grant_type" => "urn:workos:oauth:grant-type:radar-sms-challenge:code",
+        "client_id" => @client.client_id,
+        "client_secret" => @client.api_key,
+        "code" => code,
+        "verification_id" => verification_id,
+        "phone_number" => phone_number,
+        "pending_authentication_token" => pending_authentication_token,
+        "ip_address" => ip_address,
+        "device_id" => device_id,
+        "user_agent" => user_agent
+      }.compact
+      response = @client.request(
+        method: :post,
+        path: "/user_management/authenticate",
+        auth: true,
+        body: body,
+        request_options: request_options
+      )
+      WorkOS::AuthenticateResponse.new(response.body)
+    end
+
     # Get device authorization URL
     # @param client_id [String] The WorkOS client ID for your application.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
@@ -480,6 +573,25 @@ module WorkOS
       result
     end
 
+    # Get Radar Challenge details
+    # @param id [String] The unique ID of the Radar Challenge.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [WorkOS::RadarChallenge]
+    def get_radar_challenge(
+      id:,
+      request_options: {}
+    )
+      response = @client.request(
+        method: :get,
+        path: "/user_management/radar_challenges/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        request_options: request_options
+      )
+      result = WorkOS::RadarChallenge.new(response.body)
+      result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
+      result
+    end
+
     # Revoke Session
     # @param session_id [String] The ID of the session to revoke. This can be extracted from the `sid` claim of the access token.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
@@ -727,30 +839,30 @@ module WorkOS
     # @return [WorkOS::UserCreateResponse]
     def create_user(
       email:,
-      first_name: nil,
-      last_name: nil,
-      name: nil,
-      email_verified: nil,
-      metadata: nil,
-      external_id: nil,
-      ip_address: nil,
-      user_agent: nil,
+      first_name: WorkOS::OMIT,
+      last_name: WorkOS::OMIT,
+      name: WorkOS::OMIT,
+      email_verified: WorkOS::OMIT,
+      metadata: WorkOS::OMIT,
+      external_id: WorkOS::OMIT,
+      ip_address: WorkOS::OMIT,
+      user_agent: WorkOS::OMIT,
       signals_id: nil,
       password: nil,
       request_options: {}
     )
       body = {
         "email" => email,
-        "first_name" => first_name,
-        "last_name" => last_name,
-        "name" => name,
-        "email_verified" => email_verified,
-        "metadata" => metadata,
-        "external_id" => external_id,
-        "ip_address" => ip_address,
-        "user_agent" => user_agent,
         "signals_id" => signals_id
       }.compact
+      body["first_name"] = first_name unless first_name.equal?(WorkOS::OMIT)
+      body["last_name"] = last_name unless last_name.equal?(WorkOS::OMIT)
+      body["name"] = name unless name.equal?(WorkOS::OMIT)
+      body["email_verified"] = email_verified unless email_verified.equal?(WorkOS::OMIT)
+      body["metadata"] = metadata unless metadata.equal?(WorkOS::OMIT)
+      body["external_id"] = external_id unless external_id.equal?(WorkOS::OMIT)
+      body["ip_address"] = ip_address unless ip_address.equal?(WorkOS::OMIT)
+      body["user_agent"] = user_agent unless user_agent.equal?(WorkOS::OMIT)
       if password
         case password
         when WorkOS::UserManagement::PasswordPlaintext
@@ -832,9 +944,9 @@ module WorkOS
       last_name: nil,
       name: nil,
       email_verified: nil,
-      metadata: nil,
-      external_id: nil,
-      locale: nil,
+      metadata: WorkOS::OMIT,
+      external_id: WorkOS::OMIT,
+      locale: WorkOS::OMIT,
       password: nil,
       request_options: {}
     )
@@ -843,11 +955,11 @@ module WorkOS
         "first_name" => first_name,
         "last_name" => last_name,
         "name" => name,
-        "email_verified" => email_verified,
-        "metadata" => metadata,
-        "external_id" => external_id,
-        "locale" => locale
+        "email_verified" => email_verified
       }.compact
+      body["metadata"] = metadata unless metadata.equal?(WorkOS::OMIT)
+      body["external_id"] = external_id unless external_id.equal?(WorkOS::OMIT)
+      body["locale"] = locale unless locale.equal?(WorkOS::OMIT)
       if password
         case password
         when WorkOS::UserManagement::PasswordPlaintext
@@ -1400,6 +1512,23 @@ module WorkOS
       result
     end
 
+    # Delete a redirect URI
+    # @param id [String] The ID of the redirect URI to delete.
+    # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
+    # @return [void]
+    def delete_redirect_uris(
+      id:,
+      request_options: {}
+    )
+      @client.request(
+        method: :delete,
+        path: "/user_management/redirect_uris/#{WorkOS::Util.encode_path(id)}",
+        auth: true,
+        request_options: request_options
+      )
+      nil
+    end
+
     # List authorized applications
     # @param user_id [String] The ID of the user.
     # @param before [String, nil] An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`.

data/lib/workos/vault/vault_kek_deleted.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class VaultKekDeleted < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      object: :object,
+      id: :id,
+      event: :event,
+      data: :data,
+      created_at: :created_at,
+      context: :context
+    }.freeze
+
+    attr_accessor \
+      :object,
+      :id,
+      :event,
+      :data,
+      :created_at,
+      :context
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @object = hash[:object]
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data] ? WorkOS::VaultKekDeletedData.new(hash[:data]) : nil
+      @created_at = hash[:created_at]
+      @context = hash[:context] ? WorkOS::EventContext.new(hash[:context]) : nil
+    end
+  end
+end

data/lib/workos/vault/vault_kek_deleted_data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+module WorkOS
+  class VaultKekDeletedData < WorkOS::Types::BaseModel
+    HASH_ATTRS = {
+      actor_id: :actor_id,
+      actor_source: :actor_source,
+      actor_name: :actor_name,
+      key_name: :key_name,
+      key_id: :key_id
+    }.freeze
+
+    attr_accessor \
+      :actor_id,
+      :actor_source,
+      :actor_name,
+      :key_name,
+      :key_id
+
+    def initialize(json)
+      hash = self.class.normalize(json)
+      @actor_id = hash[:actor_id]
+      @actor_source = hash[:actor_source]
+      @actor_name = hash[:actor_name]
+      @key_name = hash[:key_name]
+      @key_id = hash[:key_id]
+    end
+  end
+end

data/lib/workos/vault.rb

@@ -213,13 +213,13 @@ module WorkOS
     def update_kv(
       id:,
       value:,
-      version_check: nil,
+      version_check: WorkOS::OMIT,
       request_options: {}
     )
       body = {
-        "value" => value,
-        "version_check" => version_check
-      }.compact
+        "value" => value
+      }
+      body["version_check"] = version_check unless version_check.equal?(WorkOS::OMIT)
       response = @client.request(
         method: :put,
         path: "/vault/v1/kv/#{WorkOS::Util.encode_path(id)}",

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 
 # @oagen-ignore-file
 module WorkOS
-  VERSION = "9.4.0"
+  VERSION = "10.0.0"
 end

data/lib/workos/widgets.rb

@@ -11,13 +11,13 @@ module WorkOS
     end
 
     # Generate a widget token
-    # @param organization_id [String] The ID of the organization to scope the widget session to.
+    # @param organization_id [String, nil] The ID of the organization to scope the widget session to. Required when scopes are provided. Optional when issuing a token for user-only widgets (e.g. `UserProfile`, `UserSecurity`) that do not require organization context.
     # @param user_id [String, nil] The ID of the user to issue the widget session token for.
     # @param scopes [Array<WorkOS::Types::WidgetSessionTokenScopes>, nil] The scopes to grant the widget session.
     # @param request_options [Hash] (see WorkOS::Types::RequestOptions)
     # @return [WorkOS::WidgetSessionTokenResponse]
     def create_token(
-      organization_id:,
+      organization_id: nil,
       user_id: nil,
       scopes: nil,
       request_options: {}

data/lib/workos.rb

@@ -5,12 +5,23 @@
 require "zeitwerk"
 
 module WorkOS
+  # Sentinel default for nullable optional parameters. Distinguishes an
+  # omitted argument ("leave unchanged") from an explicit `nil`, which
+  # clears the field by sending JSON `null`.
+  OMIT = Object.new
+
+  def OMIT.inspect
+    "WorkOS::OMIT"
+  end
+
+  OMIT.freeze
 end
 
 loader = Zeitwerk::Loader.for_gem
 require_relative "workos/inflections"
 loader.inflector.inflect(WORKOS_INFLECTIONS)
 loader.collapse("#{__dir__}/workos/admin_portal")
+loader.collapse("#{__dir__}/workos/agents")
 loader.collapse("#{__dir__}/workos/api_keys")
 loader.collapse("#{__dir__}/workos/audit_logs")
 loader.collapse("#{__dir__}/workos/authorization")

data/rbi/workos/access_token_agent_registration_credential_issued_data_detail.rbi

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AccessTokenAgentRegistrationCredentialIssuedDataDetail
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def kind; end
+
+    sig { params(value: String).returns(String) }
+    def kind=(value); end
+
+    sig { returns(String) }
+    def jti; end
+
+    sig { params(value: String).returns(String) }
+    def jti=(value); end
+
+    sig { returns(T.any(String, T.nilable(String))) }
+    def expires_at; end
+
+    sig { params(value: T.any(String, T.nilable(String))).returns(T.any(String, T.nilable(String))) }
+    def expires_at=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_admin_link_claim_attempt_to_external_user_request.rbi

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentAdminLinkClaimAttemptToExternalUserRequest
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def type; end
+
+    sig { params(value: String).returns(String) }
+    def type=(value); end
+
+    sig { returns(String) }
+    def claim_attempt_token; end
+
+    sig { params(value: String).returns(String) }
+    def claim_attempt_token=(value); end
+
+    sig { returns(WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequestUser) }
+    def user; end
+
+    sig { params(value: WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequestUser).returns(WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequestUser) }
+    def user=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def organization_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def organization_id=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end

data/rbi/workos/agent_admin_link_claim_attempt_to_external_user_request_user.rbi

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentAdminLinkClaimAttemptToExternalUserRequestUser
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def email; end
+
+    sig { params(value: String).returns(String) }
+    def email=(value); end
+
+    sig { returns(String) }
+    def external_id; end
+
+    sig { params(value: String).returns(String) }
+    def external_id=(value); end
+
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end