Class APIAdminResourceUser

APIResource

Hierarchy (View Summary, Expand)

APIResource<User>
- APIAdminResourceUser

Index

Constructors

Properties

abortController ALLOWED_HTTP_METHODS requestConfig root stack

Accessors

Constructors

constructor

new APIAdminResourceUser(
parent: APIAdminResource,
id: number,
): APIAdminResourceUser
/admin/users/{id}
Parameters
- parent: APIAdminResource
- id: number
Returns APIAdminResourceUser
Overrides APIResource.constructor
- Defined in api/APIAdminResourceUser.ts:19

Properties

`Protected`abortController

abortController: AbortController

`Protected`ALLOWED_HTTP_METHODS

ALLOWED_HTTP_METHODS: Method[] = ALLOWED_HTTP_METHODS

`Protected`requestConfig

requestConfig: AxiosRequestConfig = {}

root

root: API

`Protected`stack

stack: (string | number)[] = []

Accessors

first

get first(): string | number
Get first element of the stack

Returns string | number
Inherited from APIResource.first
- Defined in api/APIEntity.ts:66

last

get last(): string | number
Get last element of the stack

Returns string | number
Inherited from APIResource.last
- Defined in api/APIEntity.ts:73
set last(val: string | number): void
Set last element of the stack
Parameters
- val: string | number
Returns void
Inherited from APIResource.last
- Defined in api/APIEntity.ts:80

Methods

abortRequest

abortRequest(): void
Returns void
Inherited from APIResource.abortRequest
- Defined in api/APIEntity.ts:43

account

account(): APIAdminResourceUserAccount
Returns APIAdminResourceUserAccount
- Defined in api/APIAdminResourceUser.ts:49

data

data(data: QueryParams): this
Set data
Parameters
- data: QueryParams
Returns this
Inherited from APIResource.data
- Defined in api/APIEntity.ts:175

delete

delete(): this
Set DELETE as HTTP method

Returns this
Inherited from APIResource.delete
- Defined in api/APIEntity.ts:151

deviceSession

deviceSession(id: number): APIResourceDeviceSessionStandalone
Parameters
- id: number
Returns APIResourceDeviceSessionStandalone
- Defined in api/APIAdminResourceUser.ts:54

disable

disable(): APIResource<User, NoQueryParams, void>
Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIAdminResourceUser.ts:29

enable

enable(): APIResource<User, NoQueryParams, void>
Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIAdminResourceUser.ts:34

formData

formData(data: QueryParams): this
Set form data
Parameters
- data: QueryParams
Returns this
Inherited from APIResource.formData
- Defined in api/APIEntity.ts:193

get

get(): this
Set GET as HTTP method

Returns this
Inherited from APIResource.get
- Defined in api/APIEntity.ts:137

getParams

getParams(): Partial<QueryParams>
Returns Partial<QueryParams>
Inherited from APIResource.getParams
- Defined in api/APIEntity.ts:163

headers

headers(headers: Record<string, string>): this
Parameters
- headers: Record<string, string>
Returns this
Inherited from APIResource.headers
- Defined in api/APIEntity.ts:104

jsonData

jsonData(data: QueryParams): this
Set JSON data
Parameters
- data: QueryParams
Returns this
Inherited from APIResource.jsonData
- Defined in api/APIEntity.ts:183

licenses

licenses(): APIList<License, void>
Returns APIList<License, void>
- Defined in api/APIAdminResourceUser.ts:39

method

method(name: Method): this
Set HTTP method
Parameters
- name: Method
Returns this
Inherited from APIResource.method
- Defined in api/APIEntity.ts:121

params

params<T extends string = string>(params: Pick<QueryParams, T>): this
Set params
Type Parameters
- T extends string = string
Parameters
- params: Pick<QueryParams, T>
Returns this
Inherited from APIResource.params
- Defined in api/APIEntity.ts:158

`Protected`paramsSerializer

paramsSerializer(params: QueryParams): string
Parameters
- params: QueryParams
Returns string
Inherited from APIResource.paramsSerializer
- Defined in api/APIEntity.ts:234

post

post(): this
Set POST as HTTP method

Returns this
Inherited from APIResource.post
- Defined in api/APIEntity.ts:144

push

push(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Inherited from APIResource.push
- Defined in api/APIEntity.ts:48

removeParam

removeParam(key: string): this
Parameters
- key: string
Returns this
Inherited from APIResource.removeParam
- Defined in api/APIEntity.ts:167

removeRequestConfig

removeRequestConfig(key: keyof AxiosRequestConfig): this
Parameters
- key: keyof AxiosRequestConfig
Returns this
Inherited from APIResource.removeRequestConfig
- Defined in api/APIEntity.ts:99

resendActivation

resendActivation(): APIResource<User, NoQueryParams, void>
Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIAdminResourceUser.ts:44

restack

restack(...items: (string | number)[]): this
Parameters
- ...items: (string | number)[]
Returns this
Inherited from APIResource.restack
- Defined in api/APIEntity.ts:58

role

role(id: number): APIResource<Role, RoleParams, void>
Parameters
- id: number
Returns APIResource<Role, RoleParams, void>
- Defined in api/APIAdminResourceUser.ts:64

roles

roles(): APIList<Role, RoleParams, void>
Returns APIList<Role, RoleParams, void>
- Defined in api/APIAdminResourceUser.ts:59

send

send<T = User>(): Promise<AxiosResponse<T>>
Send request
Type Parameters
- T = User
Returns Promise<AxiosResponse<T>>
Inherited from APIResource.send
- Defined in api/APIEntity.ts:203

setRequestConfig

setRequestConfig(requestConfig: AxiosRequestConfig): this
Parameters
- requestConfig: AxiosRequestConfig
Returns this
Inherited from APIResource.setRequestConfig
- Defined in api/APIEntity.ts:94

shift

shift(): this
Returns this
Inherited from APIResource.shift
- Defined in api/APIEntity.ts:53

toUrl

toUrl(absolute?: boolean): string
Parameters
- absolute: boolean = false
Returns string
Inherited from APIResource.toUrl
- Defined in api/APIEntity.ts:84