@jacobhumston/roblox-openapi-ts 1.0.23 → 1.0.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types.d.ts +489 -150
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -9718,6 +9718,57 @@ export interface paths {
|
|
|
9718
9718
|
patch?: never;
|
|
9719
9719
|
trace?: never;
|
|
9720
9720
|
};
|
|
9721
|
+
"/place-version-history-api/v1/{placeId}/contributors": {
|
|
9722
|
+
parameters: {
|
|
9723
|
+
query?: never;
|
|
9724
|
+
header?: never;
|
|
9725
|
+
path?: never;
|
|
9726
|
+
cookie?: never;
|
|
9727
|
+
};
|
|
9728
|
+
/** Endpoint used to fetch all previous contributors of a place. */
|
|
9729
|
+
get: operations["PlaceVersion_GetPlaceContributors"];
|
|
9730
|
+
put?: never;
|
|
9731
|
+
post?: never;
|
|
9732
|
+
delete?: never;
|
|
9733
|
+
options?: never;
|
|
9734
|
+
head?: never;
|
|
9735
|
+
patch?: never;
|
|
9736
|
+
trace?: never;
|
|
9737
|
+
};
|
|
9738
|
+
"/place-version-history-api/v1/{placeId}/history": {
|
|
9739
|
+
parameters: {
|
|
9740
|
+
query?: never;
|
|
9741
|
+
header?: never;
|
|
9742
|
+
path?: never;
|
|
9743
|
+
cookie?: never;
|
|
9744
|
+
};
|
|
9745
|
+
/** Endpoint used to get place versions, using various filters */
|
|
9746
|
+
get: operations["PlaceVersion_GetPlaceVersionHistory"];
|
|
9747
|
+
put?: never;
|
|
9748
|
+
post?: never;
|
|
9749
|
+
delete?: never;
|
|
9750
|
+
options?: never;
|
|
9751
|
+
head?: never;
|
|
9752
|
+
patch?: never;
|
|
9753
|
+
trace?: never;
|
|
9754
|
+
};
|
|
9755
|
+
"/place-version-history-api/v1/{placeId}/version/{version}/notes": {
|
|
9756
|
+
parameters: {
|
|
9757
|
+
query?: never;
|
|
9758
|
+
header?: never;
|
|
9759
|
+
path?: never;
|
|
9760
|
+
cookie?: never;
|
|
9761
|
+
};
|
|
9762
|
+
get?: never;
|
|
9763
|
+
put?: never;
|
|
9764
|
+
/** Endpoint used to modify the notes of a particular version for a place. */
|
|
9765
|
+
post: operations["PlaceVersion_UpdatePlaceVersionNotes"];
|
|
9766
|
+
delete?: never;
|
|
9767
|
+
options?: never;
|
|
9768
|
+
head?: never;
|
|
9769
|
+
patch?: never;
|
|
9770
|
+
trace?: never;
|
|
9771
|
+
};
|
|
9721
9772
|
"/server-management/v1/universes/{universeId}/places/{placeId}/game-servers:filter-options": {
|
|
9722
9773
|
parameters: {
|
|
9723
9774
|
query?: never;
|
|
@@ -9752,6 +9803,23 @@ export interface paths {
|
|
|
9752
9803
|
patch?: never;
|
|
9753
9804
|
trace?: never;
|
|
9754
9805
|
};
|
|
9806
|
+
"/server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers/{jobId}/logs": {
|
|
9807
|
+
parameters: {
|
|
9808
|
+
query?: never;
|
|
9809
|
+
header?: never;
|
|
9810
|
+
path?: never;
|
|
9811
|
+
cookie?: never;
|
|
9812
|
+
};
|
|
9813
|
+
/** Lists game server logs for a specific server job id */
|
|
9814
|
+
get: operations["GameServers_ListGameServerLogs"];
|
|
9815
|
+
put?: never;
|
|
9816
|
+
post?: never;
|
|
9817
|
+
delete?: never;
|
|
9818
|
+
options?: never;
|
|
9819
|
+
head?: never;
|
|
9820
|
+
patch?: never;
|
|
9821
|
+
trace?: never;
|
|
9822
|
+
};
|
|
9755
9823
|
"/server-management/v1/universes/{universeId}/restarts": {
|
|
9756
9824
|
parameters: {
|
|
9757
9825
|
query?: never;
|
|
@@ -18638,75 +18706,6 @@ export interface paths {
|
|
|
18638
18706
|
patch?: never;
|
|
18639
18707
|
trace?: never;
|
|
18640
18708
|
};
|
|
18641
|
-
"/v1/games/{placeId}/servers/{serverType}": {
|
|
18642
|
-
parameters: {
|
|
18643
|
-
query?: never;
|
|
18644
|
-
header?: never;
|
|
18645
|
-
path?: never;
|
|
18646
|
-
cookie?: never;
|
|
18647
|
-
};
|
|
18648
|
-
/** Get the game server list */
|
|
18649
|
-
get: {
|
|
18650
|
-
parameters: {
|
|
18651
|
-
query?: {
|
|
18652
|
-
/** @description The sort order of the servers. */
|
|
18653
|
-
sortOrder?: 1 | 2;
|
|
18654
|
-
/** @description Exclude full servers. */
|
|
18655
|
-
excludeFullGames?: boolean;
|
|
18656
|
-
/** @description The number of results per request. */
|
|
18657
|
-
limit?: 10 | 25 | 50 | 100;
|
|
18658
|
-
/** @description The paging cursor for the previous or next page. */
|
|
18659
|
-
cursor?: string;
|
|
18660
|
-
};
|
|
18661
|
-
header?: never;
|
|
18662
|
-
path: {
|
|
18663
|
-
/** @description The Id of the place we are geting the server list for. */
|
|
18664
|
-
placeId: number;
|
|
18665
|
-
/** @description The type of the server we geting the server list for. */
|
|
18666
|
-
serverType: 0 | 1;
|
|
18667
|
-
};
|
|
18668
|
-
cookie?: never;
|
|
18669
|
-
};
|
|
18670
|
-
requestBody?: never;
|
|
18671
|
-
responses: {
|
|
18672
|
-
/** @description OK */
|
|
18673
|
-
200: {
|
|
18674
|
-
headers: {
|
|
18675
|
-
[name: string]: unknown;
|
|
18676
|
-
};
|
|
18677
|
-
content: {
|
|
18678
|
-
"application/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Web.Responses.Games.GameServerResponse_"];
|
|
18679
|
-
"text/json": components["schemas"]["Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Web.Responses.Games.GameServerResponse_"];
|
|
18680
|
-
};
|
|
18681
|
-
};
|
|
18682
|
-
/**
|
|
18683
|
-
* @description 1: The place is invalid.
|
|
18684
|
-
* 6: The server type is invalid. For fetching private servers, please use https://games.roblox.com/v1/games/{placeId}/private-servers.
|
|
18685
|
-
* 7: Guest users are not allowed.
|
|
18686
|
-
*/
|
|
18687
|
-
400: {
|
|
18688
|
-
headers: {
|
|
18689
|
-
[name: string]: unknown;
|
|
18690
|
-
};
|
|
18691
|
-
content?: never;
|
|
18692
|
-
};
|
|
18693
|
-
/** @description 1: The place is invalid. */
|
|
18694
|
-
404: {
|
|
18695
|
-
headers: {
|
|
18696
|
-
[name: string]: unknown;
|
|
18697
|
-
};
|
|
18698
|
-
content?: never;
|
|
18699
|
-
};
|
|
18700
|
-
};
|
|
18701
|
-
};
|
|
18702
|
-
put?: never;
|
|
18703
|
-
post?: never;
|
|
18704
|
-
delete?: never;
|
|
18705
|
-
options?: never;
|
|
18706
|
-
head?: never;
|
|
18707
|
-
patch?: never;
|
|
18708
|
-
trace?: never;
|
|
18709
|
-
};
|
|
18710
18709
|
"/v1/games/{universeId}/favorites": {
|
|
18711
18710
|
parameters: {
|
|
18712
18711
|
query?: never;
|
|
@@ -32257,6 +32256,8 @@ export interface paths {
|
|
|
32257
32256
|
query: {
|
|
32258
32257
|
/** @description CSV for the userIds to get avatar full body shots */
|
|
32259
32258
|
userIds: number[];
|
|
32259
|
+
/** @description Whether to include a background in the thumbnail (defaults to false) */
|
|
32260
|
+
includeBackground?: boolean;
|
|
32260
32261
|
/** @description The thumbnail size, formatted widthxheight */
|
|
32261
32262
|
size?: "30x30" | "48x48" | "60x60" | "75x75" | "100x100" | "110x110" | "140x140" | "150x150" | "150x200" | "180x180" | "250x250" | "352x352" | "420x420" | "720x720";
|
|
32262
32263
|
/** @description The thumbnail format */
|
|
@@ -32357,6 +32358,8 @@ export interface paths {
|
|
|
32357
32358
|
query: {
|
|
32358
32359
|
/** @description CSV for the userIds to get avatar headshots */
|
|
32359
32360
|
userIds: number[];
|
|
32361
|
+
/** @description Whether to include a background in the thumbnail (defaults to false) */
|
|
32362
|
+
includeBackground?: boolean;
|
|
32360
32363
|
/** @description The thumbnail size, formatted widthxheight */
|
|
32361
32364
|
size?: "48x48" | "50x50" | "60x60" | "75x75" | "100x100" | "150x150" | "180x180" | "352x352" | "420x420";
|
|
32362
32365
|
/** @description The thumbnail format */
|
|
@@ -32413,6 +32416,8 @@ export interface paths {
|
|
|
32413
32416
|
query: {
|
|
32414
32417
|
/** @description CSV for the userIds to get avatar headshots */
|
|
32415
32418
|
userIds: number[];
|
|
32419
|
+
/** @description Whether to include a background in the thumbnail (defaults to false) */
|
|
32420
|
+
includeBackground?: boolean;
|
|
32416
32421
|
/** @description The thumbnail size, formatted widthxheight */
|
|
32417
32422
|
size?: "48x48" | "50x50" | "60x60" | "75x75" | "100x100" | "110x110" | "150x150" | "180x180" | "352x352" | "420x420" | "720x720";
|
|
32418
32423
|
/** @description The thumbnail format */
|
|
@@ -32506,6 +32511,8 @@ export interface paths {
|
|
|
32506
32511
|
query: {
|
|
32507
32512
|
/** @description CSV for the userOutfitIds to get user outfits */
|
|
32508
32513
|
userOutfitIds: number[];
|
|
32514
|
+
/** @description Whether to include a background in the thumbnail (defaults to false) */
|
|
32515
|
+
includeBackground?: boolean;
|
|
32509
32516
|
/** @description The thumbnail size, formatted widthxheight */
|
|
32510
32517
|
size?: "150x150" | "420x420";
|
|
32511
32518
|
/** @description The thumbnail format */
|
|
@@ -43029,8 +43036,11 @@ export interface components {
|
|
|
43029
43036
|
universeId: number;
|
|
43030
43037
|
/** @description Whether the developer product is currently on sale. */
|
|
43031
43038
|
isForSale: boolean;
|
|
43032
|
-
/**
|
|
43033
|
-
|
|
43039
|
+
/**
|
|
43040
|
+
* @deprecated
|
|
43041
|
+
* @description Whether the developer product is currently available for purchase on the external store page.
|
|
43042
|
+
*/
|
|
43043
|
+
storePageEnabled?: boolean | null;
|
|
43034
43044
|
/** @description The pricing configuration associated with the product. */
|
|
43035
43045
|
priceInformation: components["schemas"]["PriceInformationStruct"] | null;
|
|
43036
43046
|
/** @description Whether the developer product cannot be modified, such as when created as a commerce product. */
|
|
@@ -43247,6 +43257,45 @@ export interface components {
|
|
|
43247
43257
|
name?: string | null;
|
|
43248
43258
|
rootPlace?: components["schemas"]["PlaceResponse"] | null;
|
|
43249
43259
|
};
|
|
43260
|
+
/** @description Response model for listing a game server log */
|
|
43261
|
+
GameServerLog: {
|
|
43262
|
+
/**
|
|
43263
|
+
* Format: date-time
|
|
43264
|
+
* @description The timestamp the log was received
|
|
43265
|
+
*/
|
|
43266
|
+
messageTimestampMs?: string;
|
|
43267
|
+
/**
|
|
43268
|
+
* Format: int64
|
|
43269
|
+
* @description The universe where the log was created
|
|
43270
|
+
*/
|
|
43271
|
+
universeId?: number;
|
|
43272
|
+
/** @description The place where the log was created */
|
|
43273
|
+
placeId?: string | null;
|
|
43274
|
+
/** @description The place version on which the log was created */
|
|
43275
|
+
placeVersion?: string | null;
|
|
43276
|
+
/** @description The Game Server id where the log was created */
|
|
43277
|
+
jobId?: string | null;
|
|
43278
|
+
/** @description The severity of the log */
|
|
43279
|
+
severity?: components["schemas"]["LogSeverity"];
|
|
43280
|
+
/** @description The log message */
|
|
43281
|
+
message?: string | null;
|
|
43282
|
+
/** @description The stack trace of the log */
|
|
43283
|
+
stackTrace?: string | null;
|
|
43284
|
+
/** @description Optional message template included with structured logging */
|
|
43285
|
+
messageTemplate?: string | null;
|
|
43286
|
+
/** @description Optional message context included with structured logging */
|
|
43287
|
+
context?: string | null;
|
|
43288
|
+
/**
|
|
43289
|
+
* Format: int32
|
|
43290
|
+
* @description How many duplicate versions of this message were present in the same time window as this log
|
|
43291
|
+
*/
|
|
43292
|
+
skippedCount?: number;
|
|
43293
|
+
/**
|
|
43294
|
+
* Format: int32
|
|
43295
|
+
* @description How many more messages were present in the time window beyond our overall rate limits
|
|
43296
|
+
*/
|
|
43297
|
+
rateLimitedCount?: number;
|
|
43298
|
+
};
|
|
43250
43299
|
GameServerResponse: {
|
|
43251
43300
|
/** Format: uuid */
|
|
43252
43301
|
id?: string | null;
|
|
@@ -43407,6 +43456,16 @@ export interface components {
|
|
|
43407
43456
|
TextChat?: number;
|
|
43408
43457
|
} | null;
|
|
43409
43458
|
};
|
|
43459
|
+
GetPlaceContributorsResponse: {
|
|
43460
|
+
nextCursor?: string | null;
|
|
43461
|
+
hasMore?: boolean;
|
|
43462
|
+
contributors?: number[] | null;
|
|
43463
|
+
};
|
|
43464
|
+
GetPlaceVersionHistoryResponse: {
|
|
43465
|
+
nextCursor?: string | null;
|
|
43466
|
+
hasMore?: boolean;
|
|
43467
|
+
placeVersions?: components["schemas"]["PlaceVersion"][] | null;
|
|
43468
|
+
};
|
|
43410
43469
|
GetPrivateServerListResponse: {
|
|
43411
43470
|
data?: components["schemas"]["GameServerResponse"][] | null;
|
|
43412
43471
|
previousPageCursor?: string | null;
|
|
@@ -44437,6 +44496,16 @@ export interface components {
|
|
|
44437
44496
|
/** @description The next page token. */
|
|
44438
44497
|
nextPageToken: string | null;
|
|
44439
44498
|
};
|
|
44499
|
+
/** @description Response model for listing game servers. */
|
|
44500
|
+
ListGameServerLogsResponse: {
|
|
44501
|
+
/** @description The GameServers from the specified PlaceVersion. */
|
|
44502
|
+
gameServerLogs?: components["schemas"]["GameServerLog"][] | null;
|
|
44503
|
+
/**
|
|
44504
|
+
* @description A token that you can send as a `pageToken` parameter to retrieve the next
|
|
44505
|
+
* page. If this field is omitted, there are no subsequent pages.
|
|
44506
|
+
*/
|
|
44507
|
+
nextPageToken?: string | null;
|
|
44508
|
+
};
|
|
44440
44509
|
/** @description A list of GroupForumCategories in the parent collection. */
|
|
44441
44510
|
ListGroupForumCategoriesResponse: {
|
|
44442
44511
|
/** @description The GroupForumCategories from the specified Group. */
|
|
@@ -44619,6 +44688,13 @@ export interface components {
|
|
|
44619
44688
|
doubleValue?: string | null;
|
|
44620
44689
|
stringValue?: string | null;
|
|
44621
44690
|
};
|
|
44691
|
+
/**
|
|
44692
|
+
* Format: int32
|
|
44693
|
+
* @description Defines the various log severity types with values:
|
|
44694
|
+
* Output (0), Info (1), Warning (2), Error (3)
|
|
44695
|
+
* @enum {integer}
|
|
44696
|
+
*/
|
|
44697
|
+
LogSeverity: 0 | 1 | 2 | 3;
|
|
44622
44698
|
/**
|
|
44623
44699
|
* @description A `LuauExecutionSessionTask` ("task" for short) executes a given Luau script
|
|
44624
44700
|
* in the context of a specific version of a place.
|
|
@@ -45494,6 +45570,12 @@ export interface components {
|
|
|
45494
45570
|
*/
|
|
45495
45571
|
response?: components["schemas"]["GoogleProtobufAny"];
|
|
45496
45572
|
};
|
|
45573
|
+
OperationErrorResponse: {
|
|
45574
|
+
/** Format: int32 */
|
|
45575
|
+
readonly code?: number;
|
|
45576
|
+
readonly error?: string | null;
|
|
45577
|
+
message?: string | null;
|
|
45578
|
+
};
|
|
45497
45579
|
/** @description A key-value entry in an ordered data store. */
|
|
45498
45580
|
OrderedDataStoreEntry: {
|
|
45499
45581
|
/**
|
|
@@ -45775,6 +45857,20 @@ export interface components {
|
|
|
45775
45857
|
/** @description The versions of the place that will be closed during the update */
|
|
45776
45858
|
placeVersionsToBeClosed?: number[] | null;
|
|
45777
45859
|
};
|
|
45860
|
+
PlaceVersion: {
|
|
45861
|
+
version?: string | null;
|
|
45862
|
+
title?: string | null;
|
|
45863
|
+
description?: string | null;
|
|
45864
|
+
contributors?: number[] | null;
|
|
45865
|
+
saveType?: components["schemas"]["SaveType"];
|
|
45866
|
+
isPublished?: boolean;
|
|
45867
|
+
publishStatus?: components["schemas"]["PublishStatus"];
|
|
45868
|
+
hasNotes?: boolean;
|
|
45869
|
+
/** Format: date-time */
|
|
45870
|
+
createdTime?: string;
|
|
45871
|
+
/** Format: int64 */
|
|
45872
|
+
createdBy?: number | null;
|
|
45873
|
+
};
|
|
45778
45874
|
/** @description The player categorical signal configuration. */
|
|
45779
45875
|
PlayerCategoricalSignalConfiguration: {
|
|
45780
45876
|
playerAttribute?: components["schemas"]["MatchmakingAttributeReference"];
|
|
@@ -45958,6 +46054,11 @@ export interface components {
|
|
|
45958
46054
|
/** @description The message content that you want to publish to the live server. */
|
|
45959
46055
|
message?: string | null;
|
|
45960
46056
|
};
|
|
46057
|
+
/**
|
|
46058
|
+
* Format: int32
|
|
46059
|
+
* @enum {integer}
|
|
46060
|
+
*/
|
|
46061
|
+
PublishStatus: 0 | 1 | 2;
|
|
45961
46062
|
/** @description Publish a message on the specified topic. */
|
|
45962
46063
|
PublishUniverseMessageRequest: {
|
|
45963
46064
|
/**
|
|
@@ -50348,15 +50449,6 @@ export interface components {
|
|
|
50348
50449
|
settingTargetId?: number;
|
|
50349
50450
|
settingTargetCode?: string;
|
|
50350
50451
|
};
|
|
50351
|
-
/** @description A response model representing a game server player. */
|
|
50352
|
-
"Roblox.Games.Api.GameServerPlayerResponse": {
|
|
50353
|
-
/** @description The thumbnail token for the player. */
|
|
50354
|
-
playerToken?: string;
|
|
50355
|
-
/** Format: int64 */
|
|
50356
|
-
id?: number;
|
|
50357
|
-
name?: string;
|
|
50358
|
-
displayName?: string;
|
|
50359
|
-
};
|
|
50360
50452
|
/** @description Game favorite request model. */
|
|
50361
50453
|
"Roblox.Games.Api.Models.Request.GameFavoritesRequest": {
|
|
50362
50454
|
/** @description true for favor the game, false for unfavor the game. */
|
|
@@ -50481,6 +50573,13 @@ export interface components {
|
|
|
50481
50573
|
* It must be the same as the canonical URL (rel-canonical meta tag) on the game's EDP.
|
|
50482
50574
|
*/
|
|
50483
50575
|
canonicalUrlPath?: string;
|
|
50576
|
+
/**
|
|
50577
|
+
* @description Indicates whether this experience is content-restricted and has had its details wiped.
|
|
50578
|
+
* When true, the content fields (name, description, creator, etc.) contain placeholder or
|
|
50579
|
+
* empty values rather than the real data. Consumers should branch on this flag instead of
|
|
50580
|
+
* inferring restriction from placeholder text.
|
|
50581
|
+
*/
|
|
50582
|
+
isContentRestricted?: boolean;
|
|
50484
50583
|
};
|
|
50485
50584
|
/** @description Game favorite response model. */
|
|
50486
50585
|
"Roblox.Games.Api.Models.Response.GameFavoriteResponse": {
|
|
@@ -50701,6 +50800,11 @@ export interface components {
|
|
|
50701
50800
|
unplayableDisplayText?: string;
|
|
50702
50801
|
playableUxTreatment?: components["schemas"]["Roblox.Games.Api.Models.Response.PlayableUxTreatment"];
|
|
50703
50802
|
upsellUxTreatment?: components["schemas"]["Roblox.Games.Api.Models.Response.UpsellUxTreatment"];
|
|
50803
|
+
/**
|
|
50804
|
+
* @description Whether the game supports demo play for users who have not purchased it.
|
|
50805
|
+
* Only set when PlayabilityStatus is PurchaseRequired or FiatPurchaseRequired.
|
|
50806
|
+
*/
|
|
50807
|
+
demoModeAvailable?: boolean;
|
|
50704
50808
|
};
|
|
50705
50809
|
"Roblox.Games.Api.Models.Response.PlayableUxTreatment": {
|
|
50706
50810
|
treatment?: string;
|
|
@@ -50757,15 +50861,6 @@ export interface components {
|
|
|
50757
50861
|
*/
|
|
50758
50862
|
bodyText?: string;
|
|
50759
50863
|
};
|
|
50760
|
-
/** @description A response model specific to multi-get user. */
|
|
50761
|
-
"Roblox.Games.Api.Models.Response.VerifiedBadgeUserResponse": {
|
|
50762
|
-
/** @description The user's verified badge status. */
|
|
50763
|
-
hasVerifiedBadge?: boolean;
|
|
50764
|
-
/** Format: int64 */
|
|
50765
|
-
id?: number;
|
|
50766
|
-
name?: string;
|
|
50767
|
-
displayName?: string;
|
|
50768
|
-
};
|
|
50769
50864
|
/** @description ApiPageResponse for blocked keywords */
|
|
50770
50865
|
"Roblox.Groups.Api.BlockedKeywordPageResponse_Roblox.Groups.Client.BlockedKeywordModel_": {
|
|
50771
50866
|
/**
|
|
@@ -52968,6 +53063,8 @@ export interface components {
|
|
|
52968
53063
|
accessContext?: string;
|
|
52969
53064
|
/** @description Head shape for dynamic head thumbnails (only relevant for Asset thumbnail types with dynamic head) */
|
|
52970
53065
|
headShape?: string;
|
|
53066
|
+
/** @description Whether to include a background in avatar thumbnails (defaults to false) */
|
|
53067
|
+
includeBackground?: boolean;
|
|
52971
53068
|
};
|
|
52972
53069
|
"Roblox.Trades.Api.CanTradeResponse": {
|
|
52973
53070
|
/** @description Returns true if you can trade with the given user. */
|
|
@@ -54022,51 +54119,6 @@ export interface components {
|
|
|
54022
54119
|
*/
|
|
54023
54120
|
placeVisits?: number;
|
|
54024
54121
|
};
|
|
54025
|
-
/** @description Game server list response model. */
|
|
54026
|
-
"Roblox.Web.Responses.Games.GameServerResponse": {
|
|
54027
|
-
/**
|
|
54028
|
-
* Format: uuid
|
|
54029
|
-
* @description The game server ID.
|
|
54030
|
-
*/
|
|
54031
|
-
id?: string;
|
|
54032
|
-
/**
|
|
54033
|
-
* Format: int32
|
|
54034
|
-
* @description The max number of players allowed to enter the server at the same time.
|
|
54035
|
-
*/
|
|
54036
|
-
maxPlayers?: number;
|
|
54037
|
-
/**
|
|
54038
|
-
* Format: int32
|
|
54039
|
-
* @description The number of players actively in the server.
|
|
54040
|
-
*/
|
|
54041
|
-
playing?: number;
|
|
54042
|
-
/** @description The thumbnail tokens for all the players in the server. */
|
|
54043
|
-
playerTokens?: string[];
|
|
54044
|
-
/** @description The players in the server. */
|
|
54045
|
-
players?: components["schemas"]["Roblox.Games.Api.GameServerPlayerResponse"][];
|
|
54046
|
-
/**
|
|
54047
|
-
* Format: double
|
|
54048
|
-
* @description The current frames per second the server is running at.
|
|
54049
|
-
*/
|
|
54050
|
-
fps?: number;
|
|
54051
|
-
/**
|
|
54052
|
-
* Format: int32
|
|
54053
|
-
* @description The game server ping time (measured in milliseconds).
|
|
54054
|
-
*/
|
|
54055
|
-
ping?: number;
|
|
54056
|
-
/** @description The name of the private server. */
|
|
54057
|
-
name?: string;
|
|
54058
|
-
/**
|
|
54059
|
-
* Format: int64
|
|
54060
|
-
* @description The private server ID.
|
|
54061
|
-
*/
|
|
54062
|
-
vipServerId?: number;
|
|
54063
|
-
/**
|
|
54064
|
-
* Format: uuid
|
|
54065
|
-
* @description The private server access code.
|
|
54066
|
-
*/
|
|
54067
|
-
accessCode?: string;
|
|
54068
|
-
owner?: components["schemas"]["Roblox.Games.Api.Models.Response.VerifiedBadgeUserResponse"];
|
|
54069
|
-
};
|
|
54070
54122
|
"Roblox.Web.Responses.Groups.GroupBasicResponse": {
|
|
54071
54123
|
/** Format: int64 */
|
|
54072
54124
|
id?: number;
|
|
@@ -54461,11 +54513,6 @@ export interface components {
|
|
|
54461
54513
|
nextPageCursor?: string;
|
|
54462
54514
|
data?: components["schemas"]["Roblox.Web.Responses.Games.GameResponseV2"][];
|
|
54463
54515
|
};
|
|
54464
|
-
"Roblox.Web.WebAPI.Models.ApiPageResponse_Roblox.Web.Responses.Games.GameServerResponse_": {
|
|
54465
|
-
previousPageCursor?: string;
|
|
54466
|
-
nextPageCursor?: string;
|
|
54467
|
-
data?: components["schemas"]["Roblox.Web.Responses.Games.GameServerResponse"][];
|
|
54468
|
-
};
|
|
54469
54516
|
RobuxRateBreakdown: {
|
|
54470
54517
|
/** Format: double */
|
|
54471
54518
|
o18?: number | null;
|
|
@@ -54500,6 +54547,11 @@ export interface components {
|
|
|
54500
54547
|
endDate?: string | null;
|
|
54501
54548
|
transactionType?: components["schemas"]["TransactionType"];
|
|
54502
54549
|
};
|
|
54550
|
+
/**
|
|
54551
|
+
* Format: int32
|
|
54552
|
+
* @enum {integer}
|
|
54553
|
+
*/
|
|
54554
|
+
SaveType: 0 | 1 | 2;
|
|
54503
54555
|
/**
|
|
54504
54556
|
* @description The category to sort the saves by.
|
|
54505
54557
|
* @enum {string}
|
|
@@ -55642,6 +55694,13 @@ export interface components {
|
|
|
55642
55694
|
UpdateMatchmakingServerAttributeDefinitionResponse: {
|
|
55643
55695
|
playerAttributeDefinition?: components["schemas"]["MatchmakingServerAttributeDefinition"];
|
|
55644
55696
|
};
|
|
55697
|
+
UpdatePlaceVersionNotesRequest: {
|
|
55698
|
+
title?: string | null;
|
|
55699
|
+
description?: string | null;
|
|
55700
|
+
};
|
|
55701
|
+
UpdatePlaceVersionNotesResponse: {
|
|
55702
|
+
placeVersion?: components["schemas"]["PlaceVersion"] | null;
|
|
55703
|
+
};
|
|
55645
55704
|
/** @description Represents any registered user of Roblox. */
|
|
55646
55705
|
User: {
|
|
55647
55706
|
/**
|
|
@@ -60723,6 +60782,7 @@ export interface operations {
|
|
|
60723
60782
|
*/
|
|
60724
60783
|
imageFile?: string | null;
|
|
60725
60784
|
/**
|
|
60785
|
+
* @deprecated
|
|
60726
60786
|
* @description Whether regional pricing should be enabled for the developer product.
|
|
60727
60787
|
* Should not be used when setting isManagedPricingEnabled.
|
|
60728
60788
|
*/
|
|
@@ -60876,11 +60936,15 @@ export interface operations {
|
|
|
60876
60936
|
*/
|
|
60877
60937
|
imageFile?: string | null;
|
|
60878
60938
|
/**
|
|
60939
|
+
* @deprecated
|
|
60879
60940
|
* @description Whether regional pricing should be enabled for the developer product.
|
|
60880
60941
|
* Should not be used when setting isManagedPricingEnabled.
|
|
60881
60942
|
*/
|
|
60882
60943
|
isRegionalPricingEnabled?: boolean | null;
|
|
60883
|
-
/**
|
|
60944
|
+
/**
|
|
60945
|
+
* @deprecated
|
|
60946
|
+
* @description Whether the developer product should be available for purchase on the external store page.
|
|
60947
|
+
*/
|
|
60884
60948
|
storePageEnabled?: boolean | null;
|
|
60885
60949
|
/** @description Whether managed pricing should be enabled for the developer product. */
|
|
60886
60950
|
isManagedPricingEnabled?: boolean | null;
|
|
@@ -61023,7 +61087,10 @@ export interface operations {
|
|
|
61023
61087
|
* @description The default price of the game pass.
|
|
61024
61088
|
*/
|
|
61025
61089
|
price?: number | null;
|
|
61026
|
-
/**
|
|
61090
|
+
/**
|
|
61091
|
+
* @deprecated
|
|
61092
|
+
* @description Whether regional pricing should be enabled for the game pass.
|
|
61093
|
+
*/
|
|
61027
61094
|
isRegionalPricingEnabled?: boolean | null;
|
|
61028
61095
|
/** @description Whether managed pricing should be enabled for the game pass. */
|
|
61029
61096
|
isManagedPricingEnabled?: boolean | null;
|
|
@@ -61178,7 +61245,10 @@ export interface operations {
|
|
|
61178
61245
|
* @description The default price of the game pass.
|
|
61179
61246
|
*/
|
|
61180
61247
|
price?: number | null;
|
|
61181
|
-
/**
|
|
61248
|
+
/**
|
|
61249
|
+
* @deprecated
|
|
61250
|
+
* @description Whether regional pricing should be enabled for the game pass.
|
|
61251
|
+
*/
|
|
61182
61252
|
isRegionalPricingEnabled?: boolean | null;
|
|
61183
61253
|
/** @description Whether managed pricing should be enabled for the game pass. */
|
|
61184
61254
|
isManagedPricingEnabled?: boolean | null;
|
|
@@ -61713,6 +61783,201 @@ export interface operations {
|
|
|
61713
61783
|
};
|
|
61714
61784
|
};
|
|
61715
61785
|
};
|
|
61786
|
+
PlaceVersion_GetPlaceContributors: {
|
|
61787
|
+
parameters: {
|
|
61788
|
+
query?: {
|
|
61789
|
+
cursor?: string;
|
|
61790
|
+
pageSize?: number;
|
|
61791
|
+
};
|
|
61792
|
+
header?: never;
|
|
61793
|
+
path: {
|
|
61794
|
+
placeId: number;
|
|
61795
|
+
};
|
|
61796
|
+
cookie?: never;
|
|
61797
|
+
};
|
|
61798
|
+
requestBody?: never;
|
|
61799
|
+
responses: {
|
|
61800
|
+
/** @description Success */
|
|
61801
|
+
200: {
|
|
61802
|
+
headers: {
|
|
61803
|
+
[name: string]: unknown;
|
|
61804
|
+
};
|
|
61805
|
+
content: {
|
|
61806
|
+
"application/json": components["schemas"]["GetPlaceContributorsResponse"];
|
|
61807
|
+
};
|
|
61808
|
+
};
|
|
61809
|
+
/** @description Bad Request */
|
|
61810
|
+
400: {
|
|
61811
|
+
headers: {
|
|
61812
|
+
[name: string]: unknown;
|
|
61813
|
+
};
|
|
61814
|
+
content: {
|
|
61815
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61816
|
+
};
|
|
61817
|
+
};
|
|
61818
|
+
/** @description Unauthorized */
|
|
61819
|
+
401: {
|
|
61820
|
+
headers: {
|
|
61821
|
+
[name: string]: unknown;
|
|
61822
|
+
};
|
|
61823
|
+
content: {
|
|
61824
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61825
|
+
};
|
|
61826
|
+
};
|
|
61827
|
+
/** @description Forbidden */
|
|
61828
|
+
403: {
|
|
61829
|
+
headers: {
|
|
61830
|
+
[name: string]: unknown;
|
|
61831
|
+
};
|
|
61832
|
+
content: {
|
|
61833
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61834
|
+
};
|
|
61835
|
+
};
|
|
61836
|
+
/** @description Server Error */
|
|
61837
|
+
500: {
|
|
61838
|
+
headers: {
|
|
61839
|
+
[name: string]: unknown;
|
|
61840
|
+
};
|
|
61841
|
+
content: {
|
|
61842
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61843
|
+
};
|
|
61844
|
+
};
|
|
61845
|
+
};
|
|
61846
|
+
};
|
|
61847
|
+
PlaceVersion_GetPlaceVersionHistory: {
|
|
61848
|
+
parameters: {
|
|
61849
|
+
query?: {
|
|
61850
|
+
cursor?: string;
|
|
61851
|
+
isPublished?: boolean;
|
|
61852
|
+
hasNotes?: boolean;
|
|
61853
|
+
saveType?: number;
|
|
61854
|
+
searchTerm?: string;
|
|
61855
|
+
contributor?: number;
|
|
61856
|
+
startTime?: string;
|
|
61857
|
+
endTime?: string;
|
|
61858
|
+
pageSize?: number;
|
|
61859
|
+
};
|
|
61860
|
+
header?: never;
|
|
61861
|
+
path: {
|
|
61862
|
+
placeId: number;
|
|
61863
|
+
};
|
|
61864
|
+
cookie?: never;
|
|
61865
|
+
};
|
|
61866
|
+
requestBody?: never;
|
|
61867
|
+
responses: {
|
|
61868
|
+
/** @description Success */
|
|
61869
|
+
200: {
|
|
61870
|
+
headers: {
|
|
61871
|
+
[name: string]: unknown;
|
|
61872
|
+
};
|
|
61873
|
+
content: {
|
|
61874
|
+
"application/json": components["schemas"]["GetPlaceVersionHistoryResponse"];
|
|
61875
|
+
};
|
|
61876
|
+
};
|
|
61877
|
+
/** @description Bad Request */
|
|
61878
|
+
400: {
|
|
61879
|
+
headers: {
|
|
61880
|
+
[name: string]: unknown;
|
|
61881
|
+
};
|
|
61882
|
+
content: {
|
|
61883
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61884
|
+
};
|
|
61885
|
+
};
|
|
61886
|
+
/** @description Unauthorized */
|
|
61887
|
+
401: {
|
|
61888
|
+
headers: {
|
|
61889
|
+
[name: string]: unknown;
|
|
61890
|
+
};
|
|
61891
|
+
content: {
|
|
61892
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61893
|
+
};
|
|
61894
|
+
};
|
|
61895
|
+
/** @description Forbidden */
|
|
61896
|
+
403: {
|
|
61897
|
+
headers: {
|
|
61898
|
+
[name: string]: unknown;
|
|
61899
|
+
};
|
|
61900
|
+
content: {
|
|
61901
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61902
|
+
};
|
|
61903
|
+
};
|
|
61904
|
+
/** @description Server Error */
|
|
61905
|
+
500: {
|
|
61906
|
+
headers: {
|
|
61907
|
+
[name: string]: unknown;
|
|
61908
|
+
};
|
|
61909
|
+
content: {
|
|
61910
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61911
|
+
};
|
|
61912
|
+
};
|
|
61913
|
+
};
|
|
61914
|
+
};
|
|
61915
|
+
PlaceVersion_UpdatePlaceVersionNotes: {
|
|
61916
|
+
parameters: {
|
|
61917
|
+
query?: never;
|
|
61918
|
+
header?: never;
|
|
61919
|
+
path: {
|
|
61920
|
+
placeId: number;
|
|
61921
|
+
version: string;
|
|
61922
|
+
};
|
|
61923
|
+
cookie?: never;
|
|
61924
|
+
};
|
|
61925
|
+
requestBody?: {
|
|
61926
|
+
content: {
|
|
61927
|
+
"application/json-patch+json": components["schemas"]["UpdatePlaceVersionNotesRequest"];
|
|
61928
|
+
"application/json": components["schemas"]["UpdatePlaceVersionNotesRequest"];
|
|
61929
|
+
"text/json": components["schemas"]["UpdatePlaceVersionNotesRequest"];
|
|
61930
|
+
"application/*+json": components["schemas"]["UpdatePlaceVersionNotesRequest"];
|
|
61931
|
+
};
|
|
61932
|
+
};
|
|
61933
|
+
responses: {
|
|
61934
|
+
/** @description Success */
|
|
61935
|
+
200: {
|
|
61936
|
+
headers: {
|
|
61937
|
+
[name: string]: unknown;
|
|
61938
|
+
};
|
|
61939
|
+
content: {
|
|
61940
|
+
"application/json": components["schemas"]["UpdatePlaceVersionNotesResponse"];
|
|
61941
|
+
};
|
|
61942
|
+
};
|
|
61943
|
+
/** @description Bad Request */
|
|
61944
|
+
400: {
|
|
61945
|
+
headers: {
|
|
61946
|
+
[name: string]: unknown;
|
|
61947
|
+
};
|
|
61948
|
+
content: {
|
|
61949
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61950
|
+
};
|
|
61951
|
+
};
|
|
61952
|
+
/** @description Unauthorized */
|
|
61953
|
+
401: {
|
|
61954
|
+
headers: {
|
|
61955
|
+
[name: string]: unknown;
|
|
61956
|
+
};
|
|
61957
|
+
content: {
|
|
61958
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61959
|
+
};
|
|
61960
|
+
};
|
|
61961
|
+
/** @description Forbidden */
|
|
61962
|
+
403: {
|
|
61963
|
+
headers: {
|
|
61964
|
+
[name: string]: unknown;
|
|
61965
|
+
};
|
|
61966
|
+
content: {
|
|
61967
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61968
|
+
};
|
|
61969
|
+
};
|
|
61970
|
+
/** @description Server Error */
|
|
61971
|
+
500: {
|
|
61972
|
+
headers: {
|
|
61973
|
+
[name: string]: unknown;
|
|
61974
|
+
};
|
|
61975
|
+
content: {
|
|
61976
|
+
"application/json": components["schemas"]["OperationErrorResponse"];
|
|
61977
|
+
};
|
|
61978
|
+
};
|
|
61979
|
+
};
|
|
61980
|
+
};
|
|
61716
61981
|
GameServers_GetFilterOptions: {
|
|
61717
61982
|
parameters: {
|
|
61718
61983
|
query?: {
|
|
@@ -61848,6 +62113,88 @@ export interface operations {
|
|
|
61848
62113
|
};
|
|
61849
62114
|
};
|
|
61850
62115
|
};
|
|
62116
|
+
GameServers_ListGameServerLogs: {
|
|
62117
|
+
parameters: {
|
|
62118
|
+
query?: {
|
|
62119
|
+
/**
|
|
62120
|
+
* @description The maximum number of game servers to return. The service might return
|
|
62121
|
+
* fewer than this value. If unspecified, at most 25 game servers are
|
|
62122
|
+
* returned. The maximum value is 100 and higher values are set to 100.
|
|
62123
|
+
*/
|
|
62124
|
+
MaxPageSize?: number;
|
|
62125
|
+
/**
|
|
62126
|
+
* @description A page token, received from a previous call, to retrieve a subsequent page.
|
|
62127
|
+
* When paginating, all other parameters provided to the subsequent call must
|
|
62128
|
+
* match the call that provided the page token.
|
|
62129
|
+
*/
|
|
62130
|
+
PageToken?: string;
|
|
62131
|
+
/**
|
|
62132
|
+
* @description Sorting is supported only for a single field at a time.
|
|
62133
|
+
* Example: "orderBy": "uptime"
|
|
62134
|
+
* Defaults to ascending, but descending ordering is also supported by
|
|
62135
|
+
* including the " desc" suffix. For example: "orderBy": "uptime desc".
|
|
62136
|
+
*/
|
|
62137
|
+
OrderBy?: string;
|
|
62138
|
+
/**
|
|
62139
|
+
* @description This field may be set in order to filter the resources returned.
|
|
62140
|
+
* - CEL filtering is supported on all fields.
|
|
62141
|
+
* - Supported operators &&, <, <=, >, >=, ==, and `in`
|
|
62142
|
+
*/
|
|
62143
|
+
Filter?: string;
|
|
62144
|
+
};
|
|
62145
|
+
header?: never;
|
|
62146
|
+
path: {
|
|
62147
|
+
/** @description The universe id */
|
|
62148
|
+
universeId: number;
|
|
62149
|
+
/** @description The place id */
|
|
62150
|
+
placeId: number;
|
|
62151
|
+
/** @description The version number */
|
|
62152
|
+
versionNumber: string;
|
|
62153
|
+
/** @description The server job id */
|
|
62154
|
+
jobId: string;
|
|
62155
|
+
};
|
|
62156
|
+
cookie?: never;
|
|
62157
|
+
};
|
|
62158
|
+
requestBody?: never;
|
|
62159
|
+
responses: {
|
|
62160
|
+
/** @description Success */
|
|
62161
|
+
200: {
|
|
62162
|
+
headers: {
|
|
62163
|
+
[name: string]: unknown;
|
|
62164
|
+
};
|
|
62165
|
+
content: {
|
|
62166
|
+
"application/json": components["schemas"]["ListGameServerLogsResponse"];
|
|
62167
|
+
};
|
|
62168
|
+
};
|
|
62169
|
+
/** @description Bad Request */
|
|
62170
|
+
400: {
|
|
62171
|
+
headers: {
|
|
62172
|
+
[name: string]: unknown;
|
|
62173
|
+
};
|
|
62174
|
+
content: {
|
|
62175
|
+
"application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
|
|
62176
|
+
};
|
|
62177
|
+
};
|
|
62178
|
+
/** @description Unauthorized */
|
|
62179
|
+
401: {
|
|
62180
|
+
headers: {
|
|
62181
|
+
[name: string]: unknown;
|
|
62182
|
+
};
|
|
62183
|
+
content: {
|
|
62184
|
+
"application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
|
|
62185
|
+
};
|
|
62186
|
+
};
|
|
62187
|
+
/** @description Forbidden */
|
|
62188
|
+
403: {
|
|
62189
|
+
headers: {
|
|
62190
|
+
[name: string]: unknown;
|
|
62191
|
+
};
|
|
62192
|
+
content: {
|
|
62193
|
+
"application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
|
|
62194
|
+
};
|
|
62195
|
+
};
|
|
62196
|
+
};
|
|
62197
|
+
};
|
|
61851
62198
|
Restarts_ListRestartStatuses: {
|
|
61852
62199
|
parameters: {
|
|
61853
62200
|
query?: never;
|
|
@@ -62514,8 +62861,6 @@ export interface operations {
|
|
|
62514
62861
|
};
|
|
62515
62862
|
content: {
|
|
62516
62863
|
"text/plain": components["schemas"]["GameVoteResponseApiArrayResponse"];
|
|
62517
|
-
"application/json": components["schemas"]["GameVoteResponseApiArrayResponse"];
|
|
62518
|
-
"text/json": components["schemas"]["GameVoteResponseApiArrayResponse"];
|
|
62519
62864
|
};
|
|
62520
62865
|
};
|
|
62521
62866
|
};
|
|
@@ -62570,8 +62915,6 @@ export interface operations {
|
|
|
62570
62915
|
};
|
|
62571
62916
|
content: {
|
|
62572
62917
|
"text/plain": components["schemas"]["ApiEmptyResponseModel"];
|
|
62573
|
-
"application/json": components["schemas"]["ApiEmptyResponseModel"];
|
|
62574
|
-
"text/json": components["schemas"]["ApiEmptyResponseModel"];
|
|
62575
62918
|
};
|
|
62576
62919
|
};
|
|
62577
62920
|
};
|
|
@@ -62594,8 +62937,6 @@ export interface operations {
|
|
|
62594
62937
|
};
|
|
62595
62938
|
content: {
|
|
62596
62939
|
"text/plain": components["schemas"]["GameVoteResponse"];
|
|
62597
|
-
"application/json": components["schemas"]["GameVoteResponse"];
|
|
62598
|
-
"text/json": components["schemas"]["GameVoteResponse"];
|
|
62599
62940
|
};
|
|
62600
62941
|
};
|
|
62601
62942
|
};
|
|
@@ -62618,8 +62959,6 @@ export interface operations {
|
|
|
62618
62959
|
};
|
|
62619
62960
|
content: {
|
|
62620
62961
|
"text/plain": components["schemas"]["UserGameVoteResponse"];
|
|
62621
|
-
"application/json": components["schemas"]["UserGameVoteResponse"];
|
|
62622
|
-
"text/json": components["schemas"]["UserGameVoteResponse"];
|
|
62623
62962
|
};
|
|
62624
62963
|
};
|
|
62625
62964
|
};
|