Class: HubSpotSDK::Resources::Settings::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/settings/users.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Users

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Users.

Parameters:



191
192
193
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 191

def initialize(client:)
  @client = client
end

Instance Method Details

#create(email:, send_welcome_email:, first_name: nil, last_name: nil, primary_team_id: nil, role_id: nil, secondary_team_ids: nil, request_options: {}) ⇒ HubSpotSDK::Models::Settings::PublicUser

Parameters:

  • email (String) —

    The user’s email.

  • send_welcome_email (Boolean) —

    Whether to send a welcome email.

  • first_name (String) —

    The user’s first name.

  • last_name (String) —

    The user’s last name.

  • primary_team_id (String) —

    The user’s primary team.

  • role_id (String) —

    The user’s role.

  • secondary_team_ids (Array<String>) —

    The user’s additional teams.

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 28

def create(params)
  parsed, options = HubSpotSDK::Settings::UserCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "settings/users/2026-03",
    body: parsed,
    model: HubSpotSDK::Settings::PublicUser,
    options: options
  )
end

#delete(user_id, id_property: nil, request_options: {}) ⇒ nil

Removes a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

Returns:

  • (nil)

See Also:



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 116

def delete(user_id, params = {})
  parsed, options = HubSpotSDK::Settings::UserDeleteParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :delete,
    path: ["settings/users/2026-03/%1$s", user_id],
    query: query.transform_keys(id_property: "idProperty"),
    model: NilClass,
    options: options
  )
end

#get(user_id, id_property: nil, request_options: {}) ⇒ HubSpotSDK::Models::Settings::PublicUser

Retrieves a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

Returns:

See Also:



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 140

def get(user_id, params = {})
  parsed, options = HubSpotSDK::Settings::UserGetParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["settings/users/2026-03/%1$s", user_id],
    query: query.transform_keys(id_property: "idProperty"),
    model: HubSpotSDK::Settings::PublicUser,
    options: options
  )
end

#list(after: nil, limit: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Settings::PublicUser>

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

Parameters:

  • after (String) —

    The paging cursor token of the last successfully read resource will be returned

  • limit (Integer) —

    The maximum number of results to display per page.

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 91

def list(params = {})
  parsed, options = HubSpotSDK::Settings::UserListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "settings/users/2026-03",
    query: query,
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Settings::PublicUser,
    options: options
  )
end

#list_roles(request_options: {}) ⇒ HubSpotSDK::Models::Settings::CollectionResponsePublicPermissionSetNoPaging

Retrieves the roles on an account

Parameters:

Returns:

See Also:



161
162
163
164
165
166
167
168
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 161

def list_roles(params = {})
  @client.request(
    method: :get,
    path: "settings/users/2026-03/roles",
    model: HubSpotSDK::Settings::CollectionResponsePublicPermissionSetNoPaging,
    options: params[:request_options]
  )
end

#list_teams(request_options: {}) ⇒ HubSpotSDK::Models::Settings::CollectionResponsePublicTeamNoPaging

View teams for this account

Parameters:

Returns:

See Also:



179
180
181
182
183
184
185
186
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 179

def list_teams(params = {})
  @client.request(
    method: :get,
    path: "settings/users/2026-03/teams",
    model: HubSpotSDK::Settings::CollectionResponsePublicTeamNoPaging,
    options: params[:request_options]
  )
end

#update(user_id, id_property: nil, first_name: nil, last_name: nil, primary_team_id: nil, role_id: nil, secondary_team_ids: nil, request_options: {}) ⇒ HubSpotSDK::Models::Settings::PublicUser

Modifies a user identified by ‘userId`. `userId` refers to the user’s ID by default, or optionally email as specified by the ‘IdProperty` query param.

Parameters:

  • user_id (String) —

    Path param

  • id_property (Symbol, HubSpotSDK::Models::Settings::PublicUserUpdate::IDProperty) —

    Query param

  • first_name (String) —

    Body param: The first name of the user.

  • last_name (String) —

    Body param: The last name of the user.

  • primary_team_id (String) —

    Body param: The user’s primary team.

  • role_id (String) —

    Body param: The user’s role.

  • secondary_team_ids (Array<String>) —

    Body param: The user’s additional teams.

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/hubspot_sdk/resources/settings/users.rb', line 63

def update(user_id, params = {})
  query_params = [:id_property]
  parsed, options = HubSpotSDK::Settings::UserUpdateParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :put,
    path: ["settings/users/2026-03/%1$s", user_id],
    query: query.transform_keys(id_property: "idProperty"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::Settings::PublicUser,
    options: options
  )
end