Class UserApi

Service that exposes the user domain.

Represents the UserAPi class that provides methods for listing/creating/updating/deleting users.

Index

Constructors

Methods

createUser deleteUser getPositioningApikeys getUserById getUsers patchUser

Constructors

constructor

new UserApi(apiBase: ApiBase): UserApi
Parameters
- apiBase: ApiBase
Returns UserApi
- Defined in domains/user.ts:22

Methods

createUser

createUser(userForm: UserForm): Promise<User>
Creates a new user.
Parameters
- userForm: UserForm
  The user form containing the user information.
Returns Promise<User>
A promise that resolves with the created user.
- Defined in domains/user.ts:82

deleteUser

deleteUser(userId: string): Promise<unknown>
Deletes a user based on the provided userId.
Parameters
- userId: string
  The ID of the user to delete.
Returns Promise<unknown>
A promise that resolves after deleting the user.
- Defined in domains/user.ts:97

getPositioningApikeys

getPositioningApikeys(): Promise<Apikey[]>
Retrieves a list of 'positioning' apikeys attached to current user.

Returns Promise<Apikey[]>
A promise that resolves with apikeys array.
- Defined in domains/user.ts:106

getUserById

getUserById(userId: string): Promise<User>
Retrieves a user by their ID.
Parameters
- userId: string
  The ID of the user to retrieve.
Returns Promise<User>
A promise that resolves with the user data.
- Defined in domains/user.ts:52

getUsers

getUsers(searchUser?: UserSearch): Promise<Paginated<User>>
Retrieves a list of users based on the search criteria.
Parameters
- OptionalsearchUser: UserSearch
  Optional search criteria for filtering users.
Returns Promise<Paginated<User>>
A promise that resolves with paginated user data.
- Defined in domains/user.ts:32

patchUser

patchUser(userId: string, userForm: UserForm): Promise<User>
Sends a PUT request to update a user based on the provided userId and userForm.
Parameters
- userId: string
  The unique identifier of the user to be updated.
- userForm: UserForm
  The form containing the updated user information.
Returns Promise<User>
A promise that resolves with the updated user data.
- Defined in domains/user.ts:67