@jacobhumston/roblox-openapi-ts 1.0.37 → 1.0.39

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 +376 -2
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -2957,6 +2957,10 @@ export interface paths {
2957
2957
  /**
2958
2958
  * Flush Memory Store
2959
2959
  * @description Asynchronously flush all data structures in the universe.
2960
+ *
2961
+ * Unlike some other endpoints, the flush response `path` already
2962
+ * includes the `cloud/v2` prefix. Poll the operation at
2963
+ * `https://apis.roblox.com/{path}` without adding another prefix.
2960
2964
  */
2961
2965
  post: operations["Cloud_FlushMemoryStore"];
2962
2966
  delete?: never;
@@ -19751,6 +19755,13 @@ export interface paths {
19751
19755
  };
19752
19756
  content?: never;
19753
19757
  };
19758
+ /** @description 4: Too many requests have been made. */
19759
+ 429: {
19760
+ headers: {
19761
+ [name: string]: unknown;
19762
+ };
19763
+ content?: never;
19764
+ };
19754
19765
  };
19755
19766
  };
19756
19767
  put?: never;
@@ -24379,6 +24390,13 @@ export interface paths {
24379
24390
  };
24380
24391
  content?: never;
24381
24392
  };
24393
+ /** @description 28: Migration in progress. Please try again in a moment. */
24394
+ 409: {
24395
+ headers: {
24396
+ [name: string]: unknown;
24397
+ };
24398
+ content?: never;
24399
+ };
24382
24400
  };
24383
24401
  };
24384
24402
  delete?: never;
@@ -24452,6 +24470,13 @@ export interface paths {
24452
24470
  };
24453
24471
  content?: never;
24454
24472
  };
24473
+ /** @description 28: Migration in progress. Please try again in a moment. */
24474
+ 409: {
24475
+ headers: {
24476
+ [name: string]: unknown;
24477
+ };
24478
+ content?: never;
24479
+ };
24455
24480
  };
24456
24481
  };
24457
24482
  options?: never;
@@ -24521,6 +24546,13 @@ export interface paths {
24521
24546
  };
24522
24547
  content?: never;
24523
24548
  };
24549
+ /** @description 28: Migration in progress. Please try again in a moment. */
24550
+ 409: {
24551
+ headers: {
24552
+ [name: string]: unknown;
24553
+ };
24554
+ content?: never;
24555
+ };
24524
24556
  };
24525
24557
  };
24526
24558
  trace?: never;
@@ -43514,6 +43546,189 @@ export interface paths {
43514
43546
  patch?: never;
43515
43547
  trace?: never;
43516
43548
  };
