Class UserClient

Hierarchy

BaseClient
- UserClient

Index

Constructors

Properties

api apikey panel

Methods

getAccount getServer getServers getServerStatus getServerUsage

Constructors

constructor

new UserClient(options: ClientOptions): UserClient
Parameters
- options: ClientOptions
Returns UserClient
Overrides BaseClient.constructor
- Defined in src/UserClient/UserClient.ts:10

Properties

api

api: (
    config: AxiosRequestConfig,
    errorSet?: { code: number; message: string }[],
    ignoredErrors?: string[],
) => Promise<any> = ...

`Protected`apikey

apikey: string

panel

panel: string

Methods

getAccount

getAccount(): Promise<User>
Get the account this api key is assigned to

Returns Promise<User>
- Defined in src/UserClient/UserClient.ts:17

getServer

getServer(id: string): Promise<Server>
Get a Server on this account
Parameters
- id: string
Returns Promise<Server>
- Defined in src/UserClient/UserClient.ts:33

getServers

getServers(): Promise<Server[]>
Get all Servers on this account

Returns Promise<Server[]>
- Defined in src/UserClient/UserClient.ts:25

getServerStatus

getServerStatus(id: string): Promise<ServerStatus>
Get the status of a specific server
Parameters
- id: string
Returns Promise<ServerStatus>
- Defined in src/UserClient/UserClient.ts:49

getServerUsage

getServerUsage(id: string): Promise<StatsAttributes>
Get the usage for a specific server
Parameters
- id: string
Returns Promise<StatsAttributes>
- Defined in src/UserClient/UserClient.ts:41