Class: Anthropic::Models::Beta::Organization::BetaAnalyticsUserActor

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb,
sig/anthropic/models/beta/organization/beta_analytics_user_actor.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(deleted:, email_address:, name:, user_id:, type: :user_actor) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::Organization::BetaAnalyticsUserActor for more details.

Parameters:

  • deleted (Boolean) —

    True when the account has been deleted, or when the user is no longer a member o

  • email_address (String, nil) —

    The user's email address, including for users who are no longer members of the o

  • name (String, nil) —

    The user's full name. Null when the user has not set a name. Returns `"Deleted U

  • user_id (String) —

    Tagged user ID.

  • type (Symbol, :user_actor) (defaults to: :user_actor) —

    Actor type. Always "user_actor".



# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 52

Instance Attribute Details

#deleted ⇒ Boolean

True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). email_address stays populated for removed users and is null when the account has been deleted. name follows the rules described on that field. The user_id is still populated for reconciliation.

Parameters:

Returns:



17
# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 17

required :deleted, Anthropic::Internal::Type::Boolean

#email_address ⇒ String?

The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check deleted) and for system-minted service accounts, which have no person's mailbox behind them (check name).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil)


26
# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 26

required :email_address, String, nil?: true

#name ⇒ String?

The user's full name. Null when the user has not set a name. Returns "Deleted User" when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, "Claude Security" for usage by Anthropic's security-patching service) or null.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil)


38
# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 38

required :name, String, nil?: true

#type ⇒ Symbol, :user_actor

Actor type. Always "user_actor".

Parameters:

  • value (:user_actor)

Returns:

  • (Symbol, :user_actor)


44
# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 44

required :type, const: :user_actor

#user_id ⇒ String

Tagged user ID.

Parameters:

  • value (String)

Returns:

  • (String)


50
# File 'lib/anthropic/models/beta/organization/beta_analytics_user_actor.rb', line 50

required :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({)


33
# File 'sig/anthropic/models/beta/organization/beta_analytics_user_actor.rbs', line 33

def to_hash: -> {