Class UserService

User service

Hierarchy (View Summary)

BaseService
- UserService

Index

Constructors

Properties

apiClient axiosInstance

Methods

create delete get list resendVerificationEmail update

Constructors

constructor

new UserService(apiClient: Client): UserService
Constructor
Parameters
- apiClient: Client
  API client
Returns UserService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

create

create(user: UserCreate): Promise<EmailSentResponse>
Create a new user
Parameters
- user: UserCreate
  User to create
Returns Promise<EmailSentResponse>
Email sent response
- Defined in services/Security/UserService.ts:48

delete

delete(id: number): Promise<void>
Delete the user
Parameters
- id: number
  User ID
Returns Promise<void>
- Defined in services/Security/UserService.ts:81

get

get(id: number): Promise<UserInfo>
Retrieve information about the user
Parameters
- id: number
  User ID
Returns Promise<UserInfo>
User information
- Defined in services/Security/UserService.ts:59

list

list(): Promise<UserInfo[]>
Retrieve a list of all users

Returns Promise<UserInfo[]>
List of all users
- Defined in services/Security/UserService.ts:37

resendVerificationEmail

resendVerificationEmail(id: number): Promise<void>
Resend the verification email
Parameters
- id: number
  User ID
Returns Promise<void>
- Defined in services/Security/UserService.ts:89

update

update(id: number, user: UserEdit): Promise<EmailSentResponse>
Update the user
Parameters
- id: number
  User ID
- user: UserEdit
  User to edit
Returns Promise<EmailSentResponse>
Email sent response
- Defined in services/Security/UserService.ts:71