workos 9.4.0 → 10.0.0

data/rbi/workos/radar_challenge.rbi

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class RadarChallenge
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def object; end
+
+    sig { params(value: String).returns(String) }
+    def object=(value); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(String) }
+    def type; end
+
+    sig { params(value: String).returns(String) }
+    def type=(value); end
+
+    sig { returns(String) }
+    def user_id; end
+
+    sig { params(value: String).returns(String) }
+    def user_id=(value); end
+
+    sig { returns(String) }
+    def email; end
+
+    sig { params(value: String).returns(String) }
+    def email=(value); end
+
+    sig { returns(String) }
+    def expires_at; end
+
+    sig { params(value: String).returns(String) }
+    def expires_at=(value); end
+
+    sig { returns(String) }
+    def created_at; end
+
+    sig { params(value: String).returns(String) }
+    def created_at=(value); end
+
+    sig { returns(String) }
+    def updated_at; end
+
+    sig { params(value: String).returns(String) }
+    def updated_at=(value); end
+
+    sig { returns(String) }
+    def code; end
+
+    sig { params(value: String).returns(String) }
+    def code=(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/radar_challenge_created.rbi

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class RadarChallengeCreated
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def object; end
+
+    sig { params(value: String).returns(String) }
+    def object=(value); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(String) }
+    def event; end
+
+    sig { params(value: String).returns(String) }
+    def event=(value); end
+
+    sig { returns(WorkOS::RadarChallengeCreatedData) }
+    def data; end
+
+    sig { params(value: WorkOS::RadarChallengeCreatedData).returns(WorkOS::RadarChallengeCreatedData) }
+    def data=(value); end
+
+    sig { returns(String) }
+    def created_at; end
+
+    sig { params(value: String).returns(String) }
+    def created_at=(value); end
+
+    sig { returns(T.nilable(WorkOS::EventContext)) }
+    def context; end
+
+    sig { params(value: T.nilable(WorkOS::EventContext)).returns(T.nilable(WorkOS::EventContext)) }
+    def context=(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/radar_challenge_created_data.rbi

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class RadarChallengeCreatedData
+    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 radar_challenge_id; end
+
+    sig { params(value: String).returns(String) }
+    def radar_challenge_id=(value); end
+
+    sig { returns(String) }
+    def user_id; end
+
+    sig { params(value: String).returns(String) }
+    def user_id=(value); end
+
+    sig { returns(String) }
+    def email; end
+
+    sig { params(value: String).returns(String) }
+    def email=(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/update_data_integration.rbi

@@ -27,12 +27,18 @@ module WorkOS
     sig { params(value: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
     def scopes=(value); end
 
-    sig { returns(T.nilable(WorkOS::DataIntegrationCredentialsDto)) }
+    sig { returns(T.nilable(WorkOS::DataIntegrationCredentialsInput)) }
     def credentials; end
 
-    sig { params(value: T.nilable(WorkOS::DataIntegrationCredentialsDto)).returns(T.nilable(WorkOS::DataIntegrationCredentialsDto)) }
+    sig { params(value: T.nilable(WorkOS::DataIntegrationCredentialsInput)).returns(T.nilable(WorkOS::DataIntegrationCredentialsInput)) }
     def credentials=(value); end
 
+    sig { returns(T.nilable(WorkOS::ApiKeyInstallation)) }
+    def api_key; end
+
+    sig { params(value: T.nilable(WorkOS::ApiKeyInstallation)).returns(T.nilable(WorkOS::ApiKeyInstallation)) }
+    def api_key=(value); end
+
     sig { returns(T.nilable(WorkOS::UpdateCustomProviderDefinition)) }
     def custom_provider; end
 

data/rbi/workos/user_create_response.rbi

@@ -9,6 +9,90 @@ module WorkOS
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 
+    sig { returns(String) }
+    def object; end
+
+    sig { params(value: String).returns(String) }
+    def object=(value); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def first_name; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def first_name=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def last_name; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def last_name=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def name; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def name=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def profile_picture_url; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def profile_picture_url=(value); end
+
+    sig { returns(String) }
+    def email; end
+
+    sig { params(value: String).returns(String) }
+    def email=(value); end
+
+    sig { returns(T::Boolean) }
+    def email_verified; end
+
+    sig { params(value: T::Boolean).returns(T::Boolean) }
+    def email_verified=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def external_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def external_id=(value); end
+
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    def metadata; end
+
+    sig { params(value: T.nilable(T::Hash[String, String])).returns(T.nilable(T::Hash[String, String])) }
+    def metadata=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def last_sign_in_at; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def last_sign_in_at=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def locale; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def locale=(value); end
+
+    sig { returns(String) }
+    def created_at; end
+
+    sig { params(value: String).returns(String) }
+    def created_at=(value); end
+
+    sig { returns(String) }
+    def updated_at; end
+
+    sig { params(value: String).returns(String) }
+    def updated_at=(value); end
+
     sig { returns(T.nilable(String)) }
     def radar_auth_attempt_id; end
 

data/rbi/workos/user_management.rbi

@@ -82,6 +82,14 @@ module WorkOS
     end
     def create_radar_challenge(user_id:, pending_authentication_token:, phone_number:, ip_address:, user_agent:, request_options:); end
 
+    sig do
+      params(
+        id: String,
+        request_options: T::Hash[Symbol, T.untyped]
+      ).returns(WorkOS::RadarChallenge)
+    end
+    def get_radar_challenge(id:, request_options:); end
+
     sig do
       params(
         session_id: String,
@@ -392,6 +400,14 @@ module WorkOS
     end
     def create_redirect_uri(uri:, request_options:); end
 
+    sig do
+      params(
+        id: String,
+        request_options: T::Hash[Symbol, T.untyped]
+      ).returns(NilClass)
+    end
+    def delete_redirect_uris(id:, request_options:); end
+
     sig do
       params(
         user_id: String,

data/rbi/workos/vault_kek_deleted.rbi

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class VaultKekDeleted
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def object; end
+
+    sig { params(value: String).returns(String) }
+    def object=(value); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(String) }
+    def event; end
+
+    sig { params(value: String).returns(String) }
+    def event=(value); end
+
+    sig { returns(WorkOS::VaultKekDeletedData) }
+    def data; end
+
+    sig { params(value: WorkOS::VaultKekDeletedData).returns(WorkOS::VaultKekDeletedData) }
+    def data=(value); end
+
+    sig { returns(String) }
+    def created_at; end
+
+    sig { params(value: String).returns(String) }
+    def created_at=(value); end
+
+    sig { returns(T.nilable(WorkOS::EventContext)) }
+    def context; end
+
+    sig { params(value: T.nilable(WorkOS::EventContext)).returns(T.nilable(WorkOS::EventContext)) }
+    def context=(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/vault_kek_deleted_data.rbi

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class VaultKekDeletedData
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def actor_id; end
+
+    sig { params(value: String).returns(String) }
+    def actor_id=(value); end
+
+    sig { returns(String) }
+    def actor_source; end
+
+    sig { params(value: String).returns(String) }
+    def actor_source=(value); end
+
+    sig { returns(String) }
+    def actor_name; end
+
+    sig { params(value: String).returns(String) }
+    def actor_name=(value); end
+
+    sig { returns(String) }
+    def key_name; end
+
+    sig { params(value: String).returns(String) }
+    def key_name=(value); end
+
+    sig { returns(String) }
+    def key_id; end
+
+    sig { params(value: String).returns(String) }
+    def key_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/widget_session_token.rbi

@@ -9,10 +9,10 @@ module WorkOS
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 
-    sig { returns(String) }
+    sig { returns(T.nilable(String)) }
     def organization_id; end
 
-    sig { params(value: String).returns(String) }
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def organization_id=(value); end
 
     sig { returns(T.nilable(String)) }

data/rbi/workos/widgets.rbi

@@ -11,7 +11,7 @@ module WorkOS
 
     sig do
       params(
-        organization_id: String,
+        organization_id: T.nilable(String),
         user_id: T.nilable(String),
         scopes: T.nilable(T::Array[String]),
         request_options: T::Hash[Symbol, T.untyped]

data/test/workos/test_agents.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "test_helper"
+
+class AgentsTest < Minitest::Test
+  include FixtureHelper
+
+  def setup
+    @client = WorkOS::Client.new(api_key: "sk_test_123")
+  end
+
+  def test_update_attempts_returns_expected_result
+    stub_request(:patch, %r{\Ahttps://api\.workos\.com/agents/claims/attempts(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.agents.update_attempts(type: "link_external_user", claim_attempt_token: "stub", user: {})
+    refute_nil result
+  end
+
+  def test_create_validate_returns_expected_result
+    stub_request(:post, %r{\Ahttps://api\.workos\.com/agents/credentials/validate(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.agents.create_validate(type: "stub", credential: "stub")
+    refute_nil result
+  end
+
+  def test_get_registration_returns_expected_result
+    stub_request(:get, %r{\Ahttps://api\.workos\.com/agents/registrations/stub(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.agents.get_registration(id: "stub")
+    refute_nil result
+  end
+
+  # Parameterized authentication error tests (one per endpoint).
+  [
+    {name: :update_attempts, verb: :patch, url: %r{\Ahttps://api\.workos\.com/agents/claims/attempts(\?|\z)}, args: {type: "link_external_user", claim_attempt_token: "stub", user: {}}},
+    {name: :create_validate, verb: :post, url: %r{\Ahttps://api\.workos\.com/agents/credentials/validate(\?|\z)}, args: {type: "stub", credential: "stub"}},
+    {name: :get_registration, verb: :get, url: %r{\Ahttps://api\.workos\.com/agents/registrations/stub(\?|\z)}, args: {id: "stub"}}
+  ].each do |spec|
+    define_method("test_#{spec[:name]}_raises_authentication_error_on_401") do
+      stub_request(spec[:verb], spec[:url])
+        .to_return(body: '{"message": "Unauthorized"}', status: 401)
+      assert_raises(WorkOS::AuthenticationError) do
+        @client.agents.send(spec[:name], **(spec[:args] || {}))
+      end
+    end
+  end
+end

data/test/workos/test_agents_model_round_trip.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "test_helper"
+
+class AgentsModelRoundTripTest < Minitest::Test
+  def test_agent_registration_round_trip
+    fixture = {
+      "id" => "stub",
+      "agent_identity" => {},
+      "organization_id" => "stub",
+      "status" => "stub",
+      "kind" => "stub",
+      "claim" => nil,
+      "created_at" => "stub",
+      "updated_at" => "stub"
+    }
+    model = WorkOS::AgentRegistration.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_equal fixture["organization_id"], json[:organization_id]
+    assert_equal fixture["created_at"], json[:created_at]
+    assert_equal fixture["updated_at"], json[:updated_at]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_credential_validation_round_trip
+    fixture = {
+      "valid" => true,
+      "registration_id" => nil,
+      "expires_at" => nil
+    }
+    model = WorkOS::AgentCredentialValidation.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["valid"], json[:valid]
+    assert_nil json[:registration_id]
+    assert_nil json[:expires_at]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_claim_view_response_round_trip
+    fixture = {
+      "id" => "stub",
+      "status" => "stub",
+      "user_code" => "stub",
+      "organizations" => []
+    }
+    model = WorkOS::ClaimViewResponse.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_equal fixture["user_code"], json[:user_code]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_claim_view_response_organization_round_trip
+    fixture = {
+      "id" => "stub",
+      "name" => "stub"
+    }
+    model = WorkOS::ClaimViewResponseOrganization.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_equal fixture["name"], json[:name]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_registration_agent_identity_round_trip
+    fixture = {
+      "id" => "stub",
+      "userland_user_id" => nil,
+      "created_at" => "stub",
+      "updated_at" => "stub"
+    }
+    model = WorkOS::AgentRegistrationAgentIdentity.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_nil json[:userland_user_id]
+    assert_equal fixture["created_at"], json[:created_at]
+    assert_equal fixture["updated_at"], json[:updated_at]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_registration_claim_round_trip
+    fixture = {
+      "id" => "stub",
+      "claim_completion" => nil,
+      "created_at" => "stub",
+      "updated_at" => "stub",
+      "expires_at" => "stub"
+    }
+    model = WorkOS::AgentRegistrationClaim.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_equal fixture["created_at"], json[:created_at]
+    assert_equal fixture["updated_at"], json[:updated_at]
+    assert_equal fixture["expires_at"], json[:expires_at]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_admin_link_claim_attempt_to_external_user_request_round_trip
+    fixture = {
+      "type" => "link_external_user",
+      "claim_attempt_token" => "stub",
+      "user" => {},
+      "organization_id" => "stub"
+    }
+    model = WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequest.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["claim_attempt_token"], json[:claim_attempt_token]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_admin_link_claim_attempt_to_external_user_request_user_round_trip
+    fixture = {
+      "email" => "stub",
+      "external_id" => "stub"
+    }
+    model = WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequestUser.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["email"], json[:email]
+    assert_equal fixture["external_id"], json[:external_id]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_admin_validate_credential_request_round_trip
+    fixture = {
+      "type" => "stub",
+      "credential" => "stub",
+      "audience" => "stub"
+    }
+    model = WorkOS::AgentAdminValidateCredentialRequest.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["credential"], json[:credential]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+
+  def test_agent_registration_claim_claim_completion_round_trip
+    fixture = {
+      "id" => "stub",
+      "created_at" => "stub",
+      "updated_at" => "stub",
+      "expires_at" => "stub",
+      "claimed_at" => "stub"
+    }
+    model = WorkOS::AgentRegistrationClaimClaimCompletion.new(fixture.to_json)
+    json = model.to_h
+    assert_kind_of Hash, json
+    assert_equal fixture["id"], json[:id]
+    assert_equal fixture["created_at"], json[:created_at]
+    assert_equal fixture["updated_at"], json[:updated_at]
+    assert_equal fixture["expires_at"], json[:expires_at]
+    assert_equal fixture["claimed_at"], json[:claimed_at]
+    fixture.each_key { |k| assert json.key?(k.to_sym) || json.key?(k), "Expected to_h to include key #{k}" }
+  end
+end