Module @takaro/apiclient

@takaro/apiclient

Automatically generated API client for Takaro.

import { AdminClient, Client } from '@takaro/apiclient';

const url = 'http://localhost:13000';

const adminClient = new AdminClient({
url,
auth: {
clientSecret: config.get('adminClientSecret'),
},
});

const createdDomain = await this.adminClient.domain.domainControllerCreate({
name: 'test-domain',
});

const client = new Client({
url,
auth: {
username: createdDomain.data.data.rootUser.email,
password: createdDomain.data.data.password,
},
});

await client.login();

Enumerations

PERMISSIONS

Classes

AdminClient
Client
CommandApi
CronJobApi
DiscordApi
DomainApi
EventApi
ExternalAuthApi
FunctionApi
GameServerApi
HookApi
ItemApi
MetaApi
ModuleApi
PlayerApi
PlayerOnGameServerApi
RoleApi
SettingsApi
ShopListingApi
ShopOrderApi
StatsApi
UserApi
VariableApi

Interfaces

ActivityInputDTO
AllowedFilters
APIOutput
AxiosResponse
BanCreateDTO
BanDTO
BanOutputArrayDTOAPI
BanOutputDTO
BanOutputDTOAPI
BanPlayerInputDTO
BanPlayerOutputDTO
BanSearchInputAllowedFilters
BanSearchInputAllowedRangeFilter
BanSearchInputDTO
BanUpdateDTO
BaseDiscordEvent
BaseEvent
BaseGameEvent
BaseStatsInputDTO
BaseTakaroEvent
BuiltinModule
CommandArgumentCreateDTO
CommandArgumentDTOAPI
CommandArgumentOutputDTO
CommandArgumentUpdateDTO
CommandCreateDTO
CommandExecuteDTOAPI
CommandExecuteInputDTO
CommandOutput
CommandOutputArrayDTOAPI
CommandOutputDTO
CommandOutputDTOAPI
CommandSearchInputAllowedFilters
CommandSearchInputDTO
CommandTriggerDTO
CommandUpdateDTO
CountryStatsInputDTO
CronJobCreateDTO
CronJobOutputArrayDTOAPI
CronJobOutputDTO
CronJobOutputDTOAPI
CronJobSearchInputAllowedFilters
CronJobSearchInputDTO
CronJobTriggerDTO
CronJobUpdateDTO
DiscordInviteOutputDTO
DiscordParamId
DomainCreateInputDTO
DomainCreateOutputDTO
DomainCreateOutputDTOAPI
DomainOutputArrayDTOAPI
DomainOutputDTO
DomainOutputDTOAPI
DomainSearchInputAllowedFilters
DomainSearchInputDTO
DomainUpdateInputDTO
ErrorOutput
EventChatMessage
EventCreateDTO
EventDiscordChannel
EventDiscordUser
EventEntityKilled
EventLogLine
EventOutputArrayDTOAPI
EventOutputDTO
EventPlayerConnected
EventPlayerDeath
EventPlayerDisconnected
EventsCountInputDTO
EventSearchInputAllowedFilters
EventSearchInputDTO
FunctionCreateDTO
FunctionOutputArrayDTOAPI
FunctionOutputDTO
FunctionOutputDTOAPI
FunctionSearchInputAllowedFilters
FunctionSearchInputDTO
FunctionUpdateDTO
GameServerCreateDTO
GameServerOutputArrayDTOAPI
GameServerOutputDTO
GameServerOutputDTOAPI
GameServerSearchInputAllowedFilters
GameServerSearchInputDTO
GameServerTestReachabilityDTOAPI
GameServerTestReachabilityInputDTO
GameServerTypesOutputDTO
GameServerTypesOutputDTOAPI
GameServerUpdateDTO
GetSettingsInput
GetSettingsOneInput
GetUserDTO
GiveItemInputDTO
GuildApiUpdateDTO
GuildCreateInputDTO
GuildOutputArrayDTOAPI
GuildOutputDTO
GuildOutputDTOAPI
GuildSearchInputAllowedFilters
GuildSearchInputDTO
GuildUpdateDTO
HealthOutputDTO
HookCreateDTO
HookEventDiscordMessage
HookOutputArrayDTOAPI
HookOutputDTO
HookOutputDTOAPI
HookSearchInputAllowedFilters
HookSearchInputDTO
HookTriggerDTO
HookUpdateDTO
ICommand
ICommandArgument
ICronJob
IFunction
IGamePlayer
IHook
IItemDTO
IMessageOptsDTO
ImportInputDTO
ImportOutputDTO
ImportOutputDTOAPI
ImportStatusOutputDTO
ImportStatusOutputDTOAPI
InviteCreateDTO
InviteOutputDTO
IPermission
IpHistoryOutputDTO
IPlayerReferenceDTO
IPosition
ITakaroQuery
ItemCreateDTO
ItemOutputArrayDTOAPI
ItemOutputDTOAPI
ItemSearchInputAllowedFilters
ItemSearchInputDTO
ItemsOutputDTO
ItemUpdateDTO
KickPlayerInputDTO
LatencyInputDTO
LinkPlayerUnauthedInputDTO
LoginDTO
LoginOutputDTO
LoginOutputDTOAPI
MapInfoDTO
MapTileInputDTO
MeOutoutDTOAPI
MeOutputDTO
MessageSendInputDTO
MetadataOutput
MockConnectionInfo
ModuleCreateDTO
ModuleCreateInternalDTO
ModuleExportDTOAPI
ModuleInstallationOutputArrayDTOAPI
ModuleInstallationOutputDTO
ModuleInstallationOutputDTOAPI
ModuleInstallDTO
ModuleOutputArrayDTOAPI
ModuleOutputDTO
ModuleOutputDTOAPI
ModuleSearchInputAllowedFilters
ModuleSearchInputDTO
ModuleUpdateDTO
NOTDOMAINSCOPEDTakaroModelDTO
OptionalPogStatsInputDTO
PaginationParams
PaginationParamsWithGameServer
ParamId
ParamIdAndModuleId
ParamIdAndRoleId
ParamKey
ParamSenderReceiver
PermissionCreateDTO
PermissionInputDTO
PermissionModuleDTO
PermissionOnRoleDTO
PermissionOutputDTO
PermissionOutputDTOAPI
PlayerCreateDTO
PlayerMeOutputDTO
PlayerOnGameServerCreateDTO
PlayerOnGameserverOutputArrayDTOAPI
PlayerOnGameserverOutputDTO
PlayerOnGameserverOutputDTOAPI
PlayerOnGameserverOutputWithRolesDTO
PlayerOnGameServerSearchInputAllowedFilters
PlayerOnGameServerSearchInputAllowedRangeFilter
PlayerOnGameServerSearchInputDTO
PlayerOnGameServerSetCurrencyInputDTO
PlayerOnGameServerUpdateDTO
PlayerOutputArrayDTOAPI
PlayerOutputDTO
PlayerOutputDTOAPI
PlayerOutputWithRolesDTO
PlayerOutputWithRolesDTOAPI
PlayerRoleAssignChangeDTO
PlayerRoleAssignmentOutputDTO
PlayerSearchInputAllowedFilters
PlayerSearchInputAllowedRangeFilter
PlayerSearchInputDTO
PlayersOnlineInputDTO
PlayerUpdateDTO
PogParam
PogStatsInputDTO
RangeFilterCreatedAndUpdatedAt
RedirectQs
RoleCreateInputDTO
RoleMembersOutputDTO
RoleMembersOutputDTOAPI
RoleMembersPlayersOutputDTO
RoleMembersUsersOutputDTO
RoleOutputArrayDTOAPI
RoleOutputDTO
RoleOutputDTOAPI
RoleSearchInputAllowedFilters
RoleSearchInputDTO
RoleUpdateInputDTO
RustConnectionInfo
SdtdConnectionInfo
SearchRoleInputDTO
SendMessageInputDTO
ServiceRoleCreateInputDTO
Settings
SettingsOutputArrayDTOAPI
SettingsOutputDTO
SettingsOutputDTOAPI
SettingsSetDTO
ShopImportOptions
ShopListingCreateDTO
ShopListingItemMetaInputDTO
ShopListingItemMetaOutputDTO
ShopListingOutputArrayDTOAPI
ShopListingOutputDTO
ShopListingOutputDTOAPI
ShopListingSearchInputAllowedFilters
ShopListingSearchInputDTO
ShopListingUpdateDTO
ShopOrderCreateDTO
ShopOrderCreateInternalDTO
ShopOrderOutputArrayDTOAPI
ShopOrderOutputDTO
ShopOrderOutputDTOAPI
ShopOrderSearchInputAllowedFilters
ShopOrderSearchInputAllowedRangeFilter
ShopOrderSearchInputDTO
ShopOrderUpdateDTO
ShopSearchInputAllowedRangeFilter
StatsOutputDTO
StatsOutputDTOAPI
TakaroEventCommandDetails
TakaroEventCommandExecuted
TakaroEventCronjobDetails
TakaroEventCronjobExecuted
TakaroEventCurrencyAdded
TakaroEventCurrencyDeducted
TakaroEventFunctionLog
TakaroEventFunctionResult
TakaroEventGameserverCreated
TakaroEventGameserverDeleted
TakaroEventGameserverUpdated
TakaroEventHookDetails
TakaroEventHookExecuted
TakaroEventModuleCreated
TakaroEventModuleDeleted
TakaroEventModuleInstalled
TakaroEventModuleUninstalled
TakaroEventModuleUpdated
TakaroEventPlayerCreated
TakaroEventPlayerLinked
TakaroEventPlayerNewIpDetected
TakaroEventRoleAssigned
TakaroEventRoleCreated
TakaroEventRoleDeleted
TakaroEventRoleMeta
TakaroEventRoleRemoved
TakaroEventRoleUpdated
TakaroEventServerStatusChanged
TakaroEventSettingsSet
TakaroEventShopListingCreated
TakaroEventShopListingDeleted
TakaroEventShopListingUpdated
TakaroEventShopOrderCreated
TakaroEventShopOrderStatusChanged
TakaroModelDTO
TeleportPlayerInputDTO
TestReachabilityOutputDTO
TokenInputDTO
TokenOutputDTO
TokenOutputDTOAPI
UserAssignmentOutputDTO
UserCreateInputDTO
UserOutputArrayDTOAPI
UserOutputDTO
UserOutputDTOAPI
UserOutputWithRolesDTO
UserRoleAssignChangeDTO
UserSearchInputAllowedFilters
UserSearchInputAllowedRangeFilter
UserSearchInputDTO
UserUpdateAuthDTO
UserUpdateDTO
VariableCreateDTO
VariableOutputArrayDTOAPI
VariableOutputDTO
VariableOutputDTOAPI
VariableSearchInputAllowedFilters
VariableSearchInputDTO
VariableUpdateDTO

