Struct UsersService 

pub struct UsersService { /* private fields */ }

Available on crate feature users only.

Typed access to the users API v2 surface (7 operations). Obtained via Ghl::users.

Implementations

impl UsersService

pub async fn get_user_by_location( &self, params: &GetUserByLocationParams, ) -> Result<LocationSuccessfulResponseDto>

Get User by Location

Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed.

GET /users/

Requires scope: users.readonly.

pub async fn create_user( &self, body: &CreateUserDto, ) -> Result<UserSuccessfulResponseDto>

Create User

POST /users/

Requires scope: users.write.

pub async fn search_users( &self, params: &SearchUsersParams, ) -> Result<SearchUserSuccessfulResponseDto>

Search Users

GET /users/search

Requires scope: users.readonly.

pub async fn filter_users_by_email( &self, body: &FilterByEmailDto, ) -> Result<SearchUserSuccessfulResponseDto>

Filter Users by Email

Filter users by company ID, deleted status, and email array

POST /users/search/filter-by-email

Requires scope: users.readonly.

pub async fn delete_user( &self, user_id: &str, ) -> Result<DeleteUserSuccessfulResponseDto>

Delete User

DELETE /users/{userId}

Requires scope: users.write.

pub async fn get_user(&self, user_id: &str) -> Result<UserSuccessfulResponseDto>

Get User

GET /users/{userId}

Requires scope: users.readonly.

pub async fn update_user( &self, user_id: &str, body: &UpdateUserDto, ) -> Result<UserSuccessfulResponseDto>

Update User

PUT /users/{userId}

Requires scope: users.write.

Trait Implementations

impl Clone for UsersService

fn clone(&self) -> UsersService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UsersService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.