rozod 6.2.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 (87) 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 +132 -84
  10. package/lib/endpoints/authv1.js +118 -64
  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/avatarv1.d.ts +1 -0
  16. package/lib/endpoints/avatarv1.js +1 -0
  17. package/lib/endpoints/avatarv2.d.ts +1 -0
  18. package/lib/endpoints/avatarv2.js +1 -0
  19. package/lib/endpoints/avatarv3.d.ts +1 -0
  20. package/lib/endpoints/avatarv3.js +1 -0
  21. package/lib/endpoints/badgesv1.d.ts +6 -22
  22. package/lib/endpoints/badgesv1.js +2 -22
  23. package/lib/endpoints/catalogv1.d.ts +39 -113
  24. package/lib/endpoints/catalogv1.js +39 -107
  25. package/lib/endpoints/catalogv2.d.ts +11 -11
  26. package/lib/endpoints/catalogv2.js +11 -11
  27. package/lib/endpoints/clientsettingsv2.d.ts +8 -7
  28. package/lib/endpoints/clientsettingsv2.js +9 -1
  29. package/lib/endpoints/developv1.d.ts +31 -31
  30. package/lib/endpoints/developv1.js +26 -26
  31. package/lib/endpoints/developv2.d.ts +27 -27
  32. package/lib/endpoints/developv2.js +22 -22
  33. package/lib/endpoints/economycreatorstatsv1.d.ts +1 -1
  34. package/lib/endpoints/economycreatorstatsv1.js +1 -1
  35. package/lib/endpoints/followingsv2.d.ts +2 -2
  36. package/lib/endpoints/followingsv2.js +2 -2
  37. package/lib/endpoints/friendsv1.d.ts +24 -98
  38. package/lib/endpoints/friendsv1.js +25 -91
  39. package/lib/endpoints/gamesv1.d.ts +31 -615
  40. package/lib/endpoints/gamesv1.js +32 -608
  41. package/lib/endpoints/gamesv2.d.ts +187 -260
  42. package/lib/endpoints/gamesv2.js +130 -190
  43. package/lib/endpoints/groupsv1.d.ts +34 -28
  44. package/lib/endpoints/groupsv1.js +31 -18
  45. package/lib/endpoints/groupsv2.d.ts +92 -92
  46. package/lib/endpoints/groupsv2.js +93 -87
  47. package/lib/endpoints/inventoryv1.d.ts +9 -21
  48. package/lib/endpoints/inventoryv1.js +4 -4
  49. package/lib/endpoints/inventoryv2.d.ts +91 -91
  50. package/lib/endpoints/inventoryv2.js +86 -86
  51. package/lib/endpoints/itemconfigurationv1.d.ts +1 -1
  52. package/lib/endpoints/itemconfigurationv1.js +1 -1
  53. package/lib/endpoints/thumbnailsv1.d.ts +1 -0
  54. package/lib/endpoints/thumbnailsv1.js +1 -0
  55. package/lib/endpoints/tradesv1.d.ts +10 -16
  56. package/lib/endpoints/tradesv1.js +10 -10
  57. package/lib/endpoints/twostepverificationv1.d.ts +59 -59
  58. package/lib/endpoints/twostepverificationv1.js +59 -59
  59. package/lib/endpoints/usersv1.d.ts +1 -1
  60. package/lib/endpoints/usersv1.js +1 -1
  61. package/lib/index.d.ts +1 -0
  62. package/lib/index.js +29 -3
  63. package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
  64. package/lib/opencloud/v1/asset-permissions.js +9 -3
  65. package/lib/opencloud/v1/assets.d.ts +59 -32
  66. package/lib/opencloud/v1/assets.js +77 -41
  67. package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
  68. package/lib/opencloud/v1/datastores-ordered.js +62 -20
  69. package/lib/opencloud/v1/datastores.d.ts +99 -42
  70. package/lib/opencloud/v1/datastores.js +123 -50
  71. package/lib/opencloud/v1/developer-products.d.ts +29 -11
  72. package/lib/opencloud/v1/developer-products.js +37 -15
  73. package/lib/opencloud/v1/game-passes.d.ts +29 -11
  74. package/lib/opencloud/v1/game-passes.js +37 -15
  75. package/lib/opencloud/v1/messaging.d.ts +6 -2
  76. package/lib/opencloud/v1/messaging.js +8 -3
  77. package/lib/opencloud/v1/open-eval.d.ts +14 -4
  78. package/lib/opencloud/v1/open-eval.js +18 -6
  79. package/lib/opencloud/v1/secrets-store.d.ts +46 -26
  80. package/lib/opencloud/v1/secrets-store.js +56 -31
  81. package/lib/opencloud/v1/toolbox.d.ts +14 -6
  82. package/lib/opencloud/v1/toolbox.js +18 -8
  83. package/lib/opencloud/v1/universes.d.ts +6 -2
  84. package/lib/opencloud/v1/universes.js +8 -3
  85. package/lib/opencloud/v2/cloud.d.ts +854 -395
  86. package/lib/opencloud/v2/cloud.js +967 -395
  87. 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