Type Aliases

ActivityInputDTODataTypeEnum
ActivityInputDTOTimeTypeEnum
BanSearchInputDTOSortDirectionEnum
CommandSearchInputDTOSortDirectionEnum
CronJobSearchInputDTOSortDirectionEnum
DomainCreateInputDTOStateEnum
DomainOutputDTOStateEnum
DomainSearchInputAllowedFiltersStateEnum
DomainSearchInputDTOSortDirectionEnum
DomainUpdateInputDTOStateEnum
EventChatMessageChannelEnum
EventCreateDTOEventNameEnum
EventOutputDTOEventNameEnum
EventOutputDTOMeta
EventsCountInputDTOBucketStepEnum
EventsCountInputDTOEventNameEnum
EventsCountInputDTOSumByEnum
EventSearchInputAllowedFiltersEventNameEnum
EventSearchInputDTOSortDirectionEnum
FunctionSearchInputDTOSortDirectionEnum
GameServerCreateDTOTypeEnum
GameServerOutputDTOTypeEnum
GameServerSearchInputAllowedFiltersTypeEnum
GameServerSearchInputDTOSortDirectionEnum
GameServerTestReachabilityInputDTOTypeEnum
GameServerTypesOutputDTOTypeEnum
GameServerUpdateDTOTypeEnum
GetSettingsInputKeysEnum
GuildSearchInputDTOSortDirectionEnum
HookCreateDTOEventTypeEnum
HookOutputDTOEventTypeEnum
HookSearchInputAllowedFiltersEventTypeEnum
HookSearchInputDTOSortDirectionEnum
HookTriggerDTOEventTypeEnum
HookUpdateDTOEventTypeEnum
IHookEventTypeEnum
ImportStatusOutputDTOStatusEnum
ITakaroAPIAxiosResponse
ITakaroQuerySortDirectionEnum
ItemSearchInputDTOSortDirectionEnum
ModuleSearchInputDTOSortDirectionEnum
NOTDOMAINSCOPEDTakaroModelDTOCreatedAt
ParamKeyKeyEnum
PlayerOnGameServerSearchInputDTOSortDirectionEnum
PlayerSearchInputDTOSortDirectionEnum
RoleSearchInputDTOSortDirectionEnum
SettingsControllerGetKeysEnum
SettingsOutputDTOKeyEnum
SettingsOutputDTOTypeEnum
ShopListingSearchInputDTOSortDirectionEnum
ShopOrderOutputDTOStatusEnum
ShopOrderSearchInputDTOSortDirectionEnum
ShopOrderUpdateDTOStatusEnum
StatsControllerGetActivityStatsDataTypeEnum
StatsControllerGetActivityStatsTimeTypeEnum
StatsControllerGetEventsCountBucketStepEnum
StatsControllerGetEventsCountEventNameEnum
StatsControllerGetEventsCountSumByEnum
UserSearchInputDTOSortDirectionEnum
VariableSearchInputDTOSortDirectionEnum

