Skip to content

Module: client/apis/DevelopAPI

Table of contents

Classes

Type aliases

Type aliases

ActivateUniverse

Ƭ ActivateUniverse: unknown

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

ActivateUniverseOptions

Ƭ ActivateUniverseOptions: object

Type declaration:

Name Type
universeId number

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

CreateDeveloperProduct

Ƭ CreateDeveloperProduct: object

Type declaration:

Name Type
Description string
iconImageAssetId number
id number
name string
shopId number

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

CreateDeveloperProductOptions

Ƭ CreateDeveloperProductOptions: object

Type declaration:

Name Type
description string
iconImageAssetId? number
name string
priceInRobux number
universeId number

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

CreateUniverseAlias

Ƭ CreateUniverseAlias: unknown

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

CreateUniverseAliasOptions

Ƭ CreateUniverseAliasOptions: object

Type declaration:

Name Type
name string
targetId number
type Asset | string

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

DeactivateUniverse

Ƭ DeactivateUniverse: unknown

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

DeactivateUniverseOptions

Ƭ DeactivateUniverseOptions: object

Type declaration:

Name Type
universeId number

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

DeleteUniverseAlias

Ƭ DeleteUniverseAlias: unknown

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

DeleteUniverseAliasOptions

Ƭ DeleteUniverseAliasOptions: object

Type declaration:

Name Type
name string
universeId number

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

DownloadUniverseStatisticsReportByTime

Ƭ DownloadUniverseStatisticsReportByTime: unknown

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

DownloadUniverseStatisticsReportByTimeOptions

Ƭ DownloadUniverseStatisticsReportByTimeOptions: object

Type declaration:

Name Type
universeId number
yearDashMonth string

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

FilterPublishGameNotification

Ƭ FilterPublishGameNotification: object

Type declaration:

Name Type
filteredGameUpdateText string
isFiltered boolean
moderationLevel number

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

FilterPublishGameNotificationOptions

Ƭ FilterPublishGameNotificationOptions: object

Type declaration:

Name Type
text string

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

GenerateUniverseStatisticReportsByTime

Ƭ GenerateUniverseStatisticReportsByTime: unknown

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

GenerateUniverseStatisticReportsByTimeOptions

Ƭ GenerateUniverseStatisticReportsByTimeOptions: object

Type declaration:

Name Type
universeId number
yearDashMonth string

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

GetAssetsVoteInformation

Ƭ GetAssetsVoteInformation: object

Type declaration:

Name Type
data { assetId: number ; canUserVote: number ; downVotes: number ; hasUserVoted: number ; reasonForNotAbleToVote: string ; shouldShowVote: boolean ; upVotes: number }[]

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

GetAssetsVoteInformationOptions

Ƭ GetAssetsVoteInformationOptions: object

Type declaration:

Name Type
assetIds number[]

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

GetGameTemplates

Ƭ GetGameTemplates: { gameTemplateType: string ; hasTutorials: boolean ; universe: GameUniverseOptions }[]

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

GetGameUpdatesHistory

Ƭ GetGameUpdatesHistory: { content: string ; createdOn: string ; createdOnKey: string ; creatorId: number ; creatorName: string ; creatorType: string ; expiredOn: string ; impressions: number ; plays: number ; unfollows: number ; universeId: number }[]

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

GetGameUpdatesHistoryOptions

Ƭ GetGameUpdatesHistoryOptions: object

Type declaration:

Name Type
universeId number

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

GetGroupUniverses

Ƭ GetGroupUniverses: object

Type declaration:

Name Type
data { created: string ; creatorName: string ; creatorTargetId: null ; creatorType: Group | string ; description: string ; id: number ; isActive: boolean ; isArchived: boolean ; name: string ; privacyType: Private | string ; rootPlaceId: number | null ; updated: string }[]
nextPageCursor string
previousPageCursor string

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

GetGroupUniversesOptions

Ƭ GetGroupUniversesOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

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

GetNotificationsStatisticReports

Ƭ GetNotificationsStatisticReports: object

Type declaration:

Name Type
data { Expires: number ; GameName: string ; RootPlaceId: number ; UniverseId: number ; UserId: number }[]

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

GetPlaceCompatibilities

Ƭ GetPlaceCompatibilities: object

Type declaration:

Name Type
Compatibilities { crashRatePercentage: number ; platformName: string ; status: Good | string }[]

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

GetPlaceCompatibilitiesOptions

Ƭ GetPlaceCompatibilitiesOptions: object

Type declaration:

Name Type
placeId number

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

GetPlaceStatisticsByType

Ƭ GetPlaceStatisticsByType: object

Type declaration:

Name Type
data unknown
dataGranularity GetPlaceStatisticsByTypeOptions[granularity]
dataType GetPlaceStatisticsByTypeOptions[type]
endTime string
placeId number
startTime string

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

GetPlaceStatisticsByTypeOptions

Ƭ GetPlaceStatisticsByTypeOptions: object