43549
+ "/v4/avatar": {
43550
+ parameters: {
43551
+ query?: never;
43552
+ header?: never;
43553
+ path?: never;
43554
+ cookie?: never;
43555
+ };
43556
+ /**
43557
+ * Gets the currently wearing avatar definition for the authenticated user.
43558
+ * @description Returns an Roblox.Api.Avatar.Models.V4.AvatarDefinition containing an Roblox.Api.Avatar.Models.V4.AvatarModelV4 and Roblox.Api.Avatar.Models.V4.AvatarConfigurations.
43559
+ */
43560
+ get: {
43561
+ parameters: {
43562
+ query: {
43563
+ /** @description Selection types for the avatar data to return. */
43564
+ selectionTypes: (0 | 1 | 2 | 3 | 4 | 5 | 6)[];
43565
+ };
43566
+ header?: {
43567
+ "Roblox-Place-Id"?: number;
43568
+ };
43569
+ path?: never;
43570
+ cookie?: never;
43571
+ };
43572
+ requestBody?: never;
43573
+ responses: {
43574
+ /** @description OK */
43575
+ 200: {
43576
+ headers: {
43577
+ [name: string]: unknown;
43578
+ };
43579
+ content: {
43580
+ "application/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarDefinition"];
43581
+ "text/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarDefinition"];
43582
+ };
43583
+ };
43584
+ /** @description 0: Authorization has been denied for this request. */
43585
+ 401: {
43586
+ headers: {
43587
+ [name: string]: unknown;
43588
+ };
43589
+ content?: never;
43590
+ };
43591
+ };
43592
+ };
43593
+ put?: never;
43594
+ post?: never;
43595
+ delete?: never;
43596
+ options?: never;
43597
+ head?: never;
43598
+ patch?: never;
43599
+ trace?: never;
43600
+ };
43601
+ "/v4/avatar/users/{userId}": {
43602
+ parameters: {
43603
+ query?: never;
43604
+ header?: never;
43605
+ path?: never;
43606
+ cookie?: never;
43607
+ };
43608
+ /**
43609
+ * Gets the currently wearing avatar definition for the specified user.
43610
+ * @description Returns an Roblox.Api.Avatar.Models.V4.AvatarDefinition containing an Roblox.Api.Avatar.Models.V4.AvatarModelV4 and Roblox.Api.Avatar.Models.V4.AvatarConfigurations.
43611
+ * Behavior is aligned with the V2 `GET v2/avatar/users/{userId}/avatar` endpoint.
43612
+ */
43613
+ get: {
43614
+ parameters: {
43615
+ query: {
43616
+ /** @description Selection types for the avatar data to return. */
43617
+ selectionTypes: (0 | 1 | 2 | 3 | 4 | 5 | 6)[];
43618
+ };
43619
+ header?: {
43620
+ "Roblox-Place-Id"?: number;
43621
+ };
43622
+ path: {
43623
+ /** @description The target user id. */
43624
+ userId: number;
43625
+ };
43626
+ cookie?: never;
43627
+ };
43628
+ requestBody?: never;
43629
+ responses: {
43630
+ /** @description OK */
43631
+ 200: {
43632
+ headers: {
43633
+ [name: string]: unknown;
43634
+ };
43635
+ content: {
43636
+ "application/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarDefinition"];
43637
+ "text/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarDefinition"];
43638
+ };
43639
+ };
43640
+ /**
43641
+ * @description 1: The specified user does not exist.
43642
+ * 2: An account for the given userId does not exist!
43643
+ */
43644
+ 400: {
43645
+ headers: {
43646
+ [name: string]: unknown;
43647
+ };
43648
+ content?: never;
43649
+ };
43650
+ };
43651
+ };
43652
+ put?: never;
43653
+ post?: never;
43654
+ delete?: never;
43655
+ options?: never;
43656
+ head?: never;
43657
+ patch?: never;
43658
+ trace?: never;
43659
+ };
43660
+ "/v4/outfits/{outfitId}/details": {
43661
+ parameters: {
43662
+ query?: never;
43663
+ header?: never;
43664
+ path?: never;
43665
+ cookie?: never;
43666
+ };
43667
+ /**
43668
+ * Gets the definition for an outfit.
43669
+ * @description Returns an Roblox.Api.Avatar.Models.V4.OutfitDefinition containing an Roblox.Api.Avatar.Models.V4.OutfitModelV4 and background Roblox.Api.Avatar.Models.V4.OutfitConfigurations.
43670
+ * Behavior is aligned with the V1/V3 `GET v{1|3}/outfits/{userOutfitId}/details` endpoints (authentication optional).
43671
+ */
43672
+ get: {
43673
+ parameters: {
43674
+ query?: {
43675
+ /** @description Selection types for the outfit data to return. */
43676
+ selectionTypes?: (0 | 1)[];
43677
+ /** @description Whether to return assets with availability status. */
43678
+ checkAssetAvailability?: boolean;
43679
+ };
43680
+ header?: {
43681
+ "Roblox-Place-Id"?: number;
43682
+ };
43683
+ path: {
43684
+ /** @description The outfit id. */
43685
+ outfitId: string;
43686
+ };
43687
+ cookie?: never;
43688
+ };
43689
+ requestBody?: never;
43690
+ responses: {
43691
+ /** @description OK */
43692
+ 200: {
43693
+ headers: {
43694
+ [name: string]: unknown;
43695
+ };
43696
+ content: {
43697
+ "application/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.OutfitDefinition"];
43698
+ "text/json": components["schemas"]["Roblox.Api.Avatar.Models.V4.OutfitDefinition"];
43699
+ };
43700
+ };
43701
+ /** @description 2: The outfit for the specified userOutfit is invalid. */
43702
+ 400: {
43703
+ headers: {
43704
+ [name: string]: unknown;
43705
+ };
43706
+ content?: never;
43707
+ };
43708
+ /** @description 3: The requester does not have access to the details for the given user outfit. */
43709
+ 403: {
43710
+ headers: {
43711
+ [name: string]: unknown;
43712
+ };
43713
+ content?: never;
43714
+ };
43715
+ /** @description 1: The specified userOutfitId is invalid. */
43716
+ 404: {
43717
+ headers: {
43718
+ [name: string]: unknown;
43719
+ };
43720
+ content?: never;
43721
+ };
43722
+ };
43723
+ };
43724
+ put?: never;
43725
+ post?: never;
43726
+ delete?: never;
43727
+ options?: never;
43728
+ head?: never;
43729
+ patch?: never;
43730
+ trace?: never;
43731
+ };
43517
43732
  "/virtual-events/v3/game-events/{eventId}": {
43518
43733
  parameters: {
43519
43734
  query?: never;
@@ -44636,7 +44851,13 @@ export interface components {
44636
44851
  * only for convenience.
44637
44852
  */
44638
44853
  readonly id?: string;
44639
- /** @description Users associated with the entry. */
44854
+ /**
44855
+ * @description Users associated with the entry.
44856
+ *
44857
+ * Each value must be a user resource path in the format `users/{user_id}`,
44858
+ * not a bare user ID.
44859
+ * @example users/123
44860
+ */
44640
44861
  users?: string[];
44641
44862
  /** @description An arbitrary set of attributes associated with the entry. */
44642
44863
  attributes?: Record<string, never>;
@@ -45951,7 +46172,11 @@ export interface components {
45951
46172
  /**
45952
46173
  * @description Users associated with the entry.
45953
46174
  *
46175
+ * Each value must be a user resource path in the format `users/{user_id}`,
46176
+ * not a bare user ID.
46177
+ *
45954
46178
  * If this is not provided, existing user IDs are cleared.
46179
+ * @example users/123
45955
46180
  */
45956
46181
  users?: string[];
45957
46182
  /**
@@ -46504,7 +46729,7 @@ export interface components {
46504
46729
  /** @description A list of MemoryStoreSortedMapItems in the parent collection. */
46505
46730
  ListMemoryStoreSortedMapItemsResponse: {
46506
46731
  /** @description The MemoryStoreSortedMapItems from the specified MemoryStoreSortedMap. */
46507
- memoryStoreSortedMapItems?: components["schemas"]["MemoryStoreSortedMapItem"][];
46732
+ items?: components["schemas"]["MemoryStoreSortedMapItem"][];
46508
46733
  /**
46509
46734
  * @description A token that you can send as a `pageToken` parameter to retrieve the next
46510
46735
  * page. If this field is omitted, there are no subsequent pages.
@@ -49386,6 +49611,39 @@ export interface components {
49386
49611
  /** @description Whether or not emotes are enabled */
49387
49612
  emotesEnabledForUser?: boolean;
49388
49613
  };
49614
+ /** @description A model describing a the camera details for a single avatar thumbnail customization. */
49615
+ "Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationCameraModel": {
49616
+ /**
49617
+ * Format: double
49618
+ * @description Field of view for the camera, in degrees.
49619
+ */
49620
+ fieldOfViewDeg?: number;
49621
+ /**
49622
+ * Format: double
49623
+ * @description Rotation around y axis, in degrees.
49624
+ */
49625
+ yRotDeg?: number;
49626
+ /**
49627
+ * Format: double
49628
+ * @description There's a natural camera distance we calculate based on avatar size. Apply this scale to that distance.
49629
+ */
49630
+ distanceScale?: number;
49631
+ };
49632
+ /** @description A model describing a single avatar thumbnail customization. */
49633
+ "Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationModel": {
49634
+ /**
49635
+ * Format: int32
49636
+ * @description What type of 2D thumbnail are we customizing: |Closeup, FullBody.
49637
+ * @enum {integer}
49638
+ */
49639
+ thumbnailType?: 0 | 1 | 2;
49640
+ /**
49641
+ * Format: int64
49642
+ * @description What emote are we using to pose the avatar in the thumbnail.
49643
+ */
49644
+ emoteAssetId?: number;
49645
+ camera?: components["schemas"]["Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationCameraModel"];
49646
+ };
49389
49647
  /** @description A model container BrickColor ids for each body part. */
49390
49648
  "Roblox.Api.Avatar.Models.BodyColorModel": {
49391
49649
  /**
@@ -49446,6 +49704,21 @@ export interface components {
49446
49704
  */
49447
49705
  leftLegColorId?: number;
49448
49706
  };
49707
+ /** @description A model containing RGB hex colors for each body part. */
49708
+ "Roblox.Api.Avatar.Models.BodyColorsModelV4": {
49709
+ /** @description The RGB hex color for head color, e.g. #FFFFFF */
49710
+ headColor?: string;
49711
+ /** @description The RGB hex color for torso color, e.g. #FFFFFF */
49712
+ torsoColor?: string;
49713
+ /** @description The RGB hex color for right arm color, e.g. #FFFFFF */
49714
+ rightArmColor?: string;
49715
+ /** @description The RGB hex color for left arm color, e.g. #FFFFFF */
49716
+ leftArmColor?: string;
49717
+ /** @description The RGB hex color for right leg color, e.g. #FFFFFF */
49718
+ rightLegColor?: string;
49719
+ /** @description The RGB hex color for left leg color, e.g. #FFFFFF */
49720
+ leftLegColor?: string;
49721
+ };
49449
49722
  /** @description A model containing details about avatar-related business rules */
49450
49723
  "Roblox.Api.Avatar.Models.DefaultClothingAssets": {
49451
49724
  /** @description List of asset Ids used to equip shirts for default clothing when the avatar appears nude. */
@@ -49632,6 +49905,89 @@ export interface components {
49632
49905
  assetTypeID?: number;
49633
49906
  isPlayerChoice?: boolean;
49634
49907
  };
49908
+ /** @description A model containing avatar background data. */
49909
+ "Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel": {
49910
+ backgroundAsset?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"];
49911
+ };
49912
+ /** @description Avatar config details. */
49913
+ "Roblox.Api.Avatar.Models.V4.AvatarConfigurations": {
49914
+ /** @description The emotes on the character. */
49915
+ emotes?: components["schemas"]["Roblox.Api.Avatar.Models.EmoteResponseModel"][];
49916
+ background?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel"];
49917
+ /** @description List of customizations set for this avatar. At most one per thumbnail type (Closeup, FullBody). */
49918
+ thumbnailCustomizations?: components["schemas"]["Roblox.Api.Avatar.Models.AvatarThumbnailCustomizationModel"][];
49919
+ profileFrame?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarProfileFrameModel"];
49920
+ };
49921
+ /** @description Details about an avatar. */
49922
+ "Roblox.Api.Avatar.Models.V4.AvatarDefinition": {
49923
+ avatarModel?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarModelV4"];
49924
+ avatarConfigurations?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarConfigurations"];
49925
+ };
49926
+ /** @description A model containing details about an avatar. */
49927
+ "Roblox.Api.Avatar.Models.V4.AvatarModelV4": {
49928
+ scales?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
49929
+ /**
49930
+ * Format: int32
49931
+ * @description The avatar type.
49932
+ * @enum {integer}
49933
+ */
49934
+ playerAvatarType?: 1 | 3;
49935
+ bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
49936
+ /** @description The assets worn on the character. */
49937
+ assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
49938
+ };
49939
+ /** @description A model containing avatar profile frame data. */
49940
+ "Roblox.Api.Avatar.Models.V4.AvatarProfileFrameModel": {
49941
+ frameAsset?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"];
49942
+ };
49943
+ /** @description Background configuration for an outfit. */
49944
+ "Roblox.Api.Avatar.Models.V4.OutfitConfigurations": {
49945
+ background?: components["schemas"]["Roblox.Api.Avatar.Models.V4.AvatarBackgroundModel"];
49946
+ };
49947
+ /** @description Details about an outfit. */
49948
+ "Roblox.Api.Avatar.Models.V4.OutfitDefinition": {
49949
+ /** @description The moderation status of the outfit, not applicable when outfit is created outside experience */
49950
+ moderationStatus?: string;
49951
+ /**
49952
+ * Format: int64
49953
+ * @description The bundle ID, currently only returned for in-experience created outfits.
49954
+ */
49955
+ bundleId?: number;
49956
+ outfitModel?: components["schemas"]["Roblox.Api.Avatar.Models.V4.OutfitModelV4"];
49957
+ outfitConfigurations?: components["schemas"]["Roblox.Api.Avatar.Models.V4.OutfitConfigurations"];
49958
+ };
49959
+ /** @description A model containing core outfit details. */
49960
+ "Roblox.Api.Avatar.Models.V4.OutfitModelV4": {
49961
+ /**
49962
+ * Format: int64
49963
+ * @description The universe id of the outfit, null when outfit is not created in-experience
49964
+ */
49965
+ universeId?: number;
49966
+ /** @description The inventory type of the outfit. */
49967
+ inventoryType?: string;
49968
+ /** @description The outfit id. */
49969
+ id?: string;
49970
+ /** @description The outfit name. */
49971
+ name?: string;
49972
+ /** @description Whether the outfit can be modified by the user. */
49973
+ isEditable?: boolean;
49974
+ /**
49975
+ * Format: int32
49976
+ * @description The type of the outfit.
49977
+ * @enum {integer}
49978
+ */
49979
+ outfitType?: 0 | 1 | 2 | 4 | 5;
49980
+ /** @description The assets on the outfit. */
49981
+ assets?: components["schemas"]["Roblox.Api.Avatar.Models.AssetModelV2"][];
49982
+ bodyColors?: components["schemas"]["Roblox.Api.Avatar.Models.BodyColorsModelV4"];
49983
+ scale?: components["schemas"]["Roblox.Web.Responses.Avatar.ScaleModel"];
49984
+ /**
49985
+ * Format: int32
49986
+ * @description The player avatar type.
49987
+ * @enum {integer}
49988
+ */
49989
+ playerAvatarType?: 1 | 3;
49990
+ };
49635
49991
  /** @description A model that contains a list of AssetWear models */
49636
49992
  "Roblox.Api.Avatar.Models.WearRequestModel": {
49637
49993
  /** @description The asset ids */
@@ -50670,6 +51026,11 @@ export interface components {
50670
51026
  oldNotificationToken?: string;
50671
51027
  /** @description Name of the requesting device */
50672
51028
  deviceName?: string;
51029
+ /**
51030
+ * @description True when the client granted iOS provisional authorization (silent, quiet-only)
51031
+ * rather than full authorization. Absent/null is treated as not provisional.
51032
+ */
51033
+ isProvisional?: boolean;
50673
51034
  };
50674
51035
  "Roblox.Api.Notifications.Models.RegisterIOSPushKitRequestModel": {
50675
51036
  /** @description Token for notification */
@@ -54085,6 +54446,7 @@ export interface components {
54085
54446
  tierUpdatedTime?: string;
54086
54447
  /** Format: date-time */
54087
54448
  lastEvaluatedTime?: string;
54449
+ requirements?: components["schemas"]["Roblox.Groups.Client.TierRequirement"][];
54088
54450
  };
54089
54451
  "Roblox.Groups.Client.CreateBlockedKeywordsResponse": {
54090
54452
  createdKeywords?: components["schemas"]["Roblox.Groups.Client.BlockedKeywordModel"][];
@@ -54112,6 +54474,16 @@ export interface components {
54112
54474
  "Roblox.Groups.Client.TierEvaluationResultResponse": {
54113
54475
  tierInfo?: components["schemas"]["Roblox.Groups.Client.CommunityTierInfoResponse"];
54114
54476
  passedSignals?: string[];
54477
+ requirements?: components["schemas"]["Roblox.Groups.Client.TierRequirement"][];
54478
+ };
54479
+ "Roblox.Groups.Client.TierRequirement": {
54480
+ /**
54481
+ * Format: int32
54482
+ * @description ['OwnerModerationStatusOk' = 1, 'OwnerAgeEstimationVerified' = 2, 'OwnerIdVerified' = 3, 'OwnerTwoStepVerified' = 4, 'CommunityMeetsPlayerRequirement' = 5]
54483
+ * @enum {integer}
54484
+ */
54485
+ key?: 1 | 2 | 3 | 4 | 5;
54486
+ satisfied?: boolean;
54115
54487
  };
54116
54488
  "Roblox.InGameContentTables.Client.GameLocation": {
54117
54489
  path?: string;
@@ -55989,6 +56361,8 @@ export interface components {
55989
56361
  usageContext?: number;
55990
56362
  contentRepresentationPriorityList?: string;
55991
56363
  doNotFallbackToBaselineRepresentation?: boolean;
56364
+ /** Format: int64 */
56365
+ xcachesplit?: number;
55992
56366
  };
55993
56367
  "Roblox.Web.Captcha.Models.Request.CaptchaTokenRequest": {
55994
56368
  captchaId?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jacobhumston/roblox-openapi-ts",
3
- "version": "1.0.37",
3
+ "version": "1.0.39",
4
4
  "description": "An automatically updated Roblox API client based on their OpenAPI documentation.",
5
5
  "keywords": [
6
6
  "roblox",