Class UsersClient

User account CRUD and the user→organizations read.

Index

Constructors

Methods

create delete get listOrganizations update

Constructors

constructor

new UsersClient(call: Caller): UsersClient
Parameters
- call: Caller
Returns UsersClient
- Defined in src/resources/users.ts:33

Methods

create

create(req: CreateUserRequest, opts?: RequestOptions): Promise<UserRegistration>
Register a user. Public route — sent without authentication.
Parameters
- req: CreateUserRequest
- Optionalopts: RequestOptions
Returns Promise<UserRegistration>
- Defined in src/resources/users.ts:36

delete

delete(req: DeleteUserRequest, opts?: RequestOptions): Promise<void>
Delete a user account.
Parameters
- req: DeleteUserRequest
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:74

get

get(email: string, opts?: RequestOptions): Promise<UserData>
Fetch a user by email.
Parameters
- email: string
- Optionalopts: RequestOptions
Returns Promise<UserData>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:53

listOrganizations

listOrganizations(
params: { email: string },
opts?: RequestOptions,
): Promise<OrganizationData[]>
List the organizations the user is a member of.
Parameters
- params: { email: string }
- Optionalopts: RequestOptions
Returns Promise<OrganizationData[]>
- Defined in src/resources/users.ts:82

update

update(req: UpdateUserRequest, opts?: RequestOptions): Promise<UserData>
Update a user; returns the updated row.
Parameters
- req: UpdateUserRequest
- Optionalopts: RequestOptions
Returns Promise<UserData>
Throws
NotFoundError if the user does not exist.
- Defined in src/resources/users.ts:62