Type declaration:

Name Type
divisionType? Device | Age
endTime? string
granularity? Hourly | Daily | Monthly
placeId number
startTime? string
type Revenue | RevenuePerVisit | AverageVisitLength | Visits

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

GetPluginsById

Ƭ GetPluginsById: object

Type declaration:

Name Type
data { commentsEnabled: boolean ; created: string ; description: string ; id: number ; name: string ; updated: string ; versionId: number }[]

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

GetPluginsByIdOptions

Ƭ GetPluginsByIdOptions: object

Type declaration:

Name Type
pluginIds number[]

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

GetSelfGroupsAccess

Ƭ GetSelfGroupsAccess: object

Type declaration:

Name Type
data PartialGroupOptions[]

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

GetSelfTeamCreateUniversesAccess

Ƭ GetSelfTeamCreateUniversesAccess: object

Type declaration:

Name Type
data GameUniverseOptions[]
nextPageCursor string
previousPageCursor string

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

GetSelfTeamCreateUniversesAccessOptions

Ƭ GetSelfTeamCreateUniversesAccessOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

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

GetSelfUniverses

Ƭ GetSelfUniverses: object

Type declaration:

Name Type
data GameUniverseOptions[]
nextPageCursor string
previousPageCursor string

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

GetSelfUniversesOptions

Ƭ GetSelfUniversesOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

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

GetStudioData

Ƭ GetStudioData: unknown

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

GetStudioDataOptions

Ƭ GetStudioDataOptions: object

Type declaration:

Name Type
clientKey string

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

GetUniverse

Ƭ GetUniverse: GameUniverseOptions

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

GetUniverseConfiguration

Ƭ GetUniverseConfiguration: object

Type declaration:

Name Type
genre All | string
id number
isArchived boolean
isForSale boolean
isFriendsOnly boolean
name string
playableDevices (Computer | string)[]
price number
universeAnimationType Standard | string
universeAvatarType MorphToR6 | MorphToR15
universeBodyType Standard | string
universeCollisionType InnerBox | string
universeJointPositioningType Standard | string
universeScaleType NoScales | string

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

GetUniverseConfigurationOptions

Ƭ GetUniverseConfigurationOptions: object

Type declaration:

Name Type
universeId number

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

GetUniverseOptions

Ƭ GetUniverseOptions: object

Type declaration:

Name Type
universeId number

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

GetUniversePermissions

Ƭ GetUniversePermissions: object

Type declaration:

Name Type
canCloudEdit boolean
canManage boolean

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

GetUniversePermissionsOptions

Ƭ GetUniversePermissionsOptions: object

Type declaration:

Name Type
universeId number

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

GetUniversePlaces

Ƭ GetUniversePlaces: object

Type declaration:

Name Type
data unknown[]
nextPageCursor string
previousPageCursor string

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

GetUniversePlacesOptions

Ƭ GetUniversePlacesOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
universeId number

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

GetUniverseStatisticsReportByTime

Ƭ GetUniverseStatisticsReportByTime: object

Type declaration:

Name Type
spreadsheetId string
status NotGenerated | string
universeId number
yearDashMonth string

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

GetUniverseStatisticsReports

Ƭ GetUniverseStatisticsReports: object

Type declaration:

Name Type
reports { spreadsheetId: string ; status: NotGenerated | string ; universeId: number ; yearDashMonth: string }[]

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

GetUniverseStatisticsReportsByTimeOptions

Ƭ GetUniverseStatisticsReportsByTimeOptions: object

Type declaration:

Name Type
universeId number
yearDashMonth string

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

GetUniverseStatisticsReportsOptions

Ƭ GetUniverseStatisticsReportsOptions: object

Type declaration:

Name Type
universeId number

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

GetUniverseTeamCreateSettings

Ƭ GetUniverseTeamCreateSettings: object

Type declaration:

Name Type
isEnabled boolean

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

GetUniverseTeamCreateSettingsOptions

Ƭ GetUniverseTeamCreateSettingsOptions: object

Type declaration:

Name Type
universeId number

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

GetUniverseVIPServersConfiguration

Ƭ GetUniverseVIPServersConfiguration: object

Type declaration:

Name Type
activeServersCount number
activeSubscriptionsCount number
isEnabled boolean
price number

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

GetUniverseVIPServersConfigurationOptions

Ƭ GetUniverseVIPServersConfigurationOptions: object

Type declaration:

Name Type
universeId number

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

GetUsersInUniverseTeamCreate

Ƭ GetUsersInUniverseTeamCreate: object

Type declaration:

Name Type
data { buildersClubMembershipType: None | string ; displayName: string ; userId: number ; username: string }[]
nextPageCursor string
previousPageCursor string

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

GetUsersInUniverseTeamCreateOptions

Ƭ GetUsersInUniverseTeamCreateOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
universeId number

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

MultiGetUniverses

Ƭ MultiGetUniverses: GameUniverseOptions[]

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

