Class APIResourceUser

APIResource

Hierarchy (View Summary)

APIResource<User>
- APIResourceUser

Constructors

constructor

new APIResourceUser(parent: API, id: number | "me"): APIResourceUser
/users/{id} | /me
Parameters
- parent: API
- id: number | "me"
Returns APIResourceUser
Overrides APIResource.constructor
- Defined in api/APIResourceUser.ts:33

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

accessGroup

accessGroup(id: number): APIResourceAccessGroup
Parameters
- id: number
Returns APIResourceAccessGroup
- Defined in api/APIResourceUser.ts:167

accessGroups

accessGroups(): APIList<
    AccessGroup,
    CollectionBasicQueryParams,
    AccessGroupsData,
>
Returns APIList<AccessGroup, CollectionBasicQueryParams, AccessGroupsData>
- Defined in api/APIResourceUser.ts:162

availableFrameworks

availableFrameworks(): APIList<Framework, CollectionBasicQueryParams, void>
Returns APIList<Framework, CollectionBasicQueryParams, void>
- Defined in api/APIResourceUser.ts:105

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

deleteAccount

deleteAccount(): APIResource<User, void, UserDeleteData>
Returns APIResource<User, void, UserDeleteData>
- Defined in api/APIResourceUser.ts:181

deviceGroup

deviceGroup(id: number): APIResourceDeviceGroup
Parameters
- id: number
Returns APIResourceDeviceGroup
- Defined in api/APIResourceUser.ts:60

deviceGroups

deviceGroups(): APIList<
    DeviceGroup,
    DeviceGroupWithPublicParams,
    DeviceGroupIdsData
    | Omit<DeviceGroupData, "displayName">,
>
Returns APIList<
    DeviceGroup,
    DeviceGroupWithPublicParams,
    DeviceGroupIdsData
    | Omit<DeviceGroupData, "displayName">,
>
- Defined in api/APIResourceUser.ts:55

deviceSession

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

deviceSessions

deviceSessions(): APIList<
    DeviceSession,
    DeviceSessionQueryParams,
    DeviceSessionData,
>
Returns APIList<DeviceSession, DeviceSessionQueryParams, DeviceSessionData>
- Defined in api/APIResourceUser.ts:65

deviceStatistics

deviceStatistics(): APIList<DeviceStatistics, DeviceStatisticQueryParam, void>
Returns APIList<DeviceStatistics, DeviceStatisticQueryParam, void>
- Defined in api/APIResourceUser.ts:157

deviceUsage

deviceUsage(): APIList<DeviceUsage, DeviceUsageQueryParams, void>
Returns APIList<DeviceUsage, DeviceUsageQueryParams, void>
- Defined in api/APIResourceUser.ts:147

feedback

feedback(): APIResource
Returns APIResource
- Defined in api/APIResourceUser.ts:122

file

file(id: number): APIResourceFile
Parameters
- id: number
Returns APIResourceFile
- Defined in api/APIResourceUser.ts:95

files

files(): APIListFiles
Returns APIListFiles
- Defined in api/APIResourceUser.ts:90

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

markAccountOwner

markAccountOwner(): APIResource<User, NoQueryParams, void>
Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIResourceUser.ts:75

method

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

notification

notification(id: number): APIResourceNotification
Parameters
- id: number
Returns APIResourceNotification
- Defined in api/APIResourceUser.ts:132

notifications

notifications(): APIListNotifications
Returns APIListNotifications
- Defined in api/APIResourceUser.ts:127

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

preferences

preferences(): APIResource<UserPreference, NoQueryParams, UserPreferenceData>
Returns APIResource<UserPreference, NoQueryParams, UserPreferenceData>
- Defined in api/APIResourceUser.ts:137

project

project(id: number): APIResourceProject
Parameters
- id: number
Returns APIResourceProject
- Defined in api/APIResourceUser.ts:85

projects

projects(): APIList<Project, UserProjectQueryParams, UserProjectData>
Returns APIList<Project, UserProjectQueryParams, UserProjectData>
- Defined in api/APIResourceUser.ts:80

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

resetApiKey

resetApiKey(): APIResource<User, NoQueryParams, void>
/users/{id}/reset-api-key

Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIResourceUser.ts:112

restack

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

restore

restore(): APIResource<User, NoQueryParams, void>
Returns APIResource<User, NoQueryParams, void>
- Defined in api/APIResourceUser.ts:117

runs

runs(): APIListRuns
Returns APIListRuns
- Defined in api/APIResourceUser.ts:100

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

services

services(): APIListServices
Returns APIListServices
- Defined in api/APIResourceUser.ts:50

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

smartbearTunnel

smartbearTunnel(id: number): APIResource
Parameters
- id: number
Returns APIResource
- Defined in api/APIResourceUser.ts:172

smartbearTunnels

smartbearTunnels(): APIListSmartbearTunnels
Returns APIListSmartbearTunnels
- Defined in api/APIResourceUser.ts:177

statistics

statistics(): APIResource<UserStatistics, StatisticQueryParams, void>
Returns APIResource<UserStatistics, StatisticQueryParams, void>
- Defined in api/APIResourceUser.ts:152

toUrl

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

uiPreferences

uiPreferences(): APIResource<string, NoQueryParams, UiPreferencesData>
Returns APIResource<string, NoQueryParams, UiPreferencesData>
- Defined in api/APIResourceUser.ts:142