Class: Anthropic::Models::Beta::BetaUserProfileExternalUserDetails

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

Defined Under Namespace

Modules: AccountStatus, EntityType

Instance Attribute Summary collapse

Class Method 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(account_status:, country:, email_hash:, entity_type:, name_hash:, onboarded_at:, reference_id:) ⇒ void

Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, null until the platform supplies a value.

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

Parameters:

  • The status of the entity's account on the platform, as the platform states it: `

  • The country the platform associates with the entity, as an ISO 3166-1 alpha-2 co

  • The platform-computed hash of the entity's email address. null until the platf

  • What kind of entity the profile represents, as the platform states it: `individu

  • The platform-computed hash of the entity's name. null until the platform suppl

  • A timestamp in RFC 3339 format

  • The platform's own reference for the entity. null until the platform supplies




# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 62

Instance Attribute Details

#account_status ⇒ Symbol, ...

The status of the entity's account on the platform, as the platform states it: active; suspended, when the platform has restricted the account and may restore it; or blocked, when the platform has barred it. It records the platform's decision only; the statuses in trust_grants are Anthropic's and do not follow it.

Parameters:

Returns:



15
16
17
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 15

required :account_status,
enum: -> { Anthropic::Beta::BetaUserProfileExternalUserDetails::AccountStatus },
nil?: true

#country ⇒ String?

The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. null until the platform supplies one.

Parameters:

Returns:



24
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 24

required :country, String, nil?: true

#email_hash ⇒ String?

The platform-computed hash of the entity's email address. null until the platform supplies one.

Parameters:

Returns:



31
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 31

required :email_hash, String, nil?: true

#entity_type ⇒ Symbol, ...

What kind of entity the profile represents, as the platform states it: individual, business, non_profit or government.

Parameters:

Returns:



38
39
40
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 38

required :entity_type,
enum: -> { Anthropic::Beta::BetaUserProfileExternalUserDetails::EntityType },
nil?: true

#name_hash ⇒ String?

The platform-computed hash of the entity's name. null until the platform supplies one.

Parameters:

Returns:



47
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 47

required :name_hash, String, nil?: true

#onboarded_at ⇒ Time?

A timestamp in RFC 3339 format

Parameters:

Returns:



53
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 53

required :onboarded_at, Time, nil?: true

#reference_id ⇒ String?

The platform's own reference for the entity. null until the platform supplies one.

Parameters:

Returns:



60
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 60

required :reference_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:




# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details.rb', line 98

Instance Method Details

#to_hash ⇒ {

Returns:



42
 
# File 'sig/anthropic/models/beta/beta_user_profile_external_user_details.rbs', line 42

def to_hash: -> {