Users | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Users

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Users(options: UsersOptions, http: Client): Users

Overrides ThBaseHandler.constructor
- Defined in src/v0/users.ts:79
Parameters
- options: UsersOptions
- http: Client
Returns Users

Properties

Optional configurationId

configurationId: string

endpoint

endpoint: string

http

http: Client

options

options: UsersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/configurations'

Methods

create

create(user: User): Promise<UserResponse>

- Defined in src/v0/users.ts:150
Parameters
- user: User
Returns Promise<UserResponse>

createToken

createToken(userId: string): Promise<UserResponse>

- Defined in src/v0/users.ts:182
Parameters
- userId: string
Returns Promise<UserResponse>

delete

delete(userId: string): Promise<UserResponse>

- Defined in src/v0/users.ts:165
Parameters
- userId: string
Returns Promise<UserResponse>

get

get(userId: string): Promise<UserResponse>

- Defined in src/v0/users.ts:116
Parameters
- userId: string
Returns Promise<UserResponse>

getAll

getAll(query?: HandleUsersQuery): Promise<UsersResponse>

- Defined in src/v0/users.ts:96
Parameters
- Optional query: HandleUsersQuery
Returns Promise<UsersResponse>

put

put(userId: string, user: User): Promise<UserResponse>

- Defined in src/v0/users.ts:135
Parameters
- userId: string
- user: User
Returns Promise<UserResponse>

Generated using TypeDoc