Variables

ActivityInputDTODataTypeEnum
ActivityInputDTOTimeTypeEnum
BanSearchInputDTOSortDirectionEnum
CommandSearchInputDTOSortDirectionEnum
CronJobSearchInputDTOSortDirectionEnum
DomainCreateInputDTOStateEnum
DomainOutputDTOStateEnum
DomainSearchInputAllowedFiltersStateEnum
DomainSearchInputDTOSortDirectionEnum
DomainUpdateInputDTOStateEnum
EventChatMessageChannelEnum
EventCreateDTOEventNameEnum
EventOutputDTOEventNameEnum
EventsCountInputDTOBucketStepEnum
EventsCountInputDTOEventNameEnum
EventsCountInputDTOSumByEnum
EventSearchInputAllowedFiltersEventNameEnum
EventSearchInputDTOSortDirectionEnum
FunctionSearchInputDTOSortDirectionEnum
GameServerCreateDTOTypeEnum
GameServerOutputDTOTypeEnum
GameServerSearchInputAllowedFiltersTypeEnum
GameServerSearchInputDTOSortDirectionEnum
GameServerTestReachabilityInputDTOTypeEnum
GameServerTypesOutputDTOTypeEnum
GameServerUpdateDTOTypeEnum
GetSettingsInputKeysEnum
GuildSearchInputDTOSortDirectionEnum
HookCreateDTOEventTypeEnum
HookOutputDTOEventTypeEnum
HookSearchInputAllowedFiltersEventTypeEnum
HookSearchInputDTOSortDirectionEnum
HookTriggerDTOEventTypeEnum
HookUpdateDTOEventTypeEnum
IHookEventTypeEnum
ImportStatusOutputDTOStatusEnum
ITakaroQuerySortDirectionEnum
ItemSearchInputDTOSortDirectionEnum
ModuleSearchInputDTOSortDirectionEnum
ParamKeyKeyEnum
PlayerOnGameServerSearchInputDTOSortDirectionEnum
PlayerSearchInputDTOSortDirectionEnum
RoleSearchInputDTOSortDirectionEnum
SettingsControllerGetKeysEnum
SettingsOutputDTOKeyEnum
SettingsOutputDTOTypeEnum
ShopListingSearchInputDTOSortDirectionEnum
ShopOrderOutputDTOStatusEnum
ShopOrderSearchInputDTOSortDirectionEnum
ShopOrderUpdateDTOStatusEnum
StatsControllerGetActivityStatsDataTypeEnum
StatsControllerGetActivityStatsTimeTypeEnum
StatsControllerGetEventsCountBucketStepEnum
StatsControllerGetEventsCountEventNameEnum
StatsControllerGetEventsCountSumByEnum
UserSearchInputDTOSortDirectionEnum
VariableSearchInputDTOSortDirectionEnum

