Skip to content

five-on-it / apps/client/src/ui/admin / adminApi

Function: adminApi() ​

adminApi(platform): object

Defined in: apps/client/src/ui/admin.ts:188

The admins' calls, as the page's session.

Parameters ​

platform ​

Platform

Returns ​

account ​

account: (id) => Promise<AdminAccount>

Parameters ​

id ​

string

Returns ​

Promise<AdminAccount>

audit ​

audit: () => Promise<AdminChange[]>

Returns ​

Promise<AdminChange[]>

cancel ​

cancel: (job) => Promise<Creation>

Parameters ​

job ​

string

Returns ​

Promise<Creation>

creations ​

creations: () => Promise<AdminCreations>

Returns ​

Promise<AdminCreations>

overrides ​

overrides: () => Promise<AdminOverride[]>

Returns ​

Promise<AdminOverride[]>

reset ​

reset: (id) => Promise<AdminAccount>

Parameters ​

id ​

string

Returns ​

Promise<AdminAccount>

resetSetting ​

resetSetting: (key, note?) => Promise<SettingsView>

Resets one setting (or every one, all) to its default.

Parameters ​

key ​

"all" | "concurrency" | "monthlyUsd" | "creationUsd" | "creationBuilds" | "quotaBuilds" | "quotaRooms" | "quotaCreations" | "turnMinutes" | "turnCalls" | "turnInputTokens" | "turnOutputTokens" | "turnMaxTokens" | "modelChoices" | "defaultModel"

note? ​

string

Returns ​

Promise<SettingsView>

search: (q) => Promise<AdminAccount[]>

Parameters ​

q ​

string

Returns ​

Promise<AdminAccount[]>

set ​

set: (id, form) => Promise<AdminAccount>

Parameters ​

id ​

string

form ​

LimitsForm

Returns ​

Promise<AdminAccount>

setSettings ​

setSettings: (body) => Promise<SettingsView>

Sets the settings a body gives (null resets one).

Parameters ​

body ​

Record<string, unknown>

Returns ​

Promise<SettingsView>

settings ​

settings: () => Promise<SettingsView>

Returns ​

Promise<SettingsView>

unlimited ​

unlimited: (id, on, note) => Promise<AdminAccount>

Makes an account unlimited (a note says why), or takes its override away.

Parameters ​

id ​

string

on ​

boolean

note ​

string

Returns ​

Promise<AdminAccount>