IamUsers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- IamUsers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IamUsers(options: IamUsersOptions, http: Client): IamUsers

Overrides ThBaseHandler.constructor
- Defined in src/v0/iam_users.ts:64
Parameters
- options: IamUsersOptions
- http: Client
Returns IamUsers

Properties

endpoint

endpoint: string

http

http: Client

options

options: IamUsersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/iam/users'

Methods

create

create(iamUser: IamUser): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:159
Parameters
- iamUser: IamUser
Returns Promise<IamUserResponse>

delete

delete(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:179
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

get

get(iamUserId: string): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:119
Parameters
- iamUserId: string
Returns Promise<IamUserResponse>

getAll

getAll(query?: IamUsersQueryHandler): Promise<IamUsersResponse>

- Defined in src/v0/iam_users.ts:76
Parameters
- Optional query: IamUsersQueryHandler
Returns Promise<IamUsersResponse>

meta

meta(query?: IamUsersQueryHandler): Promise<IamUsersResponse>

- Defined in src/v0/iam_users.ts:101
Parameters
- Optional query: IamUsersQueryHandler
Returns Promise<IamUsersResponse>

put

put(iamUserId: string, iamUser: IamUser): Promise<IamUserResponse>

- Defined in src/v0/iam_users.ts:139
Parameters
- iamUserId: string
- iamUser: IamUser
Returns Promise<IamUserResponse>

Generated using TypeDoc