Class UserAPI

Hierarchy

APIBase
- UserAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey deleteUser invite retrieveUser retrieveUserByOption retrieveUsers setApiAuthorization setApiUrl updateUser

Constructors

constructor

new UserAPI(apiClient: APIClient, options: ClientOptions): UserAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns UserAPI
Overrides APIBase.constructor
- Defined in api/UserAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:41

deleteUser

deleteUser(id: string): Promise<void>
Deletes a user
Parameters
- id: string
  The user id
Returns Promise<void>
- Defined in api/UserAPI.ts:17

invite

invite(userData: NewUser): Promise<User>
Register a new user for your company. The newly created user will receive an invitation email.
Parameters
- userData: NewUser
  The user data
Returns Promise<User>
- Defined in api/UserAPI.ts:28

retrieveUser

retrieveUser(id: string): Promise<User>
Retrieve a user
Parameters
- id: string
  The user id
Returns Promise<User>
- Defined in api/UserAPI.ts:39

retrieveUserByOption

retrieveUserByOption(options?: PaginationOptions): Promise<Paginated<User[]>>
Retrieve a user by several options: e.g his lastname, or his firstname, or both e.g. const options = { skip: 0, limit: 50, filter: { firstName, lastName, } }
Parameters
- Optionaloptions: PaginationOptions
  The pagination options
Returns Promise<Paginated<User[]>>
- Defined in api/UserAPI.ts:60

retrieveUsers

retrieveUsers(options?: PaginationOptions): Promise<Paginated<User[]>>
Retrieve users
Parameters
- Optionaloptions: PaginationOptions
  The pagination options
Returns Promise<Paginated<User[]>>
- Defined in api/UserAPI.ts:71

setApiAuthorization

setApiAuthorization(authorization: Authorization): void
Set a new API key.
Parameters
- authorization: Authorization
  The API authorization data
Returns void
Inherited from APIBase.setApiAuthorization
- Defined in api/APIBase.ts:20

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:37

updateUser

updateUser(id: string, userData?: Partial<NewUser>): Promise<User>
Update an existing user
Parameters
- id: string
  The user id
- OptionaluserData: Partial<NewUser>
  The updated user data
Returns Promise<User>
- Defined in api/UserAPI.ts:83