Class UsersClient

Hierarchy

GhlClient
- UsersClient

Index

Constructors

Methods

findById update remove findByLocation create search

Constructors

constructor

new UsersClient(accessToken: string): UsersClient
Parameters
- accessToken: string
Returns UsersClient
Overrides GhlClient.constructor
- Defined in users/users.client.ts:13

Methods

findById

findById(userId: string): Promise<User>
Parameters
- userId: string
Returns Promise<User>
- Defined in users/users.client.ts:17

update

update(userId: string, dto: UpdateUserDto): Promise<User>
Parameters
- userId: string
- dto: UpdateUserDto
Returns Promise<User>
- Defined in users/users.client.ts:21

remove

remove(userId: string): Promise<DeleteUserResponse>
Parameters
- userId: string
Returns Promise<DeleteUserResponse>
- Defined in users/users.client.ts:25

findByLocation

findByLocation(locationId: string): Promise<ListUsersResponse>
Parameters
- locationId: string
Returns Promise<ListUsersResponse>
- Defined in users/users.client.ts:29

create

create(dto: CreateUserDto): Promise<User>
Parameters
- dto: CreateUserDto
Returns Promise<User>
- Defined in users/users.client.ts:33

search

search(params: UserSearchParams): Promise<SearchUsersResponse>
Parameters
- params: UserSearchParams
Returns Promise<SearchUsersResponse>
- Defined in users/users.client.ts:37