Class UserHandler

Index

Constructors

Methods

getActive getByBranch getById list search

Constructors

constructor

new UserHandler(client: KiotVietClient): UserHandler
Parameters
- client: KiotVietClient
Returns UserHandler
- Defined in src/resources/users.ts:5

Methods

getActive

getActive(params?: Omit<UserListParams, "isActive">): Promise<UserListResponse>
Get active users
Parameters
- params: Omit<UserListParams, "isActive"> = {}
  Additional filter parameters (excluding isActive)
Returns Promise<UserListResponse>
- Defined in src/resources/users.ts:29

getByBranch

getByBranch(
branchId: number,
params?: Omit<UserListParams, "branchId">,
): Promise<UserListResponse>
Get users by branch
Parameters
- branchId: number
  The ID of the branch to filter by
- params: Omit<UserListParams, "branchId"> = {}
  Additional filter parameters (excluding branchId)
Returns Promise<UserListResponse>
- Defined in src/resources/users.ts:44

getById

getById(userId: number): Promise<User>
Get a user by their ID
Parameters
- userId: number
  The ID of the user to retrieve
Returns Promise<User>
- Defined in src/resources/users.ts:20

list

list(params?: UserListParams): Promise<UserListResponse>
List users with optional filtering
Parameters
- params: UserListParams = {}
  Filter parameters
Returns Promise<UserListResponse>
- Defined in src/resources/users.ts:11

search

search(
query: string,
params?: Omit<UserListParams, "code" | "name">,
): Promise<UserListResponse>
Search users by name or code
Parameters
- query: string
  Search query (matches against name or code)
- params: Omit<UserListParams, "code" | "name"> = {}
  Additional filter parameters (excluding name and code)
Returns Promise<UserListResponse>
- Defined in src/resources/users.ts:59