Functions

CommandApiAxiosParamCreator
CommandApiFactory
CommandApiFp
CronJobApiAxiosParamCreator
CronJobApiFactory
CronJobApiFp
DiscordApiAxiosParamCreator
DiscordApiFactory
DiscordApiFp
DomainApiAxiosParamCreator
DomainApiFactory
DomainApiFp
EventApiAxiosParamCreator
EventApiFactory
EventApiFp
ExternalAuthApiAxiosParamCreator
ExternalAuthApiFactory
ExternalAuthApiFp
FunctionApiAxiosParamCreator
FunctionApiFactory
FunctionApiFp
GameServerApiAxiosParamCreator
GameServerApiFactory
GameServerApiFp
HookApiAxiosParamCreator
HookApiFactory
HookApiFp
isAxiosError
ItemApiAxiosParamCreator
ItemApiFactory
ItemApiFp
MetaApiAxiosParamCreator
MetaApiFactory
MetaApiFp
ModuleApiAxiosParamCreator
ModuleApiFactory
ModuleApiFp
PlayerApiAxiosParamCreator
PlayerApiFactory
PlayerApiFp
PlayerOnGameServerApiAxiosParamCreator
PlayerOnGameServerApiFactory
PlayerOnGameServerApiFp
RoleApiAxiosParamCreator
RoleApiFactory
RoleApiFp
SettingsApiAxiosParamCreator
SettingsApiFactory
SettingsApiFp
ShopListingApiAxiosParamCreator
ShopListingApiFactory
ShopListingApiFp
ShopOrderApiAxiosParamCreator
ShopOrderApiFactory
ShopOrderApiFp
StatsApiAxiosParamCreator
StatsApiFactory
StatsApiFp
UserApiAxiosParamCreator
UserApiFactory
UserApiFp
VariableApiAxiosParamCreator
VariableApiFactory
VariableApiFp