Class: HubSpotSDK::Models::Settings::UserProvisionRequest

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

Direct Known Subclasses

UserCreateParams

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

Parameters:

  • email (String) —

    The user’s email.

  • send_welcome_email (Boolean) —

    Whether to send a welcome email.

  • 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.




# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 49

Instance Attribute Details

#email ⇒ String

The user’s email.

Returns:

  • (String) 


11
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 11

required :email, String

#first_name ⇒ String?

The user’s first name.

Returns:

  • (String, nil) 


23
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 23

optional :first_name, String, api_name: :firstName

#last_name ⇒ String?

The user’s last name.

Returns:

  • (String, nil) 


29
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 29

optional :last_name, String, api_name: :lastName

#primary_team_id ⇒ String?

The user’s primary team.

Returns:

  • (String, nil) 


35
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 35

optional :primary_team_id, String, api_name: :primaryTeamId

#role_id ⇒ String?

The user’s role.

Returns:

  • (String, nil) 


41
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 41

optional :role_id, String, api_name: :roleId

#secondary_team_ids ⇒ Array<String>?

The user’s additional teams.

Returns:

  • (Array<String>, nil) 


47
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 47

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

#send_welcome_email ⇒ Boolean

Whether to send a welcome email.

Returns:

  • (Boolean) 


17
 
# File 'lib/hubspot_sdk/models/settings/user_provision_request.rb', line 17

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