Class: MedrunnerApiClient<TEmergency, TClient, TStaff, TOrgSettings, TChatMessage, TCode, TAuth, TWebsocket>

Defined in: api/MedrunnerApiClient.ts:21

An API client for basic client interactions with the Medrunner API.

Type Parameters

TEmergency

TEmergency extends EmergencyEndpoint = EmergencyEndpoint

TClient

TClient extends ClientEndpoint = ClientEndpoint

TStaff

TStaff extends StaffEndpoint = StaffEndpoint

TOrgSettings

TOrgSettings extends OrgSettingsEndpoint = OrgSettingsEndpoint

TChatMessage

TChatMessage extends ChatMessageEndpoint = ChatMessageEndpoint

TCode

TCode extends CodeEndpoint = CodeEndpoint

TAuth

TAuth extends AuthEndpoint = AuthEndpoint

TWebsocket

TWebsocket extends WebsocketEndpoint = WebsocketEndpoint

Implements

• ApiClient<TEmergency, TClient, TStaff, TOrgSettings, TChatMessage, TCode, TAuth, TWebsocket>

Constructors

Constructor

protected new MedrunnerApiClient<TEmergency, TClient, TStaff, TOrgSettings, TChatMessage, TCode, TAuth, TWebsocket>(emergency, client, staff, orgSettings, chatMessage, code, auth, websocket): MedrunnerApiClient<TEmergency, TClient, TStaff, TOrgSettings, TChatMessage, TCode, TAuth, TWebsocket>

Defined in: api/MedrunnerApiClient.ts:32

Parameters

emergency

TEmergency

client

TClient

staff

TStaff

orgSettings

TOrgSettings

chatMessage

TChatMessage

code

TCode

auth

TAuth

websocket

TWebsocket

Returns

MedrunnerApiClient<TEmergency, TClient, TStaff, TOrgSettings, TChatMessage, TCode, TAuth, TWebsocket>

Properties

auth

readonly auth: TAuth

Defined in: api/MedrunnerApiClient.ts:39

Implementation of

ApiClient.auth

---

chatMessage

readonly chatMessage: TChatMessage

Defined in: api/MedrunnerApiClient.ts:37

Implementation of

ApiClient.chatMessage

---

client

readonly client: TClient

Defined in: api/MedrunnerApiClient.ts:34

Implementation of

ApiClient.client

---

code

readonly code: TCode

Defined in: api/MedrunnerApiClient.ts:38

Implementation of

ApiClient.code

---

emergency

readonly emergency: TEmergency

Defined in: api/MedrunnerApiClient.ts:33

Implementation of

ApiClient.emergency

---

orgSettings

readonly orgSettings: TOrgSettings

Defined in: api/MedrunnerApiClient.ts:36

Implementation of

ApiClient.orgSettings

---

staff

readonly staff: TStaff

Defined in: api/MedrunnerApiClient.ts:35

Implementation of

ApiClient.staff

---

websocket

readonly websocket: TWebsocket

Defined in: api/MedrunnerApiClient.ts:40

Implementation of

ApiClient.websocket

Methods

buildClient()

static buildClient(config, refreshCallback?, log?): MedrunnerApiClient

Defined in: api/MedrunnerApiClient.ts:50

Constructs a new API client.

Parameters

config

ApiConfig

The API configuration

refreshCallback?

AsyncAction<TokenGrant>

a callback function called whenever a refresh token exchange is performed

log?

Logger

A logger which logs request details

Returns

MedrunnerApiClient