rozod 6.3.0 → 6.4.0

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 (54) hide show
  1. package/lib/endpoints/accountsettingsv1.d.ts +27 -33
  2. package/lib/endpoints/accountsettingsv1.js +11 -22
  3. package/lib/endpoints/adconfigurationv2.d.ts +104 -119
  4. package/lib/endpoints/adconfigurationv2.js +32 -48
  5. package/lib/endpoints/assetdeliveryv1.d.ts +25 -24
  6. package/lib/endpoints/assetdeliveryv1.js +25 -24
  7. package/lib/endpoints/assetdeliveryv2.d.ts +25 -24
  8. package/lib/endpoints/assetdeliveryv2.js +25 -24
  9. package/lib/endpoints/authv1.d.ts +84 -84
  10. package/lib/endpoints/authv1.js +69 -62
  11. package/lib/endpoints/authv2.d.ts +56 -56
  12. package/lib/endpoints/authv2.js +57 -50
  13. package/lib/endpoints/authv3.d.ts +11 -11
  14. package/lib/endpoints/authv3.js +11 -11
  15. package/lib/endpoints/badgesv1.d.ts +6 -2
  16. package/lib/endpoints/badgesv1.js +2 -2
  17. package/lib/endpoints/catalogv1.d.ts +37 -43
  18. package/lib/endpoints/catalogv1.js +37 -37
  19. package/lib/endpoints/catalogv2.d.ts +11 -11
  20. package/lib/endpoints/catalogv2.js +11 -11
  21. package/lib/endpoints/clientsettingsv2.d.ts +7 -7
  22. package/lib/endpoints/clientsettingsv2.js +8 -1
  23. package/lib/endpoints/developv1.d.ts +31 -31
  24. package/lib/endpoints/developv1.js +26 -26
  25. package/lib/endpoints/developv2.d.ts +27 -27
  26. package/lib/endpoints/developv2.js +22 -22
  27. package/lib/endpoints/economycreatorstatsv1.d.ts +1 -1
  28. package/lib/endpoints/economycreatorstatsv1.js +1 -1
  29. package/lib/endpoints/followingsv2.d.ts +2 -2
  30. package/lib/endpoints/followingsv2.js +2 -2
  31. package/lib/endpoints/friendsv1.d.ts +24 -23
  32. package/lib/endpoints/friendsv1.js +24 -23
  33. package/lib/endpoints/gamesv1.d.ts +27 -615
  34. package/lib/endpoints/gamesv1.js +28 -608
  35. package/lib/endpoints/gamesv2.d.ts +187 -260
  36. package/lib/endpoints/gamesv2.js +130 -190
  37. package/lib/endpoints/groupsv1.d.ts +26 -26
  38. package/lib/endpoints/groupsv1.js +28 -16
  39. package/lib/endpoints/groupsv2.d.ts +92 -92
  40. package/lib/endpoints/groupsv2.js +93 -87
  41. package/lib/endpoints/inventoryv1.d.ts +9 -21
  42. package/lib/endpoints/inventoryv1.js +4 -4
  43. package/lib/endpoints/inventoryv2.d.ts +91 -91
  44. package/lib/endpoints/inventoryv2.js +86 -86
  45. package/lib/endpoints/itemconfigurationv1.d.ts +1 -1
  46. package/lib/endpoints/itemconfigurationv1.js +1 -1
  47. package/lib/endpoints/tradesv1.d.ts +10 -16
  48. package/lib/endpoints/tradesv1.js +10 -10
  49. package/lib/endpoints/twostepverificationv1.d.ts +59 -60
  50. package/lib/endpoints/twostepverificationv1.js +59 -60
  51. package/lib/endpoints/usersv1.d.ts +1 -1
  52. package/lib/endpoints/usersv1.js +1 -1
  53. package/lib/index.js +29 -3
  54. package/package.json +1 -1
@@ -110,16 +110,6 @@ const Roblox_Games_Api_Models_Response_GameMediaItem = z.object({
110
110
  });
111
111
  const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameMediaItem_ =
112
112
  z.object({ data: z.array(Roblox_Games_Api_Models_Response_GameMediaItem) });
