Class: abstract ApiEndpoint

Defined in: api/endpoints/ApiEndpoint.ts:9

Extended by

• EmergencyEndpoint
• ChatMessageEndpoint
• CodeEndpoint
• OrgSettingsEndpoint
• AuthEndpoint
• ClientEndpoint
• StaffEndpoint
• WebsocketEndpoint
• TokenManager

Constructors

Constructor

protected new ApiEndpoint(config, tokenManager, log?, headerProvider?): ApiEndpoint

Defined in: api/endpoints/ApiEndpoint.ts:12

Parameters

config

DefaultApiConfig

tokenManager

TokenManager

log?

Logger

headerProvider?

HeaderProvider

Returns

ApiEndpoint

Properties

config

readonly config: DefaultApiConfig

Defined in: api/endpoints/ApiEndpoint.ts:10

---

log?

protected readonly optional log: Logger

Defined in: api/endpoints/ApiEndpoint.ts:15

---

tokenManager

readonly tokenManager: TokenManager

Defined in: api/endpoints/ApiEndpoint.ts:14

Methods

deleteRequest()

protected deleteRequest(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/ApiEndpoint.ts:85

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<unknown>>

---

endpoint()

abstract protected endpoint(): string

Defined in: api/endpoints/ApiEndpoint.ts:21

Returns

string

---

endpointUrl()

protected endpointUrl(): string

Defined in: api/endpoints/ApiEndpoint.ts:23

Returns

string

---

getRequest()

protected getRequest<T>(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:53

Type Parameters

T

T = unknown

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

---

patchRequest()

protected patchRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:77

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

---

postRequest()

protected postRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:61

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

---

putRequest()

protected putRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:69

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>