Class: EmergencyEndpoint

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:17

Endpoints for interacting with emergencies.

Extends

• ApiEndpoint

Constructors

Constructor

new EmergencyEndpoint(config, tokenManager, log?, headerProvider?): EmergencyEndpoint

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:18

Parameters

config

DefaultApiConfig

tokenManager

TokenManager

log?

Logger

headerProvider?

HeaderProvider

Returns

EmergencyEndpoint

Overrides

ApiEndpoint.constructor

Properties

config

readonly config: DefaultApiConfig

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

Inherited from

ApiEndpoint.config

---

log?

protected readonly optional log: Logger

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

Inherited from

ApiEndpoint.log

---

tokenManager

readonly tokenManager: TokenManager

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

Inherited from

ApiEndpoint.tokenManager

Methods

cancelEmergencyWithReason()

cancelEmergencyWithReason(id, reason): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:64

Cancels an existing emergency.

Parameters

id

string

The id of the emergency to cancel

reason

CancellationReason

The reason the emergency was canceled

Returns

Promise<ApiResponse<unknown>>

Remarks

Emergency must still be in the MissionStatus.RECEIVED state in order to be canceled.

---

createEmergency()

createEmergency(newEmergency): Promise<ApiResponse<Emergency>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:51

Creates a new emergency.

Parameters

newEmergency

CreateEmergencyRequest

Emergency details for the new emergency

Returns

Promise<ApiResponse<Emergency>>

The newly-created emergency

---

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>>

Inherited from

ApiEndpoint.deleteRequest

---

endpoint()

protected endpoint(): string

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:22

Returns

string

Overrides

ApiEndpoint.endpoint

---

endpointUrl()

protected endpointUrl(): string

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

Returns

string

Inherited from

ApiEndpoint.endpointUrl

---

getEmergencies()

getEmergencies(ids): Promise<ApiResponse<Emergency[]>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:40

Bulk fetches emergencies by id.

Parameters

ids

string[]

a list of emergencies to retrieve

Returns

Promise<ApiResponse<Emergency[]>>

---

getEmergency()

getEmergency(id): Promise<ApiResponse<Emergency>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:31

Gets an emergency by id.

Parameters

id

string

The id of the emergency to retrieve

Returns

Promise<ApiResponse<Emergency>>

---

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>>

Inherited from

ApiEndpoint.getRequest

---

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>>

Inherited from

ApiEndpoint.patchRequest

---

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>>

Inherited from

ApiEndpoint.postRequest

---

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>>

Inherited from

ApiEndpoint.putRequest

---

rateServices()

rateServices(id, rating, remarks?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:77

Allows the client to rate their emergency.

Parameters

id

string

The id of the emergency to rate

rating

ResponseRating

The rating to give the services provided

remarks?

string

Additional remarks provided by the client

Returns

Promise<ApiResponse<unknown>>

---

teamDetails()

teamDetails(id): Promise<ApiResponse<TeamDetailsResponse>>

Defined in: api/endpoints/emergency/EmergencyEndpoint.ts:89

Fetches additional details about the responding team for an alert.

Parameters

id

string

The id of the emergency to get team details about

Returns

Promise<ApiResponse<TeamDetailsResponse>>