Class: HubSpotSDK::Models::Settings::PublicUser

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/settings/public_user.rb

Overview

See Also:

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(id:, email:, role_ids:, super_admin:, first_name: nil, last_name: nil, primary_team_id: nil, role_id: nil, secondary_team_ids: nil, send_welcome_email: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Settings::PublicUser for more details.

Parameters:

  • id (String) —

    The user’s unique ID.

  • email (String) —

    The user’s email.

  • role_ids (Array<String>) —

    A list of role IDs assigned to the user.

  • super_admin (Boolean) —

    Whether the user has super admin privileges.

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

    The user’s first name.

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

    The user’s last name.

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

    The user’s primary team

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

    The user’s role.

  • secondary_team_ids (Array<String>) (defaults to: nil) —

    The user’s additional teams.

  • send_welcome_email (Boolean) (defaults to: nil) —

    Whether a welcome email was sent to the user. This value will only be populated




# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 69

Instance Attribute Details

#email ⇒ String

The user’s email.

Returns:

  • (String) 


18
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 18

required :email, String

#first_name ⇒ String?

The user’s first name.

Returns:

  • (String, nil) 


36
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 36

optional :first_name, String, api_name: :firstName

#id ⇒ String

The user’s unique ID.

Returns:

  • (String) 


12
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 12

required :id, String

#last_name ⇒ String?

The user’s last name.

Returns:

  • (String, nil) 


42
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 42

optional :last_name, String, api_name: :lastName

#primary_team_id ⇒ String?

The user’s primary team

Returns:

  • (String, nil) 


48
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 48

optional :primary_team_id, String, api_name: :primaryTeamId

#role_id ⇒ String?

The user’s role.

Returns:

  • (String, nil) 


54
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 54

optional :role_id, String, api_name: :roleId

#role_ids ⇒ Array<String>

A list of role IDs assigned to the user.

Returns:

  • (Array<String>) 


24
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 24

required :role_ids, HubSpotSDK::Internal::Type::ArrayOf[String], api_name: :roleIds

#secondary_team_ids ⇒ Array<String>?

The user’s additional teams.

Returns:

  • (Array<String>, nil) 


60
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 60

optional :secondary_team_ids, HubSpotSDK::Internal::Type::ArrayOf[String], api_name: :secondaryTeamIds

#send_welcome_email ⇒ Boolean?

Whether a welcome email was sent to the user. This value will only be populated in response to a provisioning request. Subsequent queries will be false.

Returns:

  • (Boolean, nil) 


67
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 67

optional :send_welcome_email, HubSpotSDK::Internal::Type::Boolean, api_name: :sendWelcomeEmail

#super_admin ⇒ Boolean

Whether the user has super admin privileges.

Returns:

  • (Boolean) 


30
 
# File 'lib/hubspot_sdk/models/settings/public_user.rb', line 30

required :super_admin, HubSpotSDK::Internal::Type::Boolean, api_name: :superAdmin