Class UserResource

Resource for managing users in the organization.

Index

Constructors

Methods

create createUser delete deleteUser getModel getUserModel getUsers list update updateUser

Constructors

constructor

new UserResource(c: AmigoFetch, orgId: OrgId): UserResource
Parameters
- c: AmigoFetch
- orgId: OrgId
Returns UserResource
- Defined in resources/user.ts:8

Methods

create

create(body: {}, headers?: {}): Promise<{}>
Alias for createUser.
Parameters
- body: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:91

createUser

createUser(body: {}, headers?: {}): Promise<{}>
Create (invite) a new user to the organization.
Parameters
- body: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:27

delete

delete(userId: UserId, headers?: {}): Promise<void>
Alias for deleteUser.
Parameters
- userId: UserId
- Optionalheaders: {}
Returns Promise<void>
- Defined in resources/user.ts:104

deleteUser

deleteUser(userId: UserId, headers?: {}): Promise<void>
Delete a user by ID.
Parameters
- userId: UserId
- Optionalheaders: {}
Returns Promise<void>
- Defined in resources/user.ts:41

getModel

getModel(userId: UserId, headers?: {}): Promise<{}>
Alias for getUserModel.
Parameters
- userId: UserId
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:99

getUserModel

getUserModel(userId: UserId, headers?: {}): Promise<{}>
Get the user model for a user.
Parameters
- userId: UserId
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:68

getUsers

getUsers(queryParams?: {}, headers?: {}): Promise<{}>
List users in the organization.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:14

list

list(queryParams?: {}, headers?: {}): Promise<{}>
Alias for getUsers.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/user.ts:83

update

update(options: { body: {}; headers?: {}; userId: UserId }): Promise<void>
Alias for updateUser.
Parameters
- options: { body: {}; headers?: {}; userId: UserId }
Returns Promise<void>
- Defined in resources/user.ts:112

updateUser

updateUser(options: { body: {}; headers?: {}; userId: UserId }): Promise<void>
Update user information.
Parameters
- options: { body: {}; headers?: {}; userId: UserId }
Returns Promise<void>
- Defined in resources/user.ts:53