MultiGetUniversesOptions

Ƭ MultiGetUniversesOptions: object

Type declaration:

Name Type
ids number[]

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

MultiGetUniversesPermissions

Ƭ MultiGetUniversesPermissions: object

Type declaration:

Name Type
data { canCloudEdit: boolean ; canManage: boolean ; universeId: number }[]

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

MultiGetUniversesPermissionsOptions

Ƭ MultiGetUniversesPermissionsOptions: object

Type declaration:

Name Type
ids number[]

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

PublishGameNotification

Ƭ PublishGameNotification: GetGameUpdatesHistory

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

PublishGameNotificationOptions

Ƭ PublishGameNotificationOptions: object

Type declaration:

Name Type
gameUpdateText unknown
universeId number

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

RemoveUserFromUniverseTeamCreate

Ƭ RemoveUserFromUniverseTeamCreate: unknown

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

RemoveUserFromUniverseTeamCreateOptions

Ƭ RemoveUserFromUniverseTeamCreateOptions: object

Type declaration:

Name Type
universeId number
userId number

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

SearchToolbox

Ƭ SearchToolbox: object

Type declaration:

Name Type
Results { Asset: { AssetGenres: string[] ; Created: string ; CreatedRaw: string ; Description: string ; Duration: number ; Id: number ; IsEndorsed: boolean ; Name: string ; TypeId: number ; Updated: string ; UpdatedRaw: string } ; Creator: { Id: number ; Name: string ; Type: number } ; Thumbnail: { EndpointType: string ; Final: boolean ; RetryUrl: string ; Url: string ; UserId: number } ; Voting: { CanVote: boolean ; DownVotes: number ; HasVoted: number ; Product: { Price: number ; ProductId: number } ; ReasonForNotVoteable: string ; ShowVotes: boolean ; UpVotes: number ; UserVote: boolean } }[]
TotalResults number

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

SearchToolboxOptions

Ƭ SearchToolboxOptions: object

Type declaration:

Name Type
cacheMode? Normal | Bypass | ForceUpdate
category string
creatorId? number
groupId? number
keyword? string
num? number
page? number
sort? string

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

SearchUniverseData

Ƭ SearchUniverseData: object

Type declaration:

Name Type
created string
creatorName string
creatorTargetId number
creatorType User | Group
description string
id number
isActive boolean
isArchived boolean
name string
privacyType Public | Private
rootPlaceId number
updated string

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

SearchUniverses

Ƭ SearchUniverses: object

Type declaration:

Name Type
data SearchUniverseData[]
nextPageCursor string | null
previousPageCursor string | null

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

SearchUniversesOptions

Ƭ SearchUniversesOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
q object
q.active? boolean
q.archived? boolean
q.creator user | group | team
q.groups? unknown[]
q.search? string
sort? (+GameCreated | -GameCreated | +GameName | -GameName | +RootPlaceName | -RootPlaceName | +RootPlaceUpdated | -RootPlaceUpdated | +LastUpdated | -LastUpdated)[]
sortOrder? Asc | Desc

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

SetStudioData

Ƭ SetStudioData: object

Type declaration:

Name Type
success boolean

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

SetStudioDataOptions

Ƭ SetStudioDataOptions: object

Type declaration:

Name Type
clientKey string
data unknown

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

UpdateDeveloperProduct

Ƭ UpdateDeveloperProduct: unknown

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

UpdateDeveloperProductOptions

Ƭ UpdateDeveloperProductOptions: object

Type declaration:

Name Type
Description string
IconImageAssetId? number
Name string
PriceInRobux number
developerProductId number
universeId number

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

UpdatePlaceConfiguration

Ƭ UpdatePlaceConfiguration: object

Type declaration:

Name Type
description string
id number
name string
universeId number

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

UpdatePlaceConfigurationOptions

Ƭ UpdatePlaceConfigurationOptions: object

Type declaration:

Name Type
description string
name string
placeId number

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

UpdatePlugin

Ƭ UpdatePlugin: unknown

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

UpdatePluginOptions

Ƭ UpdatePluginOptions: object

Type declaration:

Name Type
commentsEnabled boolean
description string
name string
pluginId number

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

UpdateUniverseAlias

Ƭ UpdateUniverseAlias: unknown

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

UpdateUniverseAliasOptions

Ƭ UpdateUniverseAliasOptions: CreateUniverseAliasOptions

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

UpdateUniverseConfiguration

Ƭ UpdateUniverseConfiguration: GetUniverseConfiguration

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

UpdateUniverseConfigurationOptions

Ƭ UpdateUniverseConfigurationOptions: Omit<GetUniverseConfiguration, id> & { universeId: number }

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

UpdateUniverseTeamCreateSettings

Ƭ UpdateUniverseTeamCreateSettings: unknown

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

UpdateUniverseTeamCreateSettingsOptions

Ƭ UpdateUniverseTeamCreateSettingsOptions: GetUniverseTeamCreateSettingsOptions

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