workos 9.5.1 → 10.3.0

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")
@@ -26,6 +37,7 @@ loader.collapse("#{__dir__}/workos/organization_membership")
 loader.collapse("#{__dir__}/workos/organizations")
 loader.collapse("#{__dir__}/workos/pipes")
 loader.collapse("#{__dir__}/workos/pipes_provider")
+loader.collapse("#{__dir__}/workos/platform_teams")
 loader.collapse("#{__dir__}/workos/radar")
 loader.collapse("#{__dir__}/workos/shared")
 loader.collapse("#{__dir__}/workos/sso")

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/agent_blueprint.rbi

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprint
+    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 name; end
+
+    sig { params(value: String).returns(String) }
+    def name=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def description; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def description=(value); end
+
+    sig { returns(T::Array[String]) }
+    def permissions; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def permissions=(value); end
+
+    sig { returns(WorkOS::AgentBlueprintInvocableBy) }
+    def invocable_by; end
+
+    sig { params(value: WorkOS::AgentBlueprintInvocableBy).returns(WorkOS::AgentBlueprintInvocableBy) }
+    def invocable_by=(value); end
+
+    sig { returns(WorkOS::AgentBlueprintSessionSetting) }
+    def session_settings; end
+
+    sig { params(value: WorkOS::AgentBlueprintSessionSetting).returns(WorkOS::AgentBlueprintSessionSetting) }
+    def session_settings=(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_blueprint_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 AgentBlueprintCreated
+    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::AgentBlueprintCreatedData) }
+    def data; end
+
+    sig { params(value: WorkOS::AgentBlueprintCreatedData).returns(WorkOS::AgentBlueprintCreatedData) }
+    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_blueprint_created_data.rbi

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintCreatedData
+    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 name; end
+
+    sig { params(value: String).returns(String) }
+    def name=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def description; end
+
+    sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
+    def description=(value); end
+
+    sig { returns(T::Array[String]) }
+    def permissions; end
+
+    sig { params(value: T::Array[String]).returns(T::Array[String]) }
+    def permissions=(value); end
+
+    sig { returns(WorkOS::AgentBlueprintCreatedDataInvocableBy) }
+    def invocable_by; end
+
+    sig { params(value: WorkOS::AgentBlueprintCreatedDataInvocableBy).returns(WorkOS::AgentBlueprintCreatedDataInvocableBy) }
+    def invocable_by=(value); end
+
+    sig { returns(WorkOS::AgentBlueprintCreatedDataSessionSetting) }
+    def session_settings; end
+
+    sig { params(value: WorkOS::AgentBlueprintCreatedDataSessionSetting).returns(WorkOS::AgentBlueprintCreatedDataSessionSetting) }
+    def session_settings=(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_blueprint_created_data_invocable_by.rbi

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+# typed: strong
+
+module WorkOS
+  class AgentBlueprintCreatedDataSessionSetting
+    sig { params(json: T.any(String, T::Hash[Symbol, T.untyped])).void }
+    def initialize(json); end
+
+    sig { returns(Float) }
+    def max_age_seconds; end
+
+    sig { params(value: Float).returns(Float) }
+    def max_age_seconds=(value); end
+
+    sig { returns(Float) }
+    def access_token_ttl_seconds; end
+
+    sig { params(value: Float).returns(Float) }
+    def access_token_ttl_seconds=(value); end
+
+    sig { returns(Float) }
+    def refresh_token_ttl_seconds; end
+
+    sig { params(value: Float).returns(Float) }
+    def refresh_token_ttl_seconds=(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_blueprint_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 AgentBlueprintDeleted
+    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::AgentBlueprintDeletedData) }
+    def data; end
+
+    sig { params(value: WorkOS::AgentBlueprintDeletedData).returns(WorkOS::AgentBlueprintDeletedData) }
+    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_blueprint_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 AgentBlueprintDeletedData
+    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 name; end
+
+    sig { params(value: String).returns(String) }
+    def name=(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_blueprint_invocable_by.rbi

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

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

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