Class: default

client/apis/DevelopAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• activateUniverse
• createDeveloperProduct
• createUniverseAlias
• deactivateUniverse
• deleteUniverseAlias
• downloadUniverseStatisticReportsByTime
• filterGameUpdateNotificationText
• generateUniverseStatisticReportsByTime
• getGameTemplates
• getGameUpdatesHistory
• getGroupUniverses
• getMultiPlugins
• getMultiUniverses
• getMultiUniversesPermissions
• getPlaceCompatibilities
• getPlaceStatistics
• getPlacesInUniverse
• getSelfManageableGroups
• getSelfNotificationStatisticReports
• getSelfUniversePermissions
• getSelfUniverses
• getSelfUniversesTeamCreateAccess
• getStudioData
• getUniverse
• getUniverseConfiguration
• getUniverseStatisticReports
• getUniverseStatisticReportsByTime
• getUniverseTeamCreateMembers
• getUniverseTeamCreateSettings
• getUniverseVIPServersConfiguration
• publishGameUpdateNotification
• removeUserFromUniverseTeamCreate
• request
• searchToolbox
• searchUniverses
• setStudioData
• updateDeveloperProduct
• updatePlaceConfiguration
• updatePlugin
• updateUniverseAlias
• updateUniverseConfiguration
• updateUniverseTeamCreateSettings

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/DevelopAPI.ts:436

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

activateUniverse

▸ activateUniverse(options: ActivateUniverseOptions): Promise<unknown>

Parameters:

Name	Type
options	ActivateUniverseOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:695

---

createDeveloperProduct

▸ createDeveloperProduct(options: CreateDeveloperProductOptions): Promise<CreateDeveloperProduct>

Parameters:

Name	Type
options	CreateDeveloperProductOptions

Returns: Promise<CreateDeveloperProduct>

Defined in: client/apis/DevelopAPI.ts:925

---

createUniverseAlias

▸ createUniverseAlias(options: CreateUniverseAliasOptions): Promise<unknown>

Parameters:

Name	Type
options	CreateUniverseAliasOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:889

---

deactivateUniverse

▸ deactivateUniverse(options: DeactivateUniverseOptions): Promise<unknown>

Parameters:

Name	Type
options	DeactivateUniverseOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:707

---

deleteUniverseAlias

