Class: Anthropic::Models::Beta::UserProfileUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/user_profile_update_params.rb,
sig/anthropic/models/beta/user_profile_update_params.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::UserProfiles#update

Defined Under Namespace

Modules: AccessType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(user_profile_id:, access_type: nil, external_id: nil, external_user_details: nil, external_user_onboarded_at: nil, metadata: nil, name: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

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

Parameters:

  • user_profile_id (String) —

    The ID of the user profile to update (uprof_...).

  • access_type (Symbol, Anthropic::Models::Beta::UserProfileUpdateParams::AccessType, nil) (defaults to: nil) —

    How the platform uses the API on behalf of the entity this profile represents. `

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

    If present, replaces the stored external_id. Omit to leave unchanged. Maximum 25

  • external_user_details (Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams) (defaults to: nil) —

    Details about the entity this profile represents, as the platform states them. E

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

    A timestamp in RFC 3339 format

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Key-value pairs to merge into the stored metadata. Keys provided overwrite exist

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

    If present, replaces the stored name. Omit to leave unchanged. Maximum 255 chara

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

    Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) (defaults to: nil) —

    Optional header to select the Workspace for this request. The value is a Workspa

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 84

Instance Attribute Details

#access_type ⇒ Symbol, ...

How the platform uses the API on behalf of the entity this profile represents. application: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. passthrough: the platform resells raw inference, and the profile identifies the resold-to company.

Parameters:

  • value (Anthropic::Models::Beta::UserProfileUpdateParams::access_type, nil)

Returns:



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

optional :access_type, enum: -> { Anthropic::Beta::UserProfileUpdateParams::AccessType }, nil?: true

#betas ⇒ Array<Symbol, String, Anthropic::Models::AnthropicBeta>?

Optional header to specify the beta version(s) you want to use.

Returns:



71
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 71

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#external_id ⇒ String?

If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the user-profiles-2026-03-24 and user-profiles-2026-08-18 beta headers; under user-profiles-2026-09-04 send external_user_details.reference_id instead.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 34

optional :external_id, String, nil?: true

#external_user_details ⇒ Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams?

Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and null is rejected. Accepted under the user-profiles-2026-09-04 beta header only.

Returns:



43
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 43

optional :external_user_details, -> { Anthropic::Beta::BetaUserProfileExternalUserDetailsParams }

#external_user_onboarded_at ⇒ Time?

A timestamp in RFC 3339 format

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :external_user_onboarded_at, Time

#metadata ⇒ Hash{Symbol=>String}?

Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


58
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 58

optional :metadata, Anthropic::Internal::Type::HashOf[String]

#name ⇒ String?

If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :name, String, nil?: true

#user_profile_id ⇒ String

The ID of the user profile to update (uprof_...).

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 15

required :user_profile_id, String

#workspace_id ⇒ String?

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Parameters:

  • (String)

Returns:

  • (String, nil) 


82
 
# File 'lib/anthropic/models/beta/user_profile_update_params.rb', line 82

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


67
 
# File 'sig/anthropic/models/beta/user_profile_update_params.rbs', line 67

def to_hash: -> {