@jacobhumston/roblox-openapi-ts 1.0.23 → 1.0.24

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.
Files changed (2) hide show
  1. package/dist/types.d.ts +177 -145
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -9752,6 +9752,23 @@ export interface paths {
9752
9752
  patch?: never;
9753
9753
  trace?: never;
9754
9754
  };
9755
+ "/server-management/v1/universes/{universeId}/places/{placeId}/versions/{versionNumber}/game-servers/{jobId}/logs": {
9756
+ parameters: {
9757
+ query?: never;
9758
+ header?: never;
9759
+ path?: never;
9760
+ cookie?: never;
9761
+ };
9762
+ /** Lists game server logs for a specific server job id */
9763
+ get: operations["GameServers_ListGameServerLogs"];
9764
+ put?: never;
9765
+ post?: never;
9766
+ delete?: never;
9767
+ options?: never;
9768
+ head?: never;
9769
+ patch?: never;
9770
+ trace?: never;
9771
+ };
9755
9772
  "/server-management/v1/universes/{universeId}/restarts": {
9756
9773
  parameters: {
9757
9774
  query?: never;
@@ -18638,75 +18655,6 @@ export interface paths {
18638
18655
  patch?: never;
18639
18656
  trace?: never;
18640
18657
  };
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
18658
  "/v1/games/{universeId}/favorites": {
18711
18659
  parameters: {
18712
18660
  query?: never;
@@ -32257,6 +32205,8 @@ export interface paths {
32257
32205
  query: {
32258
32206
  /** @description CSV for the userIds to get avatar full body shots */
32259
32207
  userIds: number[];
32208
+ /** @description Whether to include a background in the thumbnail (defaults to false) */
32209
+ includeBackground?: boolean;
32260
32210
  /** @description The thumbnail size, formatted widthxheight */
32261
32211
  size?: "30x30" | "48x48" | "60x60" | "75x75" | "100x100" | "110x110" | "140x140" | "150x150" | "150x200" | "180x180" | "250x250" | "352x352" | "420x420" | "720x720";
32262
32212
  /** @description The thumbnail format */
@@ -32357,6 +32307,8 @@ export interface paths {
32357
32307
  query: {
32358
32308
  /** @description CSV for the userIds to get avatar headshots */
32359
32309
  userIds: number[];
32310
+ /** @description Whether to include a background in the thumbnail (defaults to false) */
32311
+ includeBackground?: boolean;
32360
32312
  /** @description The thumbnail size, formatted widthxheight */
32361
32313
  size?: "48x48" | "50x50" | "60x60" | "75x75" | "100x100" | "150x150" | "180x180" | "352x352" | "420x420";
32362
32314
  /** @description The thumbnail format */
@@ -32413,6 +32365,8 @@ export interface paths {
32413
32365
  query: {
32414
32366
  /** @description CSV for the userIds to get avatar headshots */
32415
32367
  userIds: number[];
32368
+ /** @description Whether to include a background in the thumbnail (defaults to false) */
32369
+ includeBackground?: boolean;
32416
32370
  /** @description The thumbnail size, formatted widthxheight */
32417
32371
  size?: "48x48" | "50x50" | "60x60" | "75x75" | "100x100" | "110x110" | "150x150" | "180x180" | "352x352" | "420x420" | "720x720";
32418
32372
  /** @description The thumbnail format */
@@ -32506,6 +32460,8 @@ export interface paths {
32506
32460
  query: {
32507
32461
  /** @description CSV for the userOutfitIds to get user outfits */
32508
32462
  userOutfitIds: number[];
32463
+ /** @description Whether to include a background in the thumbnail (defaults to false) */
32464
+ includeBackground?: boolean;
32509
32465
  /** @description The thumbnail size, formatted widthxheight */
32510
32466
  size?: "150x150" | "420x420";
32511
32467
  /** @description The thumbnail format */
@@ -43247,6 +43203,45 @@ export interface components {
43247
43203
  name?: string | null;
43248
43204
  rootPlace?: components["schemas"]["PlaceResponse"] | null;
43249
43205
  };
43206
+ /** @description Response model for listing a game server log */
43207
+ GameServerLog: {
43208
+ /**
43209
+ * Format: date-time
43210
+ * @description The timestamp the log was received
43211
+ */
43212
+ messageTimestampMs?: string;
43213
+ /**
43214
+ * Format: int64
43215
+ * @description The universe where the log was created
43216
+ */
43217
+ universeId?: number;
43218
+ /** @description The place where the log was created */
43219
+ placeId?: string | null;
43220
+ /** @description The place version on which the log was created */
43221
+ placeVersion?: string | null;
43222
+ /** @description The Game Server id where the log was created */
43223
+ jobId?: string | null;
43224
+ /** @description The severity of the log */
43225
+ severity?: components["schemas"]["LogSeverity"];
43226
+ /** @description The log message */
43227
+ message?: string | null;
43228
+ /** @description The stack trace of the log */
43229
+ stackTrace?: string | null;
43230
+ /** @description Optional message template included with structured logging */
43231
+ messageTemplate?: string | null;
43232
+ /** @description Optional message context included with structured logging */
43233
+ context?: string | null;
43234
+ /**
43235
+ * Format: int32
43236
+ * @description How many duplicate versions of this message were present in the same time window as this log
43237
+ */
43238
+ skippedCount?: number;
43239
+ /**
43240
+ * Format: int32
43241
+ * @description How many more messages were present in the time window beyond our overall rate limits
43242
+ */
43243
+ rateLimitedCount?: number;
43244
+ };
43250
43245
  GameServerResponse: {
43251
43246
  /** Format: uuid */
43252
43247
  id?: string | null;
@@ -44437,6 +44432,16 @@ export interface components {
44437
44432
  /** @description The next page token. */
44438
44433
  nextPageToken: string | null;
44439
44434
  };
44435
+ /** @description Response model for listing game servers. */
44436
+ ListGameServerLogsResponse: {
44437
+ /** @description The GameServers from the specified PlaceVersion. */
44438
+ gameServerLogs?: components["schemas"]["GameServerLog"][] | null;
44439
+ /**
44440
+ * @description A token that you can send as a `pageToken` parameter to retrieve the next
44441
+ * page. If this field is omitted, there are no subsequent pages.
44442
+ */
44443
+ nextPageToken?: string | null;
44444
+ };
44440
44445
  /** @description A list of GroupForumCategories in the parent collection. */
44441
44446
  ListGroupForumCategoriesResponse: {
44442
44447
  /** @description The GroupForumCategories from the specified Group. */
@@ -44619,6 +44624,13 @@ export interface components {
44619
44624
  doubleValue?: string | null;
44620
44625
  stringValue?: string | null;
44621
44626
  };
44627
+ /**
44628
+ * Format: int32
44629
+ * @description Defines the various log severity types with values:
44630
+ * Output (0), Info (1), Warning (2), Error (3)
44631
+ * @enum {integer}
44632
+ */
44633
+ LogSeverity: 0 | 1 | 2 | 3;
44622
44634
  /**
44623
44635
  * @description A `LuauExecutionSessionTask` ("task" for short) executes a given Luau script
44624
44636
  * in the context of a specific version of a place.
@@ -50348,15 +50360,6 @@ export interface components {
50348
50360
  settingTargetId?: number;
50349
50361
  settingTargetCode?: string;
50350
50362
  };
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
50363
  /** @description Game favorite request model. */
50361
50364
  "Roblox.Games.Api.Models.Request.GameFavoritesRequest": {
50362
50365
  /** @description true for favor the game, false for unfavor the game. */
@@ -50481,6 +50484,13 @@ export interface components {
50481
50484
  * It must be the same as the canonical URL (rel-canonical meta tag) on the game's EDP.
50482
50485
  */
50483
50486
  canonicalUrlPath?: string;
50487
+ /**
50488
+ * @description Indicates whether this experience is content-restricted and has had its details wiped.
50489
+ * When true, the content fields (name, description, creator, etc.) contain placeholder or
50490
+ * empty values rather than the real data. Consumers should branch on this flag instead of
50491
+ * inferring restriction from placeholder text.
50492
+ */
50493
+ isContentRestricted?: boolean;
50484
50494
  };
50485
50495
  /** @description Game favorite response model. */
50486
50496
  "Roblox.Games.Api.Models.Response.GameFavoriteResponse": {
@@ -50701,6 +50711,11 @@ export interface components {
50701
50711
  unplayableDisplayText?: string;
50702
50712
  playableUxTreatment?: components["schemas"]["Roblox.Games.Api.Models.Response.PlayableUxTreatment"];
50703
50713
  upsellUxTreatment?: components["schemas"]["Roblox.Games.Api.Models.Response.UpsellUxTreatment"];
50714
+ /**
50715
+ * @description Whether the game supports demo play for users who have not purchased it.
50716
+ * Only set when PlayabilityStatus is PurchaseRequired or FiatPurchaseRequired.
50717
+ */
50718
+ demoModeAvailable?: boolean;
50704
50719
  };
50705
50720
  "Roblox.Games.Api.Models.Response.PlayableUxTreatment": {
50706
50721
  treatment?: string;
@@ -50757,15 +50772,6 @@ export interface components {
50757
50772
  */
50758
50773
  bodyText?: string;
50759
50774
  };
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
50775
  /** @description ApiPageResponse for blocked keywords */
50770
50776
  "Roblox.Groups.Api.BlockedKeywordPageResponse_Roblox.Groups.Client.BlockedKeywordModel_": {
50771
50777
  /**
@@ -52968,6 +52974,8 @@ export interface components {
52968
52974
  accessContext?: string;
52969
52975
  /** @description Head shape for dynamic head thumbnails (only relevant for Asset thumbnail types with dynamic head) */
52970
52976
  headShape?: string;
52977
+ /** @description Whether to include a background in avatar thumbnails (defaults to false) */
52978
+ includeBackground?: boolean;
52971
52979
  };
52972
52980
  "Roblox.Trades.Api.CanTradeResponse": {
52973
52981
  /** @description Returns true if you can trade with the given user. */
@@ -54022,51 +54030,6 @@ export interface components {
54022
54030
  */
54023
54031
  placeVisits?: number;
54024
54032
  };
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
54033
  "Roblox.Web.Responses.Groups.GroupBasicResponse": {
54071
54034
  /** Format: int64 */
54072
54035
  id?: number;
@@ -54461,11 +54424,6 @@ export interface components {
54461
54424
  nextPageCursor?: string;
54462
54425
  data?: components["schemas"]["Roblox.Web.Responses.Games.GameResponseV2"][];
54463
54426
  };
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
54427
  RobuxRateBreakdown: {
54470
54428
  /** Format: double */
54471
54429
  o18?: number | null;
@@ -61848,6 +61806,88 @@ export interface operations {
61848
61806
  };
61849
61807
  };
61850
61808
  };
61809
+ GameServers_ListGameServerLogs: {
61810
+ parameters: {
61811
+ query?: {
61812
+ /**
61813
+ * @description The maximum number of game servers to return. The service might return
61814
+ * fewer than this value. If unspecified, at most 25 game servers are
61815
+ * returned. The maximum value is 100 and higher values are set to 100.
61816
+ */
61817
+ MaxPageSize?: number;
61818
+ /**
61819
+ * @description A page token, received from a previous call, to retrieve a subsequent page.
61820
+ * When paginating, all other parameters provided to the subsequent call must
61821
+ * match the call that provided the page token.
61822
+ */
61823
+ PageToken?: string;
61824
+ /**
61825
+ * @description Sorting is supported only for a single field at a time.
61826
+ * Example: "orderBy": "uptime"
61827
+ * Defaults to ascending, but descending ordering is also supported by
61828
+ * including the " desc" suffix. For example: "orderBy": "uptime desc".
61829
+ */
61830
+ OrderBy?: string;
61831
+ /**
61832
+ * @description This field may be set in order to filter the resources returned.
61833
+ * - CEL filtering is supported on all fields.
61834
+ * - Supported operators &&, <, <=, >, >=, ==, and `in`
61835
+ */
61836
+ Filter?: string;
61837
+ };
61838
+ header?: never;
61839
+ path: {
61840
+ /** @description The universe id */
61841
+ universeId: number;
61842
+ /** @description The place id */
61843
+ placeId: number;
61844
+ /** @description The version number */
61845
+ versionNumber: string;
61846
+ /** @description The server job id */
61847
+ jobId: string;
61848
+ };
61849
+ cookie?: never;
61850
+ };
61851
+ requestBody?: never;
61852
+ responses: {
61853
+ /** @description Success */
61854
+ 200: {
61855
+ headers: {
61856
+ [name: string]: unknown;
61857
+ };
61858
+ content: {
61859
+ "application/json": components["schemas"]["ListGameServerLogsResponse"];
61860
+ };
61861
+ };
61862
+ /** @description Bad Request */
61863
+ 400: {
61864
+ headers: {
61865
+ [name: string]: unknown;
61866
+ };
61867
+ content: {
61868
+ "application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
61869
+ };
61870
+ };
61871
+ /** @description Unauthorized */
61872
+ 401: {
61873
+ headers: {
61874
+ [name: string]: unknown;
61875
+ };
61876
+ content: {
61877
+ "application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
61878
+ };
61879
+ };
61880
+ /** @description Forbidden */
61881
+ 403: {
61882
+ headers: {
61883
+ [name: string]: unknown;
61884
+ };
61885
+ content: {
61886
+ "application/json": components["schemas"]["ServerManagementService.ProblemDetails"];
61887
+ };
61888
+ };
61889
+ };
61890
+ };
61851
61891
  Restarts_ListRestartStatuses: {
61852
61892
  parameters: {
61853
61893
  query?: never;
@@ -62514,8 +62554,6 @@ export interface operations {
62514
62554
  };
62515
62555
  content: {
62516
62556
  "text/plain": components["schemas"]["GameVoteResponseApiArrayResponse"];
62517
- "application/json": components["schemas"]["GameVoteResponseApiArrayResponse"];
62518
- "text/json": components["schemas"]["GameVoteResponseApiArrayResponse"];
62519
62557
  };
62520
62558
  };
62521
62559
  };
@@ -62570,8 +62608,6 @@ export interface operations {
62570
62608
  };
62571
62609
  content: {
62572
62610
  "text/plain": components["schemas"]["ApiEmptyResponseModel"];
62573
- "application/json": components["schemas"]["ApiEmptyResponseModel"];
62574
- "text/json": components["schemas"]["ApiEmptyResponseModel"];
62575
62611
  };
62576
62612
  };
62577
62613
  };
@@ -62594,8 +62630,6 @@ export interface operations {
62594
62630
  };
62595
62631
  content: {
62596
62632
  "text/plain": components["schemas"]["GameVoteResponse"];
62597
- "application/json": components["schemas"]["GameVoteResponse"];
62598
- "text/json": components["schemas"]["GameVoteResponse"];
62599
62633
  };
62600
62634
  };
62601
62635
  };
@@ -62618,8 +62652,6 @@ export interface operations {
62618
62652
  };
62619
62653
  content: {
62620
62654
  "text/plain": components["schemas"]["UserGameVoteResponse"];
62621
- "application/json": components["schemas"]["UserGameVoteResponse"];
62622
- "text/json": components["schemas"]["UserGameVoteResponse"];
62623
62655
  };
62624
62656
  };
62625
62657
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jacobhumston/roblox-openapi-ts",
3
- "version": "1.0.23",
3
+ "version": "1.0.24",
4
4
  "description": "An automatically updated Roblox API client based on their OpenAPI documentation.",
5
5
  "keywords": [
6
6
  "roblox",