▸ deleteUniverseAlias(options: DeleteUniverseAliasOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteUniverseAliasOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:900

---

downloadUniverseStatisticReportsByTime

▸ downloadUniverseStatisticReportsByTime(options: DownloadUniverseStatisticsReportByTimeOptions): Promise<unknown>

Parameters:

Name	Type
options	DownloadUniverseStatisticsReportByTimeOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:656

---

filterGameUpdateNotificationText

▸ filterGameUpdateNotificationText(options: FilterPublishGameNotificationOptions): Promise<FilterPublishGameNotification>

Parameters:

Name	Type
options	FilterPublishGameNotificationOptions

Returns: Promise<FilterPublishGameNotification>

Defined in: client/apis/DevelopAPI.ts:480

---

generateUniverseStatisticReportsByTime

▸ generateUniverseStatisticReportsByTime(options: GenerateUniverseStatisticReportsByTimeOptions): Promise<unknown>

Parameters:

Name	Type
options	GenerateUniverseStatisticReportsByTimeOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:719

---

getGameTemplates

▸ getGameTemplates(): Promise<GetGameTemplates>

Returns: Promise<GetGameTemplates>

Defined in: client/apis/DevelopAPI.ts:445

---

getGameUpdatesHistory

▸ getGameUpdatesHistory(options: GetGameUpdatesHistoryOptions): Promise<GetGameUpdatesHistory>

Parameters:

Name	Type
options	GetGameUpdatesHistoryOptions

Returns: Promise<GetGameUpdatesHistory>

Defined in: client/apis/DevelopAPI.ts:456

---

getGroupUniverses

▸ getGroupUniverses(options: GetGroupUniversesOptions): Promise<GetGroupUniverses>

Parameters:

Name	Type
options	GetGroupUniversesOptions

Returns: Promise<GetGroupUniverses>

Defined in: client/apis/DevelopAPI.ts:493

---

getMultiPlugins

▸ getMultiPlugins(options: GetPluginsByIdOptions): Promise<GetPluginsById>

Parameters:

Name	Type
options	GetPluginsByIdOptions

Returns: Promise<GetPluginsById>

Defined in: client/apis/DevelopAPI.ts:541

---

getMultiUniverses

▸ getMultiUniverses(options: MultiGetUniversesOptions): Promise<MultiGetUniverses>

Parameters:

Name	Type
options	MultiGetUniversesOptions

Returns: Promise<MultiGetUniverses>

Defined in: client/apis/DevelopAPI.ts:667

---

getMultiUniversesPermissions

▸ getMultiUniversesPermissions(options: MultiGetUniversesPermissionsOptions): Promise<MultiGetUniversesPermissions>

Parameters:

Name	Type
options	MultiGetUniversesPermissionsOptions

Returns: Promise<MultiGetUniversesPermissions>

Defined in: client/apis/DevelopAPI.ts:681

---

getPlaceCompatibilities

▸ getPlaceCompatibilities(options: GetPlaceCompatibilitiesOptions): Promise<GetPlaceCompatibilities>

Parameters:

Name	Type
options	GetPlaceCompatibilitiesOptions

Returns: Promise<GetPlaceCompatibilities>

Defined in: client/apis/DevelopAPI.ts:505

---

getPlaceStatistics

▸ getPlaceStatistics(options: GetPlaceStatisticsByTypeOptions): Promise<GetPlaceStatisticsByType>

Parameters:

Name	Type
options	GetPlaceStatisticsByTypeOptions

Returns: Promise<GetPlaceStatisticsByType>

Defined in: client/apis/DevelopAPI.ts:529

---

getPlacesInUniverse

▸ getPlacesInUniverse(options: GetUniversePlacesOptions): Promise<GetUniversePlaces>

Parameters:

Name	Type
options	GetUniversePlacesOptions

Returns: Promise<GetUniversePlaces>

Defined in: client/apis/DevelopAPI.ts:622

---

getSelfManageableGroups

▸ getSelfManageableGroups(): Promise<GetSelfGroupsAccess>

Returns: Promise<GetSelfGroupsAccess>

Defined in: client/apis/DevelopAPI.ts:827

---

getSelfNotificationStatisticReports

▸ getSelfNotificationStatisticReports(): Promise<GetNotificationsStatisticReports>

Returns: Promise<GetNotificationsStatisticReports>

Defined in: client/apis/DevelopAPI.ts:838

---

getSelfUniversePermissions

▸ getSelfUniversePermissions(options: GetUniversePermissionsOptions): Promise<GetUniversePermissions>

Parameters:

Name	Type
options	GetUniversePermissionsOptions

Returns: Promise<GetUniversePermissions>

Defined in: client/apis/DevelopAPI.ts:611

---

getSelfUniverses

▸ getSelfUniverses(options: GetSelfUniversesOptions): Promise<GetSelfUniverses>

Parameters:

Name	Type
options	GetSelfUniversesOptions

Returns: Promise<GetSelfUniverses>

Defined in: client/apis/DevelopAPI.ts:877

---

getSelfUniversesTeamCreateAccess

▸ getSelfUniversesTeamCreateAccess(options: GetSelfTeamCreateUniversesAccessOptions): Promise<GetSelfTeamCreateUniversesAccess>

Parameters:

Name	Type
options	GetSelfTeamCreateUniversesAccessOptions

Returns: Promise<GetSelfTeamCreateUniversesAccess>

Defined in: client/apis/DevelopAPI.ts:815

---

getStudioData

▸ getStudioData(options: GetStudioDataOptions): Promise<unknown>

Parameters:

Name	Type
options	GetStudioDataOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:849

---

getUniverse

▸ getUniverse(options: GetUniverseOptions): Promise<GameUniverseOptions>

Parameters:

Name	Type
options	GetUniverseOptions

Returns: Promise<GameUniverseOptions>

Defined in: client/apis/DevelopAPI.ts:600

---

getUniverseConfiguration

▸ getUniverseConfiguration(options: GetUniverseConfigurationOptions): Promise<GetUniverseConfiguration>

Parameters:

Name	Type
options	GetUniverseConfigurationOptions

Returns: Promise<GetUniverseConfiguration>

Defined in: client/apis/DevelopAPI.ts:731

---

getUniverseStatisticReports

▸ getUniverseStatisticReports(options: GetUniverseStatisticsReportsOptions): Promise<GetUniverseStatisticsReports>

Parameters:

Name	Type
options	GetUniverseStatisticsReportsOptions

Returns: Promise<GetUniverseStatisticsReports>

Defined in: client/apis/DevelopAPI.ts:634

---

getUniverseStatisticReportsByTime

▸ getUniverseStatisticReportsByTime(options: GetUniverseStatisticsReportsByTimeOptions): Promise<GetUniverseStatisticsReportByTime>

Parameters:

Name	Type
options	GetUniverseStatisticsReportsByTimeOptions

Returns: Promise<GetUniverseStatisticsReportByTime>

Defined in: client/apis/DevelopAPI.ts:645

---

getUniverseTeamCreateMembers

▸ getUniverseTeamCreateMembers(options: GetUsersInUniverseTeamCreateOptions): Promise<GetUsersInUniverseTeamCreate>

Parameters:

Name	Type
options	GetUsersInUniverseTeamCreateOptions

Returns: Promise<GetUsersInUniverseTeamCreate>

Defined in: client/apis/DevelopAPI.ts:803

---

getUniverseTeamCreateSettings

▸ getUniverseTeamCreateSettings(options: GetUniverseTeamCreateSettingsOptions): Promise<GetUniverseTeamCreateSettings>

Parameters:

Name	Type
options	GetUniverseTeamCreateSettingsOptions

Returns: Promise<GetUniverseTeamCreateSettings>

Defined in: client/apis/DevelopAPI.ts:766

---

getUniverseVIPServersConfiguration

▸ getUniverseVIPServersConfiguration(options: GetUniverseVIPServersConfigurationOptions): Promise<GetUniverseVIPServersConfiguration>

Parameters:

Name	Type
options	GetUniverseVIPServersConfigurationOptions

Returns: Promise<GetUniverseVIPServersConfiguration>

Defined in: client/apis/DevelopAPI.ts:755

---

publishGameUpdateNotification

▸ publishGameUpdateNotification(options: PublishGameNotificationOptions): Promise<GetGameUpdatesHistory>

Parameters:

Name	Type
options	PublishGameNotificationOptions

Returns: Promise<GetGameUpdatesHistory>

Defined in: client/apis/DevelopAPI.ts:467

---

removeUserFromUniverseTeamCreate

▸ removeUserFromUniverseTeamCreate(options: RemoveUserFromUniverseTeamCreateOptions): Promise<unknown>

Parameters:

Name	Type
options	RemoveUserFromUniverseTeamCreateOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:790

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

searchToolbox

▸ searchToolbox(options: SearchToolboxOptions): Promise<SearchToolbox>

Parameters:

Name	Type
options	SearchToolboxOptions

Returns: Promise<SearchToolbox>

Defined in: client/apis/DevelopAPI.ts:588

---

searchUniverses

▸ searchUniverses(options: SearchUniversesOptions): Promise<SearchUniverses>

Parameters:

Name	Type
options	SearchUniversesOptions

Returns: Promise<SearchUniverses>

Defined in: client/apis/DevelopAPI.ts:568

---

setStudioData

▸ setStudioData(options: SetStudioDataOptions): Promise<SetStudioData>

Parameters:

Name	Type
options	SetStudioDataOptions

Returns: Promise<SetStudioData>

Defined in: client/apis/DevelopAPI.ts:861

---

updateDeveloperProduct

▸ updateDeveloperProduct(options: UpdateDeveloperProductOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateDeveloperProductOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:938

---

updatePlaceConfiguration

▸ updatePlaceConfiguration(options: UpdatePlaceConfigurationOptions): Promise<UpdatePlaceConfiguration>

Parameters:

Name	Type
options	UpdatePlaceConfigurationOptions

Returns: Promise<UpdatePlaceConfiguration>

Defined in: client/apis/DevelopAPI.ts:516

---

updatePlugin

▸ updatePlugin(options: UpdatePluginOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdatePluginOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:555

---

updateUniverseAlias

▸ updateUniverseAlias(options: CreateUniverseAliasOptions): Promise<unknown>

Parameters:

Name	Type
options	CreateUniverseAliasOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:912

---

updateUniverseConfiguration

▸ updateUniverseConfiguration(options: UpdateUniverseConfigurationOptions): Promise<GetUniverseConfiguration>

Parameters:

Name	Type
options	UpdateUniverseConfigurationOptions

Returns: Promise<GetUniverseConfiguration>

Defined in: client/apis/DevelopAPI.ts:742

---

updateUniverseTeamCreateSettings

▸ updateUniverseTeamCreateSettings(options: GetUniverseTeamCreateSettingsOptions): Promise<unknown>

Parameters:

Name	Type
options	GetUniverseTeamCreateSettingsOptions

Returns: Promise<unknown>

Defined in: client/apis/DevelopAPI.ts:777