@jacobhumston/roblox-openapi-ts 1.0.19 → 1.0.21
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 +19 -174
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -479,7 +479,7 @@ export interface paths {
|
|
|
479
479
|
};
|
|
480
480
|
/**
|
|
481
481
|
* List Group Forum Categories
|
|
482
|
-
* @description Lists forum categories in the group.
|
|
482
|
+
* @description Lists forum categories in the group. Supports filtering.
|
|
483
483
|
*/
|
|
484
484
|
get: operations["Cloud_ListGroupForumCategories"];
|
|
485
485
|
put?: never;
|
|
@@ -499,7 +499,7 @@ export interface paths {
|
|
|
499
499
|
};
|
|
500
500
|
/**
|
|
501
501
|
* List Group Forum Posts
|
|
502
|
-
* @description Lists forum posts in the group's forum category.
|
|
502
|
+
* @description Lists forum posts in the group's forum category. Supports filtering.
|
|
503
503
|
*/
|
|
504
504
|
get: operations["Cloud_ListGroupForumPosts"];
|
|
505
505
|
put?: never;
|
|
@@ -519,7 +519,7 @@ export interface paths {
|
|
|
519
519
|
};
|
|
520
520
|
/**
|
|
521
521
|
* List Group Forum Comments
|
|
522
|
-
* @description Lists forum comments on a group's forum post.
|
|
522
|
+
* @description Lists forum comments on a group's forum post. Supports filtering.
|
|
523
523
|
*/
|
|
524
524
|
get: operations["Cloud_ListGroupForumComments"];
|
|
525
525
|
put?: never;
|
|
@@ -539,7 +539,7 @@ export interface paths {
|
|
|
539
539
|
};
|
|
540
540
|
/**
|
|
541
541
|
* List Group Join Requests
|
|
542
|
-
* @description List join requests under a group.
|
|
542
|
+
* @description List join requests under a group. Supports filtering.
|
|
543
543
|
*/
|
|
544
544
|
get: operations["Cloud_ListGroupJoinRequests"];
|
|
545
545
|
put?: never;
|
|
@@ -599,7 +599,7 @@ export interface paths {
|
|
|
599
599
|
};
|
|
600
600
|
/**
|
|
601
601
|
* List Group Memberships
|
|
602
|
-
* @description List group members in a group.
|
|
602
|
+
* @description List group members in a group. Supports filtering.
|
|
603
603
|
*/
|
|
604
604
|
get: operations["Cloud_ListGroupMemberships"];
|
|
605
605
|
put?: never;
|
|
@@ -21548,20 +21548,6 @@ export interface paths {
|
|
|
21548
21548
|
"application/json": components["schemas"]["Roblox.Groups.Api.GetCommunityFeatureFreezesResponse"];
|
|
21549
21549
|
};
|
|
21550
21550
|
};
|
|
21551
|
-
/** @description 0: Authorization has been denied for this request. */
|
|
21552
|
-
401: {
|
|
21553
|
-
headers: {
|
|
21554
|
-
[name: string]: unknown;
|
|
21555
|
-
};
|
|
21556
|
-
content?: never;
|
|
21557
|
-
};
|
|
21558
|
-
/** @description 49: User is invalid or does not exist */
|
|
21559
|
-
403: {
|
|
21560
|
-
headers: {
|
|
21561
|
-
[name: string]: unknown;
|
|
21562
|
-
};
|
|
21563
|
-
content?: never;
|
|
21564
|
-
};
|
|
21565
21551
|
};
|
|
21566
21552
|
};
|
|
21567
21553
|
put?: never;
|
|
@@ -35129,9 +35115,9 @@ export interface paths {
|
|
|
35129
35115
|
*/
|
|
35130
35116
|
get: {
|
|
35131
35117
|
parameters: {
|
|
35132
|
-
query
|
|
35118
|
+
query: {
|
|
35133
35119
|
/** @description The username */
|
|
35134
|
-
username
|
|
35120
|
+
username: string;
|
|
35135
35121
|
};
|
|
35136
35122
|
header?: never;
|
|
35137
35123
|
path?: never;
|
|
@@ -46589,9 +46575,9 @@ export interface paths {
|
|
|
46589
46575
|
*/
|
|
46590
46576
|
get: {
|
|
46591
46577
|
parameters: {
|
|
46592
|
-
query
|
|
46578
|
+
query: {
|
|
46593
46579
|
/** @description The username */
|
|
46594
|
-
username
|
|
46580
|
+
username: string;
|
|
46595
46581
|
};
|
|
46596
46582
|
header?: never;
|
|
46597
46583
|
path?: never;
|
|
@@ -47360,56 +47346,6 @@ export interface paths {
|
|
|
47360
47346
|
patch?: never;
|
|
47361
47347
|
trace?: never;
|
|
47362
47348
|
};
|
|
47363
|
-
"/v3/logout": {
|
|
47364
|
-
parameters: {
|
|
47365
|
-
query?: never;
|
|
47366
|
-
header?: never;
|
|
47367
|
-
path?: never;
|
|
47368
|
-
cookie?: never;
|
|
47369
|
-
};
|
|
47370
|
-
get?: never;
|
|
47371
|
-
put?: never;
|
|
47372
|
-
/** Destroys the current authentication session while reporting metrics like url and reason for logout. */
|
|
47373
|
-
post: {
|
|
47374
|
-
parameters: {
|
|
47375
|
-
query?: never;
|
|
47376
|
-
header?: never;
|
|
47377
|
-
path?: never;
|
|
47378
|
-
cookie?: never;
|
|
47379
|
-
};
|
|
47380
|
-
/** @description The logout request with postBody which includes reason, url, and userIdString. */
|
|
47381
|
-
requestBody: {
|
|
47382
|
-
content: {
|
|
47383
|
-
"application/json": components["schemas"]["Roblox.Authentication.Api.Models.Request.LogoutV3Request"];
|
|
47384
|
-
"text/json": components["schemas"]["Roblox.Authentication.Api.Models.Request.LogoutV3Request"];
|
|
47385
|
-
};
|
|
47386
|
-
};
|
|
47387
|
-
responses: {
|
|
47388
|
-
/** @description OK */
|
|
47389
|
-
200: {
|
|
47390
|
-
headers: {
|
|
47391
|
-
[name: string]: unknown;
|
|
47392
|
-
};
|
|
47393
|
-
content: {
|
|
47394
|
-
"application/json": components["schemas"]["Roblox.Web.WebAPI.ApiEmptyResponseModel"];
|
|
47395
|
-
"text/json": components["schemas"]["Roblox.Web.WebAPI.ApiEmptyResponseModel"];
|
|
47396
|
-
};
|
|
47397
|
-
};
|
|
47398
|
-
/** @description 0: Token Validation Failed */
|
|
47399
|
-
403: {
|
|
47400
|
-
headers: {
|
|
47401
|
-
[name: string]: unknown;
|
|
47402
|
-
};
|
|
47403
|
-
content?: never;
|
|
47404
|
-
};
|
|
47405
|
-
};
|
|
47406
|
-
};
|
|
47407
|
-
delete?: never;
|
|
47408
|
-
options?: never;
|
|
47409
|
-
head?: never;
|
|
47410
|
-
patch?: never;
|
|
47411
|
-
trace?: never;
|
|
47412
|
-
};
|
|
47413
47349
|
"/v3/outfits/create": {
|
|
47414
47350
|
parameters: {
|
|
47415
47351
|
query?: never;
|
|
@@ -47665,73 +47601,6 @@ export interface paths {
|
|
|
47665
47601
|
patch?: never;
|
|
47666
47602
|
trace?: never;
|
|
47667
47603
|
};
|
|
47668
|
-
"/v3/users/{userId}/two-step-verification/login": {
|
|
47669
|
-
parameters: {
|
|
47670
|
-
query?: never;
|
|
47671
|
-
header?: never;
|
|
47672
|
-
path?: never;
|
|
47673
|
-
cookie?: never;
|
|
47674
|
-
};
|
|
47675
|
-
get?: never;
|
|
47676
|
-
put?: never;
|
|
47677
|
-
/** Authenticates as a user given a two step verification verification token. */
|
|
47678
|
-
post: {
|
|
47679
|
-
parameters: {
|
|
47680
|
-
query?: never;
|
|
47681
|
-
header?: never;
|
|
47682
|
-
path: {
|
|
47683
|
-
/** @description The user ID to authenticate as. */
|
|
47684
|
-
userId: number;
|
|
47685
|
-
};
|
|
47686
|
-
cookie?: never;
|
|
47687
|
-
};
|
|
47688
|
-
/** @description The Roblox.Authentication.Api.TwoStepVerificationLoginRequest. */
|
|
47689
|
-
requestBody: {
|
|
47690
|
-
content: {
|
|
47691
|
-
"application/json": components["schemas"]["Roblox.Authentication.Api.TwoStepVerificationLoginRequest"];
|
|
47692
|
-
"text/json": components["schemas"]["Roblox.Authentication.Api.TwoStepVerificationLoginRequest"];
|
|
47693
|
-
};
|
|
47694
|
-
};
|
|
47695
|
-
responses: {
|
|
47696
|
-
/** @description OK */
|
|
47697
|
-
200: {
|
|
47698
|
-
headers: {
|
|
47699
|
-
[name: string]: unknown;
|
|
47700
|
-
};
|
|
47701
|
-
content: {
|
|
47702
|
-
"application/json": components["schemas"]["Roblox.Authentication.Api.Models.TwoStepVerificationV3LoginResponse"];
|
|
47703
|
-
"text/json": components["schemas"]["Roblox.Authentication.Api.Models.TwoStepVerificationV3LoginResponse"];
|
|
47704
|
-
};
|
|
47705
|
-
};
|
|
47706
|
-
/**
|
|
47707
|
-
* @description 1: User is invalid.
|
|
47708
|
-
* 5: Invalid two step verification ticket.
|
|
47709
|
-
* 10: Invalid verification token.
|
|
47710
|
-
*/
|
|
47711
|
-
400: {
|
|
47712
|
-
headers: {
|
|
47713
|
-
[name: string]: unknown;
|
|
47714
|
-
};
|
|
47715
|
-
content?: never;
|
|
47716
|
-
};
|
|
47717
|
-
/**
|
|
47718
|
-
* @description 0: Token Validation Failed
|
|
47719
|
-
* 11: Maxium logged in accounts limit reached.
|
|
47720
|
-
*/
|
|
47721
|
-
403: {
|
|
47722
|
-
headers: {
|
|
47723
|
-
[name: string]: unknown;
|
|
47724
|
-
};
|
|
47725
|
-
content?: never;
|
|
47726
|
-
};
|
|
47727
|
-
};
|
|
47728
|
-
};
|
|
47729
|
-
delete?: never;
|
|
47730
|
-
options?: never;
|
|
47731
|
-
head?: never;
|
|
47732
|
-
patch?: never;
|
|
47733
|
-
trace?: never;
|
|
47734
|
-
};
|
|
47735
47604
|
}
|
|
47736
47605
|
export type webhooks = Record<string, never>;
|
|
47737
47606
|
export interface components {
|
|
@@ -49734,17 +49603,6 @@ export interface components {
|
|
|
49734
49603
|
*/
|
|
49735
49604
|
bypassSlowMode?: boolean;
|
|
49736
49605
|
};
|
|
49737
|
-
"GroupsApi.Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_": {
|
|
49738
|
-
/** Format: int64 */
|
|
49739
|
-
id?: number;
|
|
49740
|
-
/**
|
|
49741
|
-
* Format: int32
|
|
49742
|
-
* @description ['Image' = 1, 'TShirt' = 2, 'Audio' = 3, 'Mesh' = 4, 'Lua' = 5, 'HTML' = 6, 'Text' = 7, 'Hat' = 8, 'Place' = 9, 'Model' = 10, 'Shirt' = 11, 'Pants' = 12, 'Decal' = 13, 'Avatar' = 16, 'Head' = 17, 'Face' = 18, 'Gear' = 19, 'Badge' = 21, 'GroupEmblem' = 22, 'Animation' = 24, 'Arms' = 25, 'Legs' = 26, 'Torso' = 27, 'RightArm' = 28, 'LeftArm' = 29, 'LeftLeg' = 30, 'RightLeg' = 31, 'Package' = 32, 'YouTubeVideo' = 33, 'GamePass' = 34, 'App' = 35, 'Code' = 37, 'Plugin' = 38, 'SolidModel' = 39, 'MeshPart' = 40, 'HairAccessory' = 41, 'FaceAccessory' = 42, 'NeckAccessory' = 43, 'ShoulderAccessory' = 44, 'FrontAccessory' = 45, 'BackAccessory' = 46, 'WaistAccessory' = 47, 'ClimbAnimation' = 48, 'DeathAnimation' = 49, 'FallAnimation' = 50, 'IdleAnimation' = 51, 'JumpAnimation' = 52, 'RunAnimation' = 53, 'SwimAnimation' = 54, 'WalkAnimation' = 55, 'PoseAnimation' = 56, 'LocalizationTableManifest' = 59, 'LocalizationTableTranslation' = 60, 'EmoteAnimation' = 61, 'Video' = 62, 'TexturePack' = 63, 'TShirtAccessory' = 64, 'ShirtAccessory' = 65, 'PantsAccessory' = 66, 'JacketAccessory' = 67, 'SweaterAccessory' = 68, 'ShortsAccessory' = 69, 'LeftShoeAccessory' = 70, 'RightShoeAccessory' = 71, 'DressSkirtAccessory' = 72, 'FontFamily' = 73, 'FontFace' = 74, 'MeshHiddenSurfaceRemoval' = 75, 'EyebrowAccessory' = 76, 'EyelashAccessory' = 77, 'MoodAnimation' = 78, 'DynamicHead' = 79, 'CodeSnippet' = 80, 'AdsVideo' = 81, 'OtaUpdate' = 82, 'Screenshot' = 83, 'RuntimePropertySet' = 84, 'StorePreviewVideo' = 85, 'GamePreviewVideo' = 86, 'CreatorExperienceConfig' = 87, 'FaceMakeup' = 88, 'LipMakeup' = 89, 'EyeMakeup' = 90, 'VoxelFragment' = 91, 'AvatarBackground' = 92]
|
|
49743
|
-
* @enum {integer}
|
|
49744
|
-
*/
|
|
49745
|
-
type?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 16 | 17 | 18 | 19 | 21 | 22 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92;
|
|
49746
|
-
name?: string;
|
|
49747
|
-
};
|
|
49748
49606
|
HttpContent: {
|
|
49749
49607
|
readonly headers?: components["schemas"]["StringStringIEnumerableKeyValuePair"][] | null;
|
|
49750
49608
|
};
|
|
@@ -50096,10 +49954,10 @@ export interface components {
|
|
|
50096
49954
|
[key: string]: components["schemas"]["PlaceFilter"];
|
|
50097
49955
|
} | null;
|
|
50098
49956
|
/**
|
|
50099
|
-
* @description Optional JSON
|
|
50100
|
-
* Must be
|
|
49957
|
+
* @description Optional JSON object sent to game servers when the restart is scheduled.
|
|
49958
|
+
* Must be a JSON object and at most 500 bytes when serialized (UTF-8).
|
|
50101
49959
|
*/
|
|
50102
|
-
attributes?:
|
|
49960
|
+
attributes?: unknown;
|
|
50103
49961
|
};
|
|
50104
49962
|
/** @description Response model for launching a game restart. */
|
|
50105
49963
|
LaunchRestartResponse: {
|
|
@@ -54608,10 +54466,12 @@ export interface components {
|
|
|
54608
54466
|
/** Format: int64 */
|
|
54609
54467
|
userId?: number;
|
|
54610
54468
|
isPostRecovery?: boolean;
|
|
54469
|
+
source?: string;
|
|
54611
54470
|
};
|
|
54612
54471
|
"Roblox.Authentication.Api.Models.Request.FinishPasskeyPreauthRegistrationRequest": {
|
|
54613
54472
|
sessionId?: string;
|
|
54614
54473
|
registrationResponse?: string;
|
|
54474
|
+
source?: string;
|
|
54615
54475
|
};
|
|
54616
54476
|
"Roblox.Authentication.Api.Models.Request.FinishPasskeyRegistrationRequest": {
|
|
54617
54477
|
sessionId?: string;
|
|
@@ -54641,11 +54501,6 @@ export interface components {
|
|
|
54641
54501
|
"Roblox.Authentication.Api.Models.Request.LogoutFromAllSessionsAndReauthenticateRequest": {
|
|
54642
54502
|
SecureAuthenticationIntent?: components["schemas"]["Roblox.Authentication.Api.Models.Request.SecureAuthenticationIntentModel"];
|
|
54643
54503
|
};
|
|
54644
|
-
"Roblox.Authentication.Api.Models.Request.LogoutV3Request": {
|
|
54645
|
-
logoutReason?: string;
|
|
54646
|
-
url?: string;
|
|
54647
|
-
userId?: string;
|
|
54648
|
-
};
|
|
54649
54504
|
"Roblox.Authentication.Api.Models.Request.OtpSessionModel": {
|
|
54650
54505
|
otpSessionToken?: string;
|
|
54651
54506
|
/**
|
|
@@ -54824,10 +54679,6 @@ export interface components {
|
|
|
54824
54679
|
mediaType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
54825
54680
|
ticket?: string;
|
|
54826
54681
|
};
|
|
54827
|
-
"Roblox.Authentication.Api.Models.TwoStepVerificationV3LoginResponse": {
|
|
54828
|
-
identityVerificationLoginTicket?: string;
|
|
54829
|
-
accountBlob?: string;
|
|
54830
|
-
};
|
|
54831
54682
|
"Roblox.Authentication.Api.Models.UsernameChangePriceResponse": {
|
|
54832
54683
|
/** Format: int64 */
|
|
54833
54684
|
priceInRobux?: number;
|
|
@@ -54880,14 +54731,6 @@ export interface components {
|
|
|
54880
54731
|
UserId?: number;
|
|
54881
54732
|
Username?: string;
|
|
54882
54733
|
};
|
|
54883
|
-
"Roblox.Authentication.Api.TwoStepVerificationLoginRequest": {
|
|
54884
|
-
challengeId?: string;
|
|
54885
|
-
verificationToken?: string;
|
|
54886
|
-
rememberDevice?: boolean;
|
|
54887
|
-
secureAuthenticationIntent?: components["schemas"]["Roblox.Authentication.Api.Models.Request.SecureAuthenticationIntentModel"];
|
|
54888
|
-
accountBlob?: string;
|
|
54889
|
-
accountLinkParameters?: components["schemas"]["Roblox.Authentication.Api.Models.AccountLinkParameters"];
|
|
54890
|
-
};
|
|
54891
54734
|
/** @description The result of being awarded a badge. */
|
|
54892
54735
|
"Roblox.Badges.Api.BadgeAwardResponse": {
|
|
54893
54736
|
/**
|
|
@@ -55890,10 +55733,10 @@ export interface components {
|
|
|
55890
55733
|
sourceUniverseId?: number;
|
|
55891
55734
|
/**
|
|
55892
55735
|
* Format: int32
|
|
55893
|
-
* @description The origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10]
|
|
55736
|
+
* @description The origin source type associated with the friend request. ['Unknown' = 0, 'PlayerSearch' = 1, 'QrCode' = 2, 'InGame' = 3, 'UserProfile' = 4, 'QqContactImporter' = 5, 'WeChatContactImporter' = 6, 'ProfileShare' = 7, 'PhoneContactImporter' = 8, 'FriendRecommendations' = 9, 'UserCommunities' = 10, 'TrustedFriend' = 11]
|
|
55894
55737
|
* @enum {integer}
|
|
55895
55738
|
*/
|
|
55896
|
-
originSourceType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
|
|
55739
|
+
originSourceType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
|
|
55897
55740
|
/** @description The contact name associated with the friend request. */
|
|
55898
55741
|
contactName?: string;
|
|
55899
55742
|
/** @description The nickname associated with the friend request. */
|
|
@@ -57892,7 +57735,7 @@ export interface components {
|
|
|
57892
57735
|
/** @description The game description. */
|
|
57893
57736
|
description?: string;
|
|
57894
57737
|
creator?: components["schemas"]["Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Core.CreatorType_"];
|
|
57895
|
-
rootPlace?: components["schemas"]["
|
|
57738
|
+
rootPlace?: components["schemas"]["Roblox.Web.Responses.RelatedEntityTypeResponse_Roblox.Platform.Assets.AssetType_"];
|
|
57896
57739
|
/**
|
|
57897
57740
|
* Format: date-time
|
|
57898
57741
|
* @description When the game was created.
|
|
@@ -60598,6 +60441,7 @@ export interface components {
|
|
|
60598
60441
|
state?: "Error" | "Completed" | "InReview" | "Pending" | "Blocked" | "TemporarilyUnavailable";
|
|
60599
60442
|
imageUrl?: string;
|
|
60600
60443
|
version?: string;
|
|
60444
|
+
thumbnailSource?: string;
|
|
60601
60445
|
};
|
|
60602
60446
|
"Roblox.Web.Responses.Users.LegacyUserResponse": {
|
|
60603
60447
|
/** Format: int64 */
|
|
@@ -61554,6 +61398,7 @@ export interface components {
|
|
|
61554
61398
|
state?: "Error" | "Completed" | "InReview" | "Pending" | "Blocked" | "TemporarilyUnavailable";
|
|
61555
61399
|
imageUrl?: string;
|
|
61556
61400
|
version?: string;
|
|
61401
|
+
thumbnailSource?: string;
|
|
61557
61402
|
};
|
|
61558
61403
|
/** @description Representation of an asset. */
|
|
61559
61404
|
"ToolboxService.Asset": {
|