Class: WhopSDK::Models::UserUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/user_update_params.rb

Overview

See Also:

Defined Under Namespace

Classes: ProfilePicture

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#bio ⇒ String?

A short biography displayed on the user’s public profile.

Returns:

  • (String, nil) 


19
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 19

optional :bio, String, nil?: true

#company_id ⇒ String?

When provided, updates the user’s profile overrides for this company instead of the global profile. Pass name and profile_picture to set overrides, or null to clear them.

Returns:

  • (String, nil) 


27
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 27

optional :company_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 13

required :id, String

#name ⇒ String?

The user’s display name shown on their public profile. Maximum 100 characters.

Returns:

  • (String, nil) 


33
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 33

optional :name, String, nil?: true

#profile_picture ⇒ WhopSDK::Models::UserUpdateParams::ProfilePicture?

The user’s profile picture image attachment.

Returns:



39
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 39

optional :profile_picture, -> { WhopSDK::UserUpdateParams::ProfilePicture }, nil?: true

#username ⇒ String?

The user’s unique username. Alphanumeric characters and hyphens only. Maximum 42 characters.

Returns:

  • (String, nil) 


46
 
# File 'lib/whop_sdk/models/user_update_params.rb', line 46

optional :username, String, nil?: true