Class: Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb,
sig/anthropic/models/beta/beta_user_profile_external_user_details_params.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: nil, country: nil, email_hash: nil, entity_type: nil, name_hash: nil, onboarded_at: nil, reference_id: nil) ⇒ Object

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

Parameters:

  • account_status (Symbol, Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams::AccountStatus, nil) (defaults to: nil) —

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

  • country (String, nil) (defaults to: nil) —

    The country of the entity (not of the platform), as the platform determines it:

  • email_hash (String, nil) (defaults to: nil) —

    A hash of the entity's email address, computed by the platform. Anthropic treats

  • entity_type (Symbol, Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams::EntityType, nil) (defaults to: nil) —

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

  • name_hash (String, nil) (defaults to: nil) —

    A hash of the entity's name, computed by the platform. Anthropic treats it as an

  • onboarded_at (Time) (defaults to: nil) —

    A timestamp in RFC 3339 format

  • reference_id (String, nil) (defaults to: nil) —

    The platform's own reference for the entity, for example the key of the end-user




# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 65

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:

  • value (Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams::account_status, nil)

Returns:



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

optional :account_status,
enum: -> { Anthropic::Beta::BetaUserProfileExternalUserDetailsParams::AccountStatus },
nil?: true

#country ⇒ String?

The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example US. Only the form, two uppercase ASCII letters, is checked.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


25
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 25

optional :country, String, nil?: true

#email_hash ⇒ String?

A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


33
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 33

optional :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:

  • value (Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams::entity_type, nil)

Returns:



40
41
42
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 40

optional :entity_type,
enum: -> { Anthropic::Beta::BetaUserProfileExternalUserDetailsParams::EntityType },
nil?: true

#name_hash ⇒ String?

A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


49
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 49

optional :name_hash, String, nil?: true

#onboarded_at ⇒ Time?

A timestamp in RFC 3339 format

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


55
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 55

optional :onboarded_at, Time

#reference_id ⇒ String?

The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


63
 
# File 'lib/anthropic/models/beta/beta_user_profile_external_user_details_params.rb', line 63

optional :reference_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/anthropic/models/beta/beta_user_profile_external_user_details_params.rbs', line 44

def to_hash: -> {