Class Client

constructor

• new Client(config: IApiClientConfig): Client

  Parameters

  • config: IApiClientConfig

  Returns Client

token

analytics

• get analytics(): AnalyticsApi

  Returns AnalyticsApi

command

• get command(): CommandApi

  Returns CommandApi

cronjob

• get cronjob(): CronJobApi

  Returns CronJobApi

discord

• get discord(): DiscordApi

  Returns DiscordApi

entity

• get entity(): EntityApi

  Returns EntityApi

event

• get event(): EventApi

  Returns EventApi

function

• get function(): FunctionApi

  Returns FunctionApi

gameserver

• get gameserver(): GameServerApi

  Returns GameServerApi

hook

• get hook(): HookApi

  Returns HookApi

item

• get item(): ItemApi

  Returns ItemApi

module

• get module(): ModuleApi

  Returns ModuleApi

password

• set password(password: string): void

  Parameters

  • password: string

  Returns void

player

• get player(): PlayerApi

  Returns PlayerApi

playerOnGameserver

• get playerOnGameserver(): PlayerOnGameServerApi

  Returns PlayerOnGameServerApi

role

• get role(): RoleApi

  Returns RoleApi

settings

• get settings(): SettingsApi

  Returns SettingsApi

shopCategory

• get shopCategory(): ShopCategoryApi

  Returns ShopCategoryApi

shopListing

• get shopListing(): ShopListingApi

  Returns ShopListingApi

shopOrder

• get shopOrder(): ShopOrderApi

  Returns ShopOrderApi

stats

• get stats(): StatsApi

  Returns StatsApi

tracking

• get tracking(): TrackingApi

  Returns TrackingApi

user

• get user(): UserApi

  Returns UserApi

username

• set username(username: string): void

  Parameters

  • username: string

  Returns void

variable

• get variable(): VariableApi

  Returns VariableApi

login

• login(): Promise<string>

  Returns Promise<string>

logout

• logout(): void

  Returns void

permissionCodesToInputs

• permissionCodesToInputs(
      permissions: string[],
  ): Promise<{ permissionId: string }[]>

  Parameters

  • permissions: string[]

  Returns Promise<{ permissionId: string }[]>