@@ -349,6 +238,10 @@ export const getGames = endpoint({
349
238
  description: `8: The universe IDs specified are invalid.
350
239
  9: Too many universe IDs were requested.`,
351
240
  },
241
+ {
242
+ status: 429,
243
+ description: `4: Too many requests have been made.`,
244
+ },
352
245
  ],
353
246
  });
354
247
  /**
@@ -618,142 +511,6 @@ export const getGamesUniverseidMedia = endpoint({
618
511
  },
619
512
  ],
620
513
  });
621
- /**
622
- * @api PATCH https://games.roblox.com/v1/games/:universeId/user-votes
623
- * @summary Set the user's vote for a game
624
- * @param body The request body.
625
- * @param universeId The id of the universe.
626
- */
627
- export const patchGamesUniverseidUserVotes = endpoint({
628
- method: "PATCH",
629
- path: "/v1/games/:universeId/user-votes",
630
- baseUrl: "https://games.roblox.com",
631
- requestFormat: "json",
632
- serializationMethod: {
633
- body: {},
634
- universeId: {
635
- style: "simple",
636
- },
637
- },
638
- parameters: {
639
- universeId: z.number().int(),
640
- },
641
- body: z.object({ vote: z.boolean() }),
642
- response: z.object({}),
643
- errors: [
644
- {
645
- status: 400,
646
- description: `2: The universe's root place is invalid.
647
- 3: The asset is not voteable.
648
- 4: The requested vote is invalid.`,
649
- },
650
- {
651
- status: 401,
652
- description: `0: Authorization has been denied for this request.`,
653
- },
654
- {
655
- status: 403,
656
- description: `0: Token Validation Failed
657
- 6: The user needs to play the game before vote.
658
- 7: The user needs additional permission to vote.`,
659
- },
660
- {
661
- status: 404,
662
- description: `1: The requested universe does not exist.`,
663
- },
664
- {
665
- status: 429,
666
- description: `5: Too many attempts to vote. Please try again later.
667
- 10: Internal service busy. Please try again later.`,
668
- },
669
- {
670
- status: 500,
671
- description: `0: An unknown error occurred.`,
672
- },
673
- ],
674
- });
675
- /**
676
- * @api GET https://games.roblox.com/v1/games/:universeId/votes
677
- * @summary Get the game vote status
678
- * @param universeId The id of the universe we get vote status from.
679
- */
680
- export const getGamesUniverseidVotes = endpoint({
681
- method: "GET",
682
- path: "/v1/games/:universeId/votes",
683
- baseUrl: "https://games.roblox.com",
684
- requestFormat: "json",
685
- serializationMethod: {
686
- universeId: {
687
- style: "simple",
688
- },
689
- },
690
- parameters: {
691
- universeId: z.number().int(),
692
- },
693
- response: Roblox_Games_Api_Models_Response_GameVoteResponse,
694
- errors: [
695
- {
696
- status: 400,
697
- description: `2: The universe's root place is invalid.
698
- 3: The asset is not voteable.`,
699
- },
700
- {
701
- status: 404,
702
- description: `1: The requested universe does not exist.`,
703
- },
704
- {
705
- status: 429,
706
- description: `10: Internal service busy. Please try again later.`,
707
- },
708
- {
709
- status: 500,
710
- description: `0: An unknown error occurred.`,
711
- },
712
- ],
713
- });
714
- /**
715
- * @api GET https://games.roblox.com/v1/games/:universeId/votes/user
716
- * @summary Get the user's vote status for a game
717
- * @param universeId The id of the universe we get user vote status from.
718
- */
719
- export const getGamesUniverseidVotesUser = endpoint({
720
- method: "GET",
721
- path: "/v1/games/:universeId/votes/user",
722
- baseUrl: "https://games.roblox.com",
723
- requestFormat: "json",
724
- serializationMethod: {
725
- universeId: {
726
- style: "simple",
727
- },
728
- },
729
- parameters: {
730
- universeId: z.number().int(),
731
- },
732
- response: Roblox_Games_Api_Models_Response_UserGameVoteResponse,
733
- errors: [
734
- {
735
- status: 400,
736
- description: `2: The universe's root place is invalid.
737
- 3: The asset is not voteable.`,
738
- },
739
- {
740
- status: 401,
741
- description: `0: Authorization has been denied for this request.`,
742
- },
743
- {
744
- status: 404,
745
- description: `1: The requested universe does not exist.`,
746
- },
747
- {
748
- status: 429,
749
- description: `10: Internal service busy. Please try again later.`,
750
- },
751
- {
752
- status: 500,
753
- description: `0: An unknown error occurred.`,
754
- },
755
- ],
756
- });
757
514
  /**
758
515
  * @api GET https://games.roblox.com/v1/games/games-product-info
759
516
  * @summary Gets a list of games' product info, used to purchase a game
@@ -885,88 +642,6 @@ export const getGamesRecommendationsGameUniverseid = endpoint({
885
642
  },
886
643
  ],
887
644
  });
888
- /**
889
- * @api POST https://games.roblox.com/v1/games/vip-servers/:universeId
890
- * @summary Create VIP server for a game
891
- * @param body The request body.
892
- * @param universeId The id of the universe.
893
- */
894
- export const postGamesVipServersUniverseid = endpoint({
895
- method: "POST",
896
- path: "/v1/games/vip-servers/:universeId",
897
- baseUrl: "https://games.roblox.com",
898
- requestFormat: "json",
899
- serializationMethod: {
900
- body: {},
901
- universeId: {
902
- style: "simple",
903
- },
904
- },
905
- parameters: {
906
- universeId: z.number().int(),
907
- },
908
- body: Roblox_Games_Api_CreateVipServersRequest,
909
- response: Roblox_Web_Responses_Games_GameServerResponse,
910
- errors: [
911
- {
912
- status: 400,
913
- description: `15: The price for purchasing this private server has changed. Please refresh the page and try again.`,
914
- },
915
- {
916
- status: 401,
917
- description: `0: Authorization has been denied for this request.`,
918
- },
919
- {
920
- status: 403,
921
- description: `0: Token Validation Failed`,
922
- },
923
- {
924
- status: 404,
925
- description: `4: The universe does not exist.`,
926
- },
927
- {
928
- status: 500,
929
- description: `16: We are having a problem completing your purchase. Please try again in a few minutes.`,
930
- },
931
- ],
932
- });
933
- /**
934
- * @api GET https://games.roblox.com/v1/games/votes
935
- * @summary Gets a list of universe vote status
936
- * @param universeIds A list of universe Ids. Cannot exceed a maximum of 50 IDs.
937
- */
938
- export const getGamesVotes = endpoint({
939
- method: "GET",
940
- path: "/v1/games/votes",
941
- baseUrl: "https://games.roblox.com",
942
- requestFormat: "json",
943
- serializationMethod: {
944
- universeIds: {
945
- style: "form",
946
- },
947
- },
948
- parameters: {
949
- universeIds: z.array(z.number()),
950
- },
951
- response:
952
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameVoteResponse_,
953
- errors: [
954
- {
955
- status: 400,
956
- description: `3: The asset is not voteable.
957
- 8: No universe IDs were specified.
958
- 9: Too many universe IDs were requested.`,
959
- },
960
- {
961
- status: 429,
962
- description: `10: Internal service busy. Please try again later.`,
963
- },
964
- {
965
- status: 500,
966
- description: `0: An unknown error occurred.`,
967
- },
968
- ],
969
- });
970
645
  /**
971
646
  * @api GET https://games.roblox.com/v1/private-servers/enabled-in-universe/:universeId
972
647
  * @summary Checks if the private servers are enabled in the specified universe.
@@ -993,262 +668,3 @@ export const getPrivateServersEnabledInUniverseUniverseid = endpoint({
993
668
  },
994
669
  ],
995
670
  });
996
- /**
997
- * @api GET https://games.roblox.com/v1/private-servers/my-private-servers
998
- * @summary Get private servers for the authenticated user
999
- * @param privateServersTab Type of private server to fetch
1000
- * @param itemsPerPage Number of items per page
1001
- * @param cursor Current cursor
1002
- */
1003
- export const getPrivateServersMyPrivateServers = endpoint({
1004
- method: "GET",
1005
- path: "/v1/private-servers/my-private-servers",
1006
- baseUrl: "https://games.roblox.com",
1007
- requestFormat: "json",
1008
- serializationMethod: {
1009
- privateServersTab: {
1010
- style: "form",
1011
- explode: true,
1012
- },
1013
- itemsPerPage: {
1014
- style: "form",
1015
- explode: true,
1016
- },
1017
- cursor: {
1018
- style: "form",
1019
- explode: true,
1020
- },
1021
- },
1022
- parameters: {
1023
- privateServersTab: z.union([z.literal(0), z.literal(1)]).optional(),
1024
- itemsPerPage: z.number().int().optional().default(25),
1025
- cursor: z.string().optional(),
1026
- },
1027
- response: Roblox_Games_Api_Models_Response_MyPrivateServersResponse,
1028
- errors: [
1029
- {
1030
- status: 400,
1031
- description: `39: Invalid cursor provided in the request.`,
1032
- },
1033
- {
1034
- status: 401,
1035
- description: `0: Authorization has been denied for this request.`,
1036
- },
1037
- ],
1038
- });
1039
- /**
1040
- * @api GET https://games.roblox.com/v1/vip-server/can-invite/:userId
1041
- * @summary Determines if a user by id is allowed to receive a VIP Server invite from the authenticated user.
1042
- * @param userId The user id.
1043
- */
1044
- export const getVipServerCanInviteUserid = endpoint({
1045
- method: "GET",
1046
- path: "/v1/vip-server/can-invite/:userId",
1047
- baseUrl: "https://games.roblox.com",
1048
- requestFormat: "json",
1049
- serializationMethod: {
1050
- userId: {
1051
- style: "simple",
1052
- },
1053
- },
1054
- parameters: {
1055
- userId: z.number().int(),
1056
- },
1057
- response: Roblox_Games_Api_VipServerCanInviteResponse,
1058
- errors: [
1059
- {
1060
- status: 401,
1061
- description: `0: Authorization has been denied for this request.`,
1062
- },
1063
- {
1064
- status: 404,
1065
- description: `19: The user is does not exist.`,
1066
- },
1067
- ],
1068
- });
1069
- /**
1070
- * @api GET https://games.roblox.com/v1/vip-servers/:id
1071
- * @summary Get necessary data to generate webpage
1072
- * @param id The VIP Server ID
1073
- */
1074
- export const getVipServersId = endpoint({
1075
- method: "GET",
1076
- path: "/v1/vip-servers/:id",
1077
- baseUrl: "https://games.roblox.com",
1078
- requestFormat: "json",
1079
- serializationMethod: {
1080
- id: {
1081
- style: "simple",
1082
- },
1083
- },
1084
- parameters: {
1085
- id: z.number().int(),
1086
- },
1087
- response: Roblox_Games_Api_VipServerResponse,
1088
- errors: [
1089
- {
1090
- status: 400,
1091
- description: `8: The creator of this game has disabled private servers for this game.`,
1092
- },
1093
- {
1094
- status: 401,
1095
- description: `0: Authorization has been denied for this request.`,
1096
- },
1097
- {
1098
- status: 403,
1099
- description: `2: You are not the owner of this private server.`,
1100
- },
1101
- {
1102
- status: 404,
1103
- description: `1: The private server is invalid or does not exist.
1104
- 4: The universe does not exist.`,
1105
- },
1106
- ],
1107
- });
1108
- /**
1109
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id
1110
- * @summary Updates vip server
1111
- * @param body The Roblox.Games.Api.VipServerUpdateRequest
1112
- * @param id The VIP Server ID
1113
- */
1114
- export const patchVipServersId = endpoint({
1115
- method: "PATCH",
1116
- path: "/v1/vip-servers/:id",
1117
- baseUrl: "https://games.roblox.com",
1118
- requestFormat: "json",
1119
- serializationMethod: {
1120
- body: {},
1121
- id: {
1122
- style: "simple",
1123
- },
1124
- },
1125
- parameters: {
1126
- id: z.number().int(),
1127
- },
1128
- body: Roblox_Games_Api_VipServerUpdateRequest,
1129
- response: Roblox_Games_Api_VipServerResponse,
1130
- errors: [
1131
- {
1132
- status: 400,
1133
- description: `8: The creator of this game has disabled private servers for this game.
1134
- 10: The name of the private server is either empty or too long.`,
1135
- },
1136
- {
1137
- status: 401,
1138
- description: `0: Authorization has been denied for this request.`,
1139
- },
1140
- {
1141
- status: 403,
1142
- description: `0: Token Validation Failed
1143
- 2: You are not the owner of this private server.
1144
- 11: You cannot activate a cancelled private server.
1145
- 12: The game must not be Friends Only to allow private servers.
1146
- 13: Join Link can be generated only for active private servers.`,
1147
- },
1148
- {
1149
- status: 404,
1150
- description: `1: The private server is invalid or does not exist.
1151
- 4: The universe does not exist.`,
1152
- },
1153
- {
1154
- status: 429,
1155
- description: `3: Please wait a few minutes before configuring your private server again.`,
1156
- },
1157
- ],
1158
- });
1159
- /**
1160
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id/permissions
1161
- * @summary Update friend/clan access and allowed friends/clan list
1162
- * @param body The Roblox.Games.Api.VipServerUpdatePermissionsRequest
1163
- * @param id The VIP Server ID
1164
- */
1165
- export const patchVipServersIdPermissions = endpoint({
1166
- method: "PATCH",
1167
- path: "/v1/vip-servers/:id/permissions",
1168
- baseUrl: "https://games.roblox.com",
1169
- requestFormat: "json",
1170
- serializationMethod: {
1171
- body: {},
1172
- id: {
1173
- style: "simple",
1174
- },
1175
- },
1176
- parameters: {
1177
- id: z.number().int(),
1178
- },
1179
- body: Roblox_Games_Api_VipServerUpdatePermissionsRequest,
1180
- response: Roblox_Games_Api_VipServerPermissionsResponse,
1181
- errors: [
1182
- {
1183
- status: 400,
1184
- description: `6: You cannot add so many players to the private server's invite list.
1185
- 8: The creator of this game has disabled private servers for this game.
1186
- 12: The game must not be Friends Only to allow private servers.
1187
- 28: You may only add or remove valid players to your private server's invite list.
1188
- 29: You may only add or remove players when your private server is active.`,
1189
- },
1190
- {
1191
- status: 401,
1192
- description: `0: Authorization has been denied for this request.`,
1193
- },
1194
- {
1195
- status: 403,
1196
- description: `0: Token Validation Failed
1197
- 2: You are not the owner of this private server.`,
1198
- },
1199
- {
1200
- status: 404,
1201
- description: `1: The private server is invalid or does not exist.
1202
- 4: The universe does not exist.`,
1203
- },
1204
- ],
1205
- });
1206
- /**
1207
- * @api PATCH https://games.roblox.com/v1/vip-servers/:id/subscription
1208
- * @summary Updates subscription status of a vip server
1209
- * @param body The Roblox.Games.Api.VipServerUpdateSubscriptionRequest
1210
- * @param id The VIP Server ID
1211
- */
1212
- export const patchVipServersIdSubscription = endpoint({
1213
- method: "PATCH",
1214
- path: "/v1/vip-servers/:id/subscription",
1215
- baseUrl: "https://games.roblox.com",
1216
- requestFormat: "json",
1217
- serializationMethod: {
1218
- body: {},
1219
- id: {
1220
- style: "simple",
1221
- },
1222
- },
1223
- parameters: {
1224
- id: z.number().int(),
1225
- },
1226
- body: Roblox_Games_Api_VipServerUpdateSubscriptionRequest,
1227
- response: Roblox_Games_Api_VipServerSubscriptionResponse,
1228
- errors: [
1229
- {
1230
- status: 400,
1231
- description: `8: The creator of this game has disabled private servers for this game.
1232
- 32: You do not have enough funds available to renew the subscription for this private server.`,
1233
- },
1234
- {
1235
- status: 401,
1236
- description: `0: Authorization has been denied for this request.`,
1237
- },
1238
- {
1239
- status: 403,
1240
- description: `0: Token Validation Failed
1241
- 2: You are not the owner of this private server.
1242
- 21: You may not configure a cancelled private server. Please renew your subscription before configuring.`,
1243
- },
1244
- {
1245
- status: 404,
1246
- description: `1: The private server is invalid or does not exist.
1247
- 4: The universe does not exist.`,
1248
- },
1249
- {
1250
- status: 429,
1251
- description: `3: Please wait a few minutes before configuring your private server again.`,
1252
- },
1253
- ],
1254
- });