113
- const Roblox_Games_Api_Models_Response_GameVoteResponse = z.object({
114
- id: z.number().int(),
115
- upVotes: z.number().int(),
116
- downVotes: z.number().int(),
117
- });
118
- const Roblox_Games_Api_Models_Response_UserGameVoteResponse = z.object({
119
- canVote: z.boolean(),
120
- userVote: z.boolean(),
121
- reasonForNotVoteable: z.string(),
122
- });
123
113
  const Roblox_Games_Api_Models_Response_PurchaseData = z.object({
124
114
  localizedFiatPrice: z.string(),
125
115
  basePriceId: z.string(),
@@ -155,33 +145,33 @@ const Roblox_Games_Api_Models_Response_PlaceDetails = z.object({
155
145
  fiatPurchaseData: Roblox_Games_Api_Models_Response_PurchaseData,
156
146
  });
157
147
  const Roblox_Games_Api_Models_Response_PlayabilityStatusResponse = z.object({
158
- playabilityStatus: z.union([
159
- z.literal(0),
160
- z.literal(1),
161
- z.literal(2),
162
- z.literal(3),
163
- z.literal(4),
164
- z.literal(5),
165
- z.literal(6),
166
- z.literal(7),
167
- z.literal(8),
168
- z.literal(9),
169
- z.literal(10),
170
- z.literal(11),
171
- z.literal(12),
172
- z.literal(13),
173
- z.literal(14),
174
- z.literal(15),
175
- z.literal(16),
176
- z.literal(17),
177
- z.literal(18),
178
- z.literal(19),
179
- z.literal(20),
180
- z.literal(21),
181
- z.literal(22),
182
- z.literal(23),
183
- z.literal(24),
184
- z.literal(25),
148
+ playabilityStatus: z.enum([
149
+ "UnplayableOtherReason",
150
+ "Playable",
151
+ "GuestProhibited",
152
+ "GameUnapproved",
153
+ "IncorrectConfiguration",
154
+ "UniverseRootPlaceIsPrivate",
155
+ "InsufficientPermissionFriendsOnly",
156
+ "InsufficientPermissionGroupOnly",
157
+ "DeviceRestricted",
158
+ "UnderReview",
159
+ "PurchaseRequired",
160
+ "AccountRestricted",
161
+ "TemporarilyUnavailable",
162
+ "PlaceHasNoPublishedVersion",
163
+ "ComplianceBlocked",
164
+ "ContextualPlayabilityRegionalAvailability",
165
+ "ContextualPlayabilityRegionalCompliance",
166
+ "ContextualPlayabilityAgeRecommendationParentalControls",
167
+ "ContextualPlayabilityExperienceBlockedParentalControls",
168
+ "ContextualPlayabilityAgeGated",
169
+ "ContextualPlayabilityUnverifiedSeventeenPlusUser",
170
+ "FiatPurchaseRequired",
171
+ "FiatPurchaseDeviceRestricted",
172
+ "ContextualPlayabilityUnrated",
173
+ "ContextualPlayabilityAgeGatedByDescriptor",
174
+ "ContextualPlayabilityGeneral",
185
175
  ]),
186
176
  isPlayable: z.boolean(),
187
177
  universeId: z.number().int(),
@@ -213,109 +203,8 @@ const Roblox_Games_Api_Models_Response_GameRecommendationsResponse = z.object({
213
203
  games: z.array(Roblox_Games_Api_Models_Response_GameResponseModel),
214
204
  nextPaginationKey: z.string(),
215
205
  });
216
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameVoteResponse_ =
217
- z.object({
218
- data: z.array(Roblox_Games_Api_Models_Response_GameVoteResponse),
219
- });
220
206
  const Roblox_Games_Api_Models_Response_PrivateServersEnabledInUniverseResponse =
221
207
  z.object({ privateServersEnabled: z.boolean() });
222
- const Roblox_Games_Api_Models_Response_MyPrivateServersData = z.object({
223
- active: z.boolean(),
224
- universeId: z.number().int(),
225
- placeId: z.number().int(),
226
- name: z.string(),
227
- ownerId: z.number().int(),
228
- ownerName: z.string(),
229
- priceInRobux: z.number().int(),
230
- privateServerId: z.number().int(),
231
- expirationDate: z.string().datetime({ offset: true }),
232
- willRenew: z.boolean(),
233
- universeName: z.string(),
234
- });
235
- const Roblox_Games_Api_Models_Response_MyPrivateServersResponse = z.object({
236
- nextPageCursor: z.string(),
237
- previousPageCursor: z.string(),
238
- data: z.array(Roblox_Games_Api_Models_Response_MyPrivateServersData),
239
- });
240
- const Roblox_Games_Api_VipServerCanInviteResponse = z.object({
241
- canInvite: z.boolean(),
242
- doesOwnerPrivacyRestrictJoins: z.boolean(),
243
- inviteResponseType: z.union([
244
- z.literal(0),
245
- z.literal(1),
246
- z.literal(2),
247
- z.literal(3),
248
- z.literal(4),
249
- ]),
250
- });
251
- const Roblox_Games_Api_PlaceResponse = z.object({
252
- id: z.number().int(),
253
- name: z.string(),
254
- });
255
- const Roblox_Games_Api_GameResponse = z.object({
256
- id: z.number().int(),
257
- name: z.string(),
258
- rootPlace: Roblox_Games_Api_PlaceResponse,
259
- });
260
- const Roblox_Games_Api_VipServerSubscriptionResponse = z.object({
261
- active: z.boolean(),
262
- expired: z.boolean(),
263
- expirationDate: z.string().datetime({ offset: true }),
264
- price: z.number().int(),
265
- canRenew: z.boolean(),
266
- hasInsufficientFunds: z.boolean(),
267
- hasRecurringProfile: z.boolean(),
268
- hasPriceChanged: z.boolean(),
269
- });
270
- const Roblox_Web_Responses_Users_SkinnyUserResponse = z.object({
271
- id: z.number().int(),
272
- name: z.string(),
273
- displayName: z.string(),
274
- });
275
- const Roblox_Games_Api_VipServerPermissionsResponse = z.object({
276
- clanAllowed: z.boolean(),
277
- enemyClanId: z.number().int(),
278
- friendsAllowed: z.boolean(),
279
- users: z.array(Roblox_Web_Responses_Users_SkinnyUserResponse),
280
- });
281
- const Roblox_Games_Api_VipServerVoiceSettingsResponse = z.object({
282
- enabled: z.boolean(),
283
- });
284
- const Roblox_Games_Api_VipServerResponse = z.object({
285
- id: z.number().int(),
286
- name: z.string(),
287
- game: Roblox_Games_Api_GameResponse,
288
- joinCode: z.string(),
289
- active: z.boolean(),
290
- subscription: Roblox_Games_Api_VipServerSubscriptionResponse,
291
- permissions: Roblox_Games_Api_VipServerPermissionsResponse,
292
- voiceSettings: Roblox_Games_Api_VipServerVoiceSettingsResponse,
293
- link: z.string(),
294
- });
295
- const Roblox_Games_Api_VipServerUpdateRequest = z.object({
296
- name: z.string(),
297
- newJoinCode: z.boolean(),
298
- active: z.boolean(),
299
- });
300
- const Roblox_Games_Api_CreateVipServersRequest = z.object({
301
- name: z.string(),
302
- expectedPrice: z.number().int(),
303
- isPurchaseConfirmed: z.boolean(),
304
- });
305
- const Roblox_Games_Api_Models_Request_SetUserGameVoteRequest = z.object({
306
- vote: z.boolean(),
307
- });
308
- const Roblox_Games_Api_VipServerUpdatePermissionsRequest = z.object({
309
- clanAllowed: z.boolean(),
310
- enemyClanId: z.number().int(),
311
- friendsAllowed: z.boolean(),
312
- usersToAdd: z.array(z.number()),
313
- usersToRemove: z.array(z.number()),
314
- });
315
- const Roblox_Games_Api_VipServerUpdateSubscriptionRequest = z.object({
316
- active: z.boolean(),
317
- price: z.number().int(),
318
- });
319
208
 
320
209
  /**
321
210
  * @api GET https://games.roblox.com/v1/games
@@ -622,142 +511,6 @@ export const getGamesUniverseidMedia = endpoint({
622
511
  },
623
512
  ],
624
513
  });
625
- /**
626
- * @api PATCH https://games.roblox.com/v1/games/:universeId/user-votes
627
- * @summary Set the user's vote for a game
628
- * @param body The request body.
629
- * @param universeId The id of the universe.
630
- */
631
- export const patchGamesUniverseidUserVotes = endpoint({
632
- method: "PATCH",
633
- path: "/v1/games/:universeId/user-votes",
634
- baseUrl: "https://games.roblox.com",
635
- requestFormat: "json",
636
- serializationMethod: {
637
- body: {},
638
- universeId: {
639
- style: "simple",
640
- },
641
- },
642
- parameters: {
643
- universeId: z.number().int(),
644
- },
645
- body: z.object({ vote: z.boolean() }),
646
- response: z.object({}),
647
- errors: [
648
- {
649
- status: 400,
650
- description: `2: The universe's root place is invalid.
651
- 3: The asset is not voteable.
652
- 4: The requested vote is invalid.`,
653
- },
654
- {
655
- status: 401,
656
- description: `0: Authorization has been denied for this request.`,
657
- },
658
- {
659
- status: 403,
660
- description: `0: Token Validation Failed
661
- 6: The user needs to play the game before vote.
662
- 7: The user needs additional permission to vote.`,
663
- },
664
- {
665
- status: 404,
666
- description: `1: The requested universe does not exist.`,
667
- },
668
- {
669
- status: 429,
670
- description: `5: Too many attempts to vote. Please try again later.
671
- 10: Internal service busy. Please try again later.`,
672
- },
673
- {
674
- status: 500,
675
- description: `0: An unknown error occurred.`,
676
- },
677
- ],
678
- });
679
- /**
680
- * @api GET https://games.roblox.com/v1/games/:universeId/votes
681
- * @summary Get the game vote status
682
- * @param universeId The id of the universe we get vote status from.
683
- */
684
- export const getGamesUniverseidVotes = endpoint({
685
- method: "GET",
686
- path: "/v1/games/:universeId/votes",
687
- baseUrl: "https://games.roblox.com",
688
- requestFormat: "json",
689
- serializationMethod: {
690
- universeId: {
691
- style: "simple",
692
- },
693
- },
694
- parameters: {
695
- universeId: z.number().int(),
696
- },
697
- response: Roblox_Games_Api_Models_Response_GameVoteResponse,
698
- errors: [
699
- {
700
- status: 400,
701
- description: `2: The universe's root place is invalid.
702
- 3: The asset is not voteable.`,
703
- },
704
- {
705
- status: 404,
706
- description: `1: The requested universe does not exist.`,
707
- },
708
- {
709
- status: 429,
710
- description: `10: Internal service busy. Please try again later.`,
711
- },
712
- {
713
- status: 500,
714
- description: `0: An unknown error occurred.`,
715
- },
716
- ],
717
- });
718
- /**
719
- * @api GET https://games.roblox.com/v1/games/:universeId/votes/user
720
- * @summary Get the user's vote status for a game
721
- * @param universeId The id of the universe we get user vote status from.
722
- */
723
- export const getGamesUniverseidVotesUser = endpoint({
724
- method: "GET",
725
- path: "/v1/games/:universeId/votes/user",
726
- baseUrl: "https://games.roblox.com",
727
- requestFormat: "json",
728
- serializationMethod: {
729
- universeId: {
730
- style: "simple",
731
- },
732
- },
733
- parameters: {
734
- universeId: z.number().int(),
735
- },
736
- response: Roblox_Games_Api_Models_Response_UserGameVoteResponse,
737
- errors: [
738
- {
739
- status: 400,
740
- description: `2: The universe's root place is invalid.
741
- 3: The asset is not voteable.`,
742
- },
743
- {
744
- status: 401,
745
- description: `0: Authorization has been denied for this request.`,
746
- },
747
- {
748
- status: 404,
749
- description: `1: The requested universe does not exist.`,
750
- },
751
- {
752
- status: 429,
753
- description: `10: Internal service busy. Please try again later.`,
754
- },
755
- {
756
- status: 500,
757
- description: `0: An unknown error occurred.`,
758
- },
759
- ],
760
- });
761
514
  /**
762
515
  * @api GET https://games.roblox.com/v1/games/games-product-info
763
516
  * @summary Gets a list of games' product info, used to purchase a game
@@ -889,88 +642,6 @@ export const getGamesRecommendationsGameUniverseid = endpoint({
889
642
  },
890
643
  ],
891
644
  });
892
- /**
893
- * @api POST https://games.roblox.com/v1/games/vip-servers/:universeId
894
- * @summary Create VIP server for a game
895
- * @param body The request body.
896
- * @param universeId The id of the universe.
897
- */
898
- export const postGamesVipServersUniverseid = endpoint({
899
- method: "POST",
900
- path: "/v1/games/vip-servers/:universeId",
901
- baseUrl: "https://games.roblox.com",
902
- requestFormat: "json",
903
- serializationMethod: {
904
- body: {},
905
- universeId: {
906
- style: "simple",
907
- },
908
- },
909
- parameters: {
910
- universeId: z.number().int(),
911
- },
912
- body: Roblox_Games_Api_CreateVipServersRequest,
913
- response: Roblox_Web_Responses_Games_GameServerResponse,
914
- errors: [
915
- {
916
- status: 400,
917
- description: `15: The price for purchasing this private server has changed. Please refresh the page and try again.`,
918
- },
919
- {
920
- status: 401,
921
- description: `0: Authorization has been denied for this request.`,
922
- },
923
- {
924
- status: 403,
925
- description: `0: Token Validation Failed`,
926
- },
927
- {
928
- status: 404,
929
- description: `4: The universe does not exist.`,
930
- },
931
- {
932
- status: 500,
933
- description: `16: We are having a problem completing your purchase. Please try again in a few minutes.`,
934
- },
935
- ],
936
- });
937
- /**
938
- * @api GET https://games.roblox.com/v1/games/votes
939
- * @summary Gets a list of universe vote status
940
- * @param universeIds A list of universe Ids. Cannot exceed a maximum of 50 IDs.
941
- */
942
- export const getGamesVotes = endpoint({
943
- method: "GET",
944
- path: "/v1/games/votes",
945
- baseUrl: "https://games.roblox.com",
946
- requestFormat: "json",
947
- serializationMethod: {
948
- universeIds: {
949
- style: "form",
950
- },
951
- },
952
- parameters: {
953
- universeIds: z.array(z.number()),
954
- },
955
- response:
956
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameVoteResponse_,
957
- errors: [
958
- {
959
- status: 400,
960
- description: `3: The asset is not voteable.
961
- 8: No universe IDs were specified.
962
- 9: Too many universe IDs were requested.`,
963
- },
964
- {
965
- status: 429,
966
- description: `10: Internal service busy. Please try again later.`,
967
- },
968
- {
969
- status: 500,
970
- description: `0: An unknown error occurred.`,
971
- },
972
- ],
973
- });
974
645
  /**
975
646
  * @api GET https://games.roblox.com/v1/private-servers/enabled-in-universe/:universeId
976
647
  * @summary Checks if the private servers are enabled in the specified universe.
@@ -997,262 +668,3 @@ export const getPrivateServersEnabledInUniverseUniverseid = endpoint({
997
668
  },
998
669
  ],
999
670
  });
1000
- /**
1001
- * @api GET https://games.roblox.com/v1/private-servers/my-private-servers
1002
- * @summary Get private servers for the authenticated user
1003
- * @param privateServersTab Type of private server to fetch
1004
- * @param itemsPerPage Number of items per page
1005
- * @param cursor Current cursor
1006
- */
1007
- export const getPrivateServersMyPrivateServers = endpoint({
1008
- method: "GET",
1009
- path: "/v1/private-servers/my-private-servers",
1010
- baseUrl: "https://games.roblox.com",
1011
- requestFormat: "json",
1012
- serializationMethod: {
1013
- privateServersTab: {
1014
- style: "form",
1015
- explode: true,
1016
- },
1017
- itemsPerPage: {
1018
- style: "form",
1019
- explode: true,
1020
- },
1021
- cursor: {
1022
- style: "form",
1023
- explode: true,
1024
- },
1025
- },
1026
- parameters: {
1027
- privateServersTab: z.union([z.literal(0), z.literal(1)]).optional(),
1028
- itemsPerPage: z.number().int().optional().default(25),
1029
- cursor: z.string().optional(),
1030
- },
1031
- response: Roblox_Games_Api_Models_Response_MyPrivateServersResponse,
1032
- errors: [
1033
- {
1034
- status: 400,
1035
- description: `39: Invalid cursor provided in the request.`,
1036
- },
1037
- {
1038
- status: 401,
1039
- description: `0: Authorization has been denied for this request.`,
1040
- },
1041
- ],
1042
- });
1043
- /**
1044
- * @api GET https://games.roblox.com/v1/vip-server/can-invite/:userId
1045
- * @summary Determines if a user by id is allowed to receive a VIP Server invite from the authenticated user.
1046
- * @param userId The user id.
1047
- */
1048
- export const getVipServerCanInviteUserid = endpoint({
1049
- method: "GET",
1050
- path: "/v1/vip-server/can-invite/:userId",
1051
- baseUrl: "https://games.roblox.com",
1052
- requestFormat: "json",
1053
- serializationMethod: {
1054
- userId: {
1055
- style: "simple",
1056
- },
1057
- },
1058
- parameters: {
1059
- userId: z.number().int(),
1060
- },
1061
- response: Roblox_Games_Api_VipServerCanInviteResponse,
1062
- errors: [
1063
- {
1064
- status: 401,
1065
- description: `0: Authorization has been denied for this request.`,
1066
- },
1067
- {
1068
- status: 404,
1069
- description: `19: The user is does not exist.`,
1070
- },
1071
- ],
1072
- });
1073
- /**
1074
- * @api GET https://games.roblox.com/v1/vip-servers/:id
1075
- * @summary Get necessary data to generate webpage
1076
- * @param id The VIP Server ID
1077
- */
1078
- export const getVipServersId = endpoint({
1079
- method: "GET",
1080
- path: "/v1/vip-servers/:id",
1081
- baseUrl: "https://games.roblox.com",
1082
- requestFormat: "json",
1083
- serializationMethod: {
1084
- id: {
1085
- style: "simple",
1086
- },
1087
- },
1088
- parameters: {
1089
- id: z.number().int(),
1090
- },
1091
- response: Roblox_Games_Api_VipServerResponse,
1092
- errors: [
1093
- {
1094
- status: 400,
1095
- description: `8: The creator of this game has disabled private servers for this game.`,
1096
- },
1097
- {
1098
- status: 401,
1099
- description: `0: Authorization has been denied for this request.`,
1100
- },
1101
- {
1102
- status: 403,
1103
- description: `2: You are not the owner of this private server.`,
1104
- },
1105
- {
1106
- status: 404,
1107
- description: `1: The private server is invalid or does not exist.
1108
- 4: The universe does not exist.`,
1109
- },
1110
- ],
1111
- });
1112
- /**
1113
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id
1114
- * @summary Updates vip server
1115
- * @param body The Roblox.Games.Api.VipServerUpdateRequest
1116
- * @param id The VIP Server ID
1117
- */
1118
- export const patchVipServersId = endpoint({
1119
- method: "PATCH",
1120
- path: "/v1/vip-servers/:id",
1121
- baseUrl: "https://games.roblox.com",
1122
- requestFormat: "json",
1123
- serializationMethod: {
1124
- body: {},
1125
- id: {
1126
- style: "simple",
1127
- },
1128
- },
1129
- parameters: {
1130
- id: z.number().int(),
1131
- },
1132
- body: Roblox_Games_Api_VipServerUpdateRequest,
1133
- response: Roblox_Games_Api_VipServerResponse,
1134
- errors: [
1135
- {
1136
- status: 400,
1137
- description: `8: The creator of this game has disabled private servers for this game.
1138
- 10: The name of the private server is either empty or too long.`,
1139
- },
1140
- {
1141
- status: 401,
1142
- description: `0: Authorization has been denied for this request.`,
1143
- },
1144
- {
1145
- status: 403,
1146
- description: `0: Token Validation Failed
1147
- 2: You are not the owner of this private server.
1148
- 11: You cannot activate a cancelled private server.
1149
- 12: The game must not be Friends Only to allow private servers.
1150
- 13: Join Link can be generated only for active private servers.`,
1151
- },
1152
- {
1153
- status: 404,
1154
- description: `1: The private server is invalid or does not exist.
1155
- 4: The universe does not exist.`,
1156
- },
1157
- {
1158
- status: 429,
1159
- description: `3: Please wait a few minutes before configuring your private server again.`,
1160
- },
1161
- ],
1162
- });
1163
- /**
1164
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id/permissions
1165
- * @summary Update friend/clan access and allowed friends/clan list
1166
- * @param body The Roblox.Games.Api.VipServerUpdatePermissionsRequest
1167
- * @param id The VIP Server ID
1168
- */
1169
- export const patchVipServersIdPermissions = endpoint({
1170
- method: "PATCH",
1171
- path: "/v1/vip-servers/:id/permissions",
1172
- baseUrl: "https://games.roblox.com",
1173
- requestFormat: "json",
1174
- serializationMethod: {
1175
- body: {},
1176
- id: {
1177
- style: "simple",
1178
- },
1179
- },
1180
- parameters: {
1181
- id: z.number().int(),
1182
- },
1183
- body: Roblox_Games_Api_VipServerUpdatePermissionsRequest,
1184
- response: Roblox_Games_Api_VipServerPermissionsResponse,
1185
- errors: [
1186
- {
1187
- status: 400,
1188
- description: `6: You cannot add so many players to the private server's invite list.
1189
- 8: The creator of this game has disabled private servers for this game.
1190
- 12: The game must not be Friends Only to allow private servers.
1191
- 28: You may only add or remove valid players to your private server's invite list.
1192
- 29: You may only add or remove players when your private server is active.`,
1193
- },
1194
- {
1195
- status: 401,
1196
- description: `0: Authorization has been denied for this request.`,
1197
- },
1198
- {
1199
- status: 403,
1200
- description: `0: Token Validation Failed
1201
- 2: You are not the owner of this private server.`,
1202
- },
1203
- {
1204
- status: 404,
1205
- description: `1: The private server is invalid or does not exist.
1206
- 4: The universe does not exist.`,
1207
- },
1208
- ],
1209
- });
1210
- /**
1211
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id/subscription
1212
- * @summary Updates subscription status of a vip server
1213
- * @param body The Roblox.Games.Api.VipServerUpdateSubscriptionRequest
1214
- * @param id The VIP Server ID
1215
- */
1216
- export const patchVipServersIdSubscription = endpoint({
1217
- method: "PATCH",
1218
- path: "/v1/vip-servers/:id/subscription",
1219
- baseUrl: "https://games.roblox.com",
1220
- requestFormat: "json",
1221
- serializationMethod: {
1222
- body: {},
1223
- id: {
1224
- style: "simple",
1225
- },
1226
- },
1227
- parameters: {
1228
- id: z.number().int(),
1229
- },
1230
- body: Roblox_Games_Api_VipServerUpdateSubscriptionRequest,
1231
- response: Roblox_Games_Api_VipServerSubscriptionResponse,
1232
- errors: [
1233
- {
1234
- status: 400,
1235
- description: `8: The creator of this game has disabled private servers for this game.
1236
- 32: You do not have enough funds available to renew the subscription for this private server.`,
1237
- },
1238
- {
1239
- status: 401,
1240
- description: `0: Authorization has been denied for this request.`,
1241
- },
1242
- {
1243
- status: 403,
1244
- description: `0: Token Validation Failed
1245
- 2: You are not the owner of this private server.
1246
- 21: You may not configure a cancelled private server. Please renew your subscription before configuring.`,
1247
- },
1248
- {
1249
- status: 404,
1250
- description: `1: The private server is invalid or does not exist.
1251
- 4: The universe does not exist.`,
1252
- },
1253
- {
1254
- status: 429,
1255
- description: `3: Please wait a few minutes before configuring your private server again.`,
1256
- },
1257
- ],
1258
- });