workos 9.5.0 → 10.1.0

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.5.0"
+  VERSION = "10.1.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

data/rbi/workos/agent_admin_validate_credential_request.rbi

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentAdminValidateCredentialRequest
+    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 credential; end
+
+    sig { params(value: String).returns(String) }
+    def credential=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def audience; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def audience=(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/{sso_intent_options.rbi → agent_credential_validation.rbi}

@@ -5,21 +5,27 @@
 # typed: strong
 
 module WorkOS
-  class SSOIntentOptions
+  class AgentCredentialValidation
     sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
     def initialize(json); end
 
+    sig { returns(T::Boolean) }
+    def valid; end
+
+    sig { params(value: T::Boolean).returns(T::Boolean) }
+    def valid=(value); end
+
     sig { returns(T.nilable(String)) }
-    def bookmark_slug; end
+    def registration_id; end
 
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
-    def bookmark_slug=(value); end
+    def registration_id=(value); end
 
     sig { returns(T.nilable(String)) }
-    def provider_type; end
+    def expires_at; end
 
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
-    def provider_type=(value); end
+    def expires_at=(value); end
 
     sig { returns(T::Hash[Symbol, T.untyped]) }
     def to_h; end

data/rbi/workos/agent_registration.rbi

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistration
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(WorkOS::AgentRegistrationAgentIdentity) }
+    def agent_identity; end
+
+    sig { params(value: WorkOS::AgentRegistrationAgentIdentity).returns(WorkOS::AgentRegistrationAgentIdentity) }
+    def agent_identity=(value); end
+
+    sig { returns(String) }
+    def organization_id; end
+
+    sig { params(value: String).returns(String) }
+    def organization_id=(value); end
+
+    sig { returns(String) }
+    def status; end
+
+    sig { params(value: String).returns(String) }
+    def status=(value); end
+
+    sig { returns(String) }
+    def kind; end
+
+    sig { params(value: String).returns(String) }
+    def kind=(value); end
+
+    sig { returns(T.nilable(WorkOS::AgentRegistrationClaim)) }
+    def claim; end
+
+    sig { params(value: T.nilable(WorkOS::AgentRegistrationClaim)).returns(T.nilable(WorkOS::AgentRegistrationClaim)) }
+    def claim=(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::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_registration_agent_identity.rbi

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationAgentIdentity
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def userland_user_id; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def userland_user_id=(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::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_registration_claim.rbi

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationClaim
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(value); end
+
+    sig { returns(T.nilable(WorkOS::AgentRegistrationClaimClaimCompletion)) }
+    def claim_completion; end
+
+    sig { params(value: T.nilable(WorkOS::AgentRegistrationClaimClaimCompletion)).returns(T.nilable(WorkOS::AgentRegistrationClaimClaimCompletion)) }
+    def claim_completion=(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 expires_at; end
+
+    sig { params(value: String).returns(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_registration_claim_attempt_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 AgentRegistrationClaimAttemptCreated
+    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::AgentRegistrationClaimAttemptCreatedData) }
+    def data; end
+
+    sig { params(value: WorkOS::AgentRegistrationClaimAttemptCreatedData).returns(WorkOS::AgentRegistrationClaimAttemptCreatedData) }
+    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/agent_registration_claim_attempt_created_data.rbi

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationClaimAttemptCreatedData
+    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 agent_registration_id; end
+
+    sig { params(value: String).returns(String) }
+    def agent_registration_id=(value); end
+
+    sig { returns(String) }
+    def agent_registration_claim_id; end
+
+    sig { params(value: String).returns(String) }
+    def agent_registration_claim_id=(value); end
+
+    sig { returns(String) }
+    def login_hint; end
+
+    sig { params(value: String).returns(String) }
+    def login_hint=(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(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_registration_claim_claim_completion.rbi

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationClaimClaimCompletion
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(String) }
+    def id; end
+
+    sig { params(value: String).returns(String) }
+    def id=(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 expires_at; end
+
+    sig { params(value: String).returns(String) }
+    def expires_at=(value); end
+
+    sig { returns(String) }
+    def claimed_at; end
+
+    sig { params(value: String).returns(String) }
+    def claimed_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_registration_claim_completed.rbi

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationClaimCompleted
+    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::AgentRegistrationClaimCompletedData) }
+    def data; end
+
+    sig { params(value: WorkOS::AgentRegistrationClaimCompletedData).returns(WorkOS::AgentRegistrationClaimCompletedData) }
+    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/agent_registration_claim_completed_data.rbi

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentRegistrationClaimCompletedData
+    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 agent_registration_id; end
+
+    sig { params(value: String).returns(String) }
+    def agent_registration_id=(value); end
+
+    sig { returns(String) }
+    def completed_by_attempt_id; end
+
+    sig { params(value: String).returns(String) }
+    def completed_by_attempt_id=(value); end
+
+    sig { returns(WorkOS::AgentRegistrationClaimCompletedDataClaimedBy) }
+    def claimed_by; end
+
+    sig { params(value: WorkOS::AgentRegistrationClaimCompletedDataClaimedBy).returns(WorkOS::AgentRegistrationClaimCompletedDataClaimedBy) }
+    def claimed_by=(value); end
+
+    sig { returns(String) }
+    def completed_at; end
+
+    sig { params(value: String).returns(String) }
+    def completed_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(T::Hash[Symbol, T.untyped]) }
+    def to_h; end
+
+    sig { params(args: T.untyped).returns(String) }
+    def to_json(*args); end
+  end
+end