rozod 6.8.0 → 6.9.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.
- package/lib/endpoints/accountinformationv1.d.ts +92 -95
- package/lib/endpoints/accountsettingsv1.d.ts +88 -110
- package/lib/endpoints/adconfigurationv2.d.ts +108 -215
- package/lib/endpoints/assetdeliveryv1.d.ts +236 -237
- package/lib/endpoints/assetdeliveryv2.d.ts +180 -181
- package/lib/endpoints/authv1.d.ts +479 -521
- package/lib/endpoints/authv2.d.ts +209 -221
- package/lib/endpoints/authv3.d.ts +32 -35
- package/lib/endpoints/avatarv1.d.ts +112 -117
- package/lib/endpoints/avatarv2.d.ts +71 -76
- package/lib/endpoints/avatarv3.d.ts +27 -33
- package/lib/endpoints/badgesv1.d.ts +92 -99
- package/lib/endpoints/catalogv1.d.ts +207 -233
- package/lib/endpoints/catalogv2.d.ts +81 -119
- package/lib/endpoints/clientsettingsv1.d.ts +33 -35
- package/lib/endpoints/clientsettingsv2.d.ts +62 -68
- package/lib/endpoints/contactsv1.d.ts +18 -20
- package/lib/endpoints/developv1.d.ts +230 -293
- package/lib/endpoints/developv2.d.ts +84 -137
- package/lib/endpoints/economycreatorstatsv1.d.ts +12 -12
- package/lib/endpoints/economyv1.d.ts +6 -6
- package/lib/endpoints/engagementpayoutsv1.d.ts +9 -9
- package/lib/endpoints/followingsv1.d.ts +33 -34
- package/lib/endpoints/followingsv2.d.ts +9 -9
- package/lib/endpoints/friendsv1.d.ts +200 -237
- package/lib/endpoints/gameinternationalizationv1.d.ts +1509 -1642
- package/lib/endpoints/gameinternationalizationv2.d.ts +62 -64
- package/lib/endpoints/gamesv1.d.ts +181 -143
- package/lib/endpoints/gamesv2.d.ts +161 -169
- package/lib/endpoints/groupsv1.d.ts +938 -988
- package/lib/endpoints/groupsv2.d.ts +259 -278
- package/lib/endpoints/inventoryv1.d.ts +91 -122
- package/lib/endpoints/inventoryv2.d.ts +163 -180
- package/lib/endpoints/itemconfigurationv1.d.ts +33 -40
- package/lib/endpoints/localev1.d.ts +47 -48
- package/lib/endpoints/localizationtablesv1.d.ts +315 -353
- package/lib/endpoints/matchmakingv1.d.ts +184 -190
- package/lib/endpoints/notificationsv2.d.ts +144 -158
- package/lib/endpoints/premiumfeaturesv1.d.ts +14 -14
- package/lib/endpoints/presencev1.d.ts +7 -12
- package/lib/endpoints/privatemessagesv1.d.ts +56 -64
- package/lib/endpoints/publishv1.d.ts +32 -32
- package/lib/endpoints/thumbnailsresizerv1.d.ts +52 -53
- package/lib/endpoints/thumbnailsv1.d.ts +325 -326
- package/lib/endpoints/thumbnailsv1.js +24 -24
- package/lib/endpoints/tradesv1.d.ts +92 -104
- package/lib/endpoints/tradesv2.d.ts +81 -84
- package/lib/endpoints/translationrolesv1.d.ts +46 -51
- package/lib/endpoints/twostepverificationv1.d.ts +233 -237
- package/lib/endpoints/usersv1.d.ts +110 -114
- package/lib/index.d.ts +56 -1
- package/lib/index.js +159 -3
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { z } from
|
|
2
|
-
import { endpoint } from
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { endpoint } from '..';
|
|
3
3
|
|
|
4
4
|
const Roblox_Games_Api_Models_Response_GameCreator = z.object({
|
|
5
5
|
id: z.number().int(),
|
|
@@ -49,10 +49,9 @@ const Roblox_Games_Api_Models_Response_GameDetailResponse = z.object({
|
|
|
49
49
|
canonicalUrlPath: z.string(),
|
|
50
50
|
isContentRestricted: z.boolean(),
|
|
51
51
|
});
|
|
52
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameDetailResponse_ =
|
|
53
|
-
z.
|
|
54
|
-
|
|
55
|
-
});
|
|
52
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameDetailResponse_ = z.object({
|
|
53
|
+
data: z.array(Roblox_Games_Api_Models_Response_GameDetailResponse),
|
|
54
|
+
});
|
|
56
55
|
const Roblox_Games_Api_GameServerPlayerResponse = z.object({
|
|
57
56
|
playerToken: z.string(),
|
|
58
57
|
id: z.number().int(),
|
|
@@ -78,12 +77,11 @@ const Roblox_Web_Responses_Games_GameServerResponse = z.object({
|
|
|
78
77
|
accessCode: z.string().uuid(),
|
|
79
78
|
owner: Roblox_Games_Api_Models_Response_VerifiedBadgeUserResponse,
|
|
80
79
|
});
|
|
81
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Web_Responses_Games_GameServerResponse_ =
|
|
82
|
-
z.
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
});
|
|
80
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Web_Responses_Games_GameServerResponse_ = z.object({
|
|
81
|
+
previousPageCursor: z.string(),
|
|
82
|
+
nextPageCursor: z.string(),
|
|
83
|
+
data: z.array(Roblox_Web_Responses_Games_GameServerResponse),
|
|
84
|
+
});
|
|
87
85
|
const Roblox_Games_Api_Models_Response_GameFavoriteResponse = z.object({
|
|
88
86
|
isFavorited: z.boolean(),
|
|
89
87
|
});
|
|
@@ -104,8 +102,9 @@ const Roblox_Games_Api_Models_Response_GameMediaItem = z.object({
|
|
|
104
102
|
approved: z.boolean(),
|
|
105
103
|
altText: z.string(),
|
|
106
104
|
});
|
|
107
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameMediaItem_ =
|
|
108
|
-
|
|
105
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameMediaItem_ = z.object({
|
|
106
|
+
data: z.array(Roblox_Games_Api_Models_Response_GameMediaItem),
|
|
107
|
+
});
|
|
109
108
|
const Roblox_Games_Api_Models_Response_PurchaseData = z.object({
|
|
110
109
|
localizedFiatPrice: z.string(),
|
|
111
110
|
basePriceId: z.string(),
|
|
@@ -118,10 +117,9 @@ const Roblox_Games_Api_Models_Response_GameProductResponse = z.object({
|
|
|
118
117
|
sellerId: z.number().int(),
|
|
119
118
|
fiatPurchaseData: Roblox_Games_Api_Models_Response_PurchaseData,
|
|
120
119
|
});
|
|
121
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameProductResponse_ =
|
|
122
|
-
z.
|
|
123
|
-
|
|
124
|
-
});
|
|
120
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameProductResponse_ = z.object({
|
|
121
|
+
data: z.array(Roblox_Games_Api_Models_Response_GameProductResponse),
|
|
122
|
+
});
|
|
125
123
|
const Roblox_Games_Api_Models_Response_PlaceDetails = z.object({
|
|
126
124
|
placeId: z.number().int(),
|
|
127
125
|
name: z.string(),
|
|
@@ -159,35 +157,35 @@ const Roblox_Games_Api_Models_Response_UpsellUxTreatment = z.object({
|
|
|
159
157
|
});
|
|
160
158
|
const Roblox_Games_Api_Models_Response_PlayabilityStatusResponse = z.object({
|
|
161
159
|
playabilityStatus: z.enum([
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
160
|
+
'UnplayableOtherReason',
|
|
161
|
+
'Playable',
|
|
162
|
+
'GuestProhibited',
|
|
163
|
+
'GameUnapproved',
|
|
164
|
+
'IncorrectConfiguration',
|
|
165
|
+
'UniverseRootPlaceIsPrivate',
|
|
166
|
+
'InsufficientPermissionFriendsOnly',
|
|
167
|
+
'InsufficientPermissionGroupOnly',
|
|
168
|
+
'DeviceRestricted',
|
|
169
|
+
'UnderReview',
|
|
170
|
+
'PurchaseRequired',
|
|
171
|
+
'AccountRestricted',
|
|
172
|
+
'TemporarilyUnavailable',
|
|
173
|
+
'PlaceHasNoPublishedVersion',
|
|
174
|
+
'ComplianceBlocked',
|
|
175
|
+
'ContextualPlayabilityRegionalAvailability',
|
|
176
|
+
'ContextualPlayabilityRegionalCompliance',
|
|
177
|
+
'ContextualPlayabilityAgeRecommendationParentalControls',
|
|
178
|
+
'ContextualPlayabilityExperienceBlockedParentalControls',
|
|
179
|
+
'ContextualPlayabilityAgeGated',
|
|
180
|
+
'ContextualPlayabilityUnverifiedSeventeenPlusUser',
|
|
181
|
+
'FiatPurchaseRequired',
|
|
182
|
+
'FiatPurchaseDeviceRestricted',
|
|
183
|
+
'ContextualPlayabilityUnrated',
|
|
184
|
+
'ContextualPlayabilityAgeGatedByDescriptor',
|
|
185
|
+
'ContextualPlayabilityGeneral',
|
|
186
|
+
'ContextualPlayabilityAgeCheckRequired',
|
|
187
|
+
'ContextualPlayabilityRequireParentApproval',
|
|
188
|
+
'ContextualPlayabilityCoreGated',
|
|
191
189
|
]),
|
|
192
190
|
isPlayable: z.boolean(),
|
|
193
191
|
universeId: z.number().int(),
|
|
@@ -196,14 +194,13 @@ const Roblox_Games_Api_Models_Response_PlayabilityStatusResponse = z.object({
|
|
|
196
194
|
upsellUxTreatment: Roblox_Games_Api_Models_Response_UpsellUxTreatment,
|
|
197
195
|
demoModeAvailable: z.boolean(),
|
|
198
196
|
});
|
|
199
|
-
const Roblox_Games_Api_Models_Response_GameContentMetadataResponseModel =
|
|
200
|
-
z.
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
});
|
|
197
|
+
const Roblox_Games_Api_Models_Response_GameContentMetadataResponseModel = z.object({
|
|
198
|
+
badgePosition: z.string(),
|
|
199
|
+
badgeAnalyticsId: z.string(),
|
|
200
|
+
badgeType: z.string(),
|
|
201
|
+
badgeIcon: z.string(),
|
|
202
|
+
badgeComponentType: z.string(),
|
|
203
|
+
});
|
|
207
204
|
const Roblox_Games_Api_Models_Response_GameResponseModel = z.object({
|
|
208
205
|
creatorId: z.number().int(),
|
|
209
206
|
creatorName: z.string(),
|
|
@@ -225,8 +222,7 @@ const Roblox_Games_Api_Models_Response_GameResponseModel = z.object({
|
|
|
225
222
|
genre: z.string(),
|
|
226
223
|
minimumAge: z.number().int(),
|
|
227
224
|
ageRecommendationDisplayName: z.string(),
|
|
228
|
-
contentMetadata:
|
|
229
|
-
Roblox_Games_Api_Models_Response_GameContentMetadataResponseModel,
|
|
225
|
+
contentMetadata: Roblox_Games_Api_Models_Response_GameContentMetadataResponseModel,
|
|
230
226
|
canonicalUrlPath: z.string(),
|
|
231
227
|
});
|
|
232
228
|
const Roblox_Games_Api_Models_Response_GameRecommendationsResponse = z.object({
|
|
@@ -241,16 +237,16 @@ const Roblox_Games_Api_Models_Response_GameRecommendationsResponse = z.object({
|
|
|
241
237
|
* @param fields Optional comma-separated list of field names to include in the response. When omitted, all fields are returned.
|
|
242
238
|
*/
|
|
243
239
|
export const getGames = endpoint({
|
|
244
|
-
method:
|
|
245
|
-
path:
|
|
246
|
-
baseUrl:
|
|
247
|
-
requestFormat:
|
|
240
|
+
method: 'GET',
|
|
241
|
+
path: '/v1/games',
|
|
242
|
+
baseUrl: 'https://games.roblox.com',
|
|
243
|
+
requestFormat: 'json',
|
|
248
244
|
serializationMethod: {
|
|
249
245
|
universeIds: {
|
|
250
|
-
style:
|
|
246
|
+
style: 'form',
|
|
251
247
|
},
|
|
252
248
|
fields: {
|
|
253
|
-
style:
|
|
249
|
+
style: 'form',
|
|
254
250
|
explode: true,
|
|
255
251
|
},
|
|
256
252
|
},
|
|
@@ -258,8 +254,7 @@ export const getGames = endpoint({
|
|
|
258
254
|
universeIds: z.array(z.number()),
|
|
259
255
|
fields: z.string().optional(),
|
|
260
256
|
},
|
|
261
|
-
response:
|
|
262
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameDetailResponse_,
|
|
257
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameDetailResponse_,
|
|
263
258
|
errors: [
|
|
264
259
|
{
|
|
265
260
|
status: 400,
|
|
@@ -283,31 +278,31 @@ export const getGames = endpoint({
|
|
|
283
278
|
* @param cursor The paging cursor for the previous or next page.
|
|
284
279
|
*/
|
|
285
280
|
export const getGamesPlaceidServersServertype = endpoint({
|
|
286
|
-
method:
|
|
287
|
-
path:
|
|
288
|
-
baseUrl:
|
|
289
|
-
requestFormat:
|
|
281
|
+
method: 'GET',
|
|
282
|
+
path: '/v1/games/:placeId/servers/:serverType',
|
|
283
|
+
baseUrl: 'https://games.roblox.com',
|
|
284
|
+
requestFormat: 'json',
|
|
290
285
|
serializationMethod: {
|
|
291
286
|
placeId: {
|
|
292
|
-
style:
|
|
287
|
+
style: 'simple',
|
|
293
288
|
},
|
|
294
289
|
serverType: {
|
|
295
|
-
style:
|
|
290
|
+
style: 'simple',
|
|
296
291
|
},
|
|
297
292
|
sortOrder: {
|
|
298
|
-
style:
|
|
293
|
+
style: 'form',
|
|
299
294
|
explode: true,
|
|
300
295
|
},
|
|
301
296
|
excludeFullGames: {
|
|
302
|
-
style:
|
|
297
|
+
style: 'form',
|
|
303
298
|
explode: true,
|
|
304
299
|
},
|
|
305
300
|
limit: {
|
|
306
|
-
style:
|
|
301
|
+
style: 'form',
|
|
307
302
|
explode: true,
|
|
308
303
|
},
|
|
309
304
|
cursor: {
|
|
310
|
-
style:
|
|
305
|
+
style: 'form',
|
|
311
306
|
explode: true,
|
|
312
307
|
},
|
|
313
308
|
},
|
|
@@ -325,8 +320,7 @@ export const getGamesPlaceidServersServertype = endpoint({
|
|
|
325
320
|
.default(10),
|
|
326
321
|
cursor: z.string().optional(),
|
|
327
322
|
},
|
|
328
|
-
response:
|
|
329
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Web_Responses_Games_GameServerResponse_,
|
|
323
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Web_Responses_Games_GameServerResponse_,
|
|
330
324
|
errors: [
|
|
331
325
|
{
|
|
332
326
|
status: 400,
|
|
@@ -346,13 +340,13 @@ export const getGamesPlaceidServersServertype = endpoint({
|
|
|
346
340
|
* @param universeId The Id of the universe.
|
|
347
341
|
*/
|
|
348
342
|
export const getGamesUniverseidFavorites = endpoint({
|
|
349
|
-
method:
|
|
350
|
-
path:
|
|
351
|
-
baseUrl:
|
|
352
|
-
requestFormat:
|
|
343
|
+
method: 'GET',
|
|
344
|
+
path: '/v1/games/:universeId/favorites',
|
|
345
|
+
baseUrl: 'https://games.roblox.com',
|
|
346
|
+
requestFormat: 'json',
|
|
353
347
|
serializationMethod: {
|
|
354
348
|
universeId: {
|
|
355
|
-
style:
|
|
349
|
+
style: 'simple',
|
|
356
350
|
},
|
|
357
351
|
},
|
|
358
352
|
parameters: {
|
|
@@ -381,14 +375,14 @@ export const getGamesUniverseidFavorites = endpoint({
|
|
|
381
375
|
* @param universeId The Id of the universe.
|
|
382
376
|
*/
|
|
383
377
|
export const postGamesUniverseidFavorites = endpoint({
|
|
384
|
-
method:
|
|
385
|
-
path:
|
|
386
|
-
baseUrl:
|
|
387
|
-
requestFormat:
|
|
378
|
+
method: 'POST',
|
|
379
|
+
path: '/v1/games/:universeId/favorites',
|
|
380
|
+
baseUrl: 'https://games.roblox.com',
|
|
381
|
+
requestFormat: 'json',
|
|
388
382
|
serializationMethod: {
|
|
389
383
|
body: {},
|
|
390
384
|
universeId: {
|
|
391
|
-
style:
|
|
385
|
+
style: 'simple',
|
|
392
386
|
},
|
|
393
387
|
},
|
|
394
388
|
parameters: {
|
|
@@ -426,13 +420,13 @@ export const postGamesUniverseidFavorites = endpoint({
|
|
|
426
420
|
* @param universeId The Id of the universe.
|
|
427
421
|
*/
|
|
428
422
|
export const getGamesUniverseidFavoritesCount = endpoint({
|
|
429
|
-
method:
|
|
430
|
-
path:
|
|
431
|
-
baseUrl:
|
|
432
|
-
requestFormat:
|
|
423
|
+
method: 'GET',
|
|
424
|
+
path: '/v1/games/:universeId/favorites/count',
|
|
425
|
+
baseUrl: 'https://games.roblox.com',
|
|
426
|
+
requestFormat: 'json',
|
|
433
427
|
serializationMethod: {
|
|
434
428
|
universeId: {
|
|
435
|
-
style:
|
|
429
|
+
style: 'simple',
|
|
436
430
|
},
|
|
437
431
|
},
|
|
438
432
|
parameters: {
|
|
@@ -456,20 +450,19 @@ export const getGamesUniverseidFavoritesCount = endpoint({
|
|
|
456
450
|
* @param universeId The id of the universe we get media data from.
|
|
457
451
|
*/
|
|
458
452
|
export const getGamesUniverseidMedia = endpoint({
|
|
459
|
-
method:
|
|
460
|
-
path:
|
|
461
|
-
baseUrl:
|
|
462
|
-
requestFormat:
|
|
453
|
+
method: 'GET',
|
|
454
|
+
path: '/v1/games/:universeId/media',
|
|
455
|
+
baseUrl: 'https://games.roblox.com',
|
|
456
|
+
requestFormat: 'json',
|
|
463
457
|
serializationMethod: {
|
|
464
458
|
universeId: {
|
|
465
|
-
style:
|
|
459
|
+
style: 'simple',
|
|
466
460
|
},
|
|
467
461
|
},
|
|
468
462
|
parameters: {
|
|
469
463
|
universeId: z.number().int(),
|
|
470
464
|
},
|
|
471
|
-
response:
|
|
472
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameMediaItem_,
|
|
465
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameMediaItem_,
|
|
473
466
|
errors: [
|
|
474
467
|
{
|
|
475
468
|
status: 400,
|
|
@@ -487,20 +480,19 @@ export const getGamesUniverseidMedia = endpoint({
|
|
|
487
480
|
* @param universeIds A list of universe Ids. Cannot exceed a maximum of 100 IDs.
|
|
488
481
|
*/
|
|
489
482
|
export const getGamesGamesProductInfo = endpoint({
|
|
490
|
-
method:
|
|
491
|
-
path:
|
|
492
|
-
baseUrl:
|
|
493
|
-
requestFormat:
|
|
483
|
+
method: 'GET',
|
|
484
|
+
path: '/v1/games/games-product-info',
|
|
485
|
+
baseUrl: 'https://games.roblox.com',
|
|
486
|
+
requestFormat: 'json',
|
|
494
487
|
serializationMethod: {
|
|
495
488
|
universeIds: {
|
|
496
|
-
style:
|
|
489
|
+
style: 'form',
|
|
497
490
|
},
|
|
498
491
|
},
|
|
499
492
|
parameters: {
|
|
500
493
|
universeIds: z.array(z.number()),
|
|
501
494
|
},
|
|
502
|
-
response:
|
|
503
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameProductResponse_,
|
|
495
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Games_Api_Models_Response_GameProductResponse_,
|
|
504
496
|
errors: [
|
|
505
497
|
{
|
|
506
498
|
status: 400,
|
|
@@ -515,13 +507,13 @@ export const getGamesGamesProductInfo = endpoint({
|
|
|
515
507
|
* @param placeIds List of placeId to uniquely Identify a place
|
|
516
508
|
*/
|
|
517
509
|
export const getGamesMultigetPlaceDetails = endpoint({
|
|
518
|
-
method:
|
|
519
|
-
path:
|
|
520
|
-
baseUrl:
|
|
521
|
-
requestFormat:
|
|
510
|
+
method: 'GET',
|
|
511
|
+
path: '/v1/games/multiget-place-details',
|
|
512
|
+
baseUrl: 'https://games.roblox.com',
|
|
513
|
+
requestFormat: 'json',
|
|
522
514
|
serializationMethod: {
|
|
523
515
|
placeIds: {
|
|
524
|
-
style:
|
|
516
|
+
style: 'form',
|
|
525
517
|
explode: true,
|
|
526
518
|
},
|
|
527
519
|
},
|
|
@@ -542,13 +534,13 @@ export const getGamesMultigetPlaceDetails = endpoint({
|
|
|
542
534
|
* @param universeIds A list of universe Ids. Cannot exceed a maximum of 50 IDs.
|
|
543
535
|
*/
|
|
544
536
|
export const getGamesMultigetPlayabilityStatus = endpoint({
|
|
545
|
-
method:
|
|
546
|
-
path:
|
|
547
|
-
baseUrl:
|
|
548
|
-
requestFormat:
|
|
537
|
+
method: 'GET',
|
|
538
|
+
path: '/v1/games/multiget-playability-status',
|
|
539
|
+
baseUrl: 'https://games.roblox.com',
|
|
540
|
+
requestFormat: 'json',
|
|
549
541
|
serializationMethod: {
|
|
550
542
|
universeIds: {
|
|
551
|
-
style:
|
|
543
|
+
style: 'form',
|
|
552
544
|
},
|
|
553
545
|
},
|
|
554
546
|
parameters: {
|
|
@@ -573,24 +565,24 @@ This parameter is usually not needed for the first page.
|
|
|
573
565
|
* @param IsTruncatedResultsEnabled Truncated Results
|
|
574
566
|
*/
|
|
575
567
|
export const getGamesRecommendationsGameUniverseid = endpoint({
|
|
576
|
-
method:
|
|
577
|
-
path:
|
|
578
|
-
baseUrl:
|
|
579
|
-
requestFormat:
|
|
568
|
+
method: 'GET',
|
|
569
|
+
path: '/v1/games/recommendations/game/:universeId',
|
|
570
|
+
baseUrl: 'https://games.roblox.com',
|
|
571
|
+
requestFormat: 'json',
|
|
580
572
|
serializationMethod: {
|
|
581
573
|
universeId: {
|
|
582
|
-
style:
|
|
574
|
+
style: 'simple',
|
|
583
575
|
},
|
|
584
576
|
PaginationKey: {
|
|
585
|
-
style:
|
|
577
|
+
style: 'form',
|
|
586
578
|
explode: true,
|
|
587
579
|
},
|
|
588
580
|
MaxRows: {
|
|
589
|
-
style:
|
|
581
|
+
style: 'form',
|
|
590
582
|
explode: true,
|
|
591
583
|
},
|
|
592
584
|
IsTruncatedResultsEnabled: {
|
|
593
|
-
style:
|
|
585
|
+
style: 'form',
|
|
594
586
|
explode: true,
|
|
595
587
|
},
|
|
596
588
|
},
|
|
@@ -746,7 +738,10 @@ export const getGamesUniverseidGamePasses = endpoint({
|
|
|
746
738
|
parameters: {
|
|
747
739
|
universeId: z.number().int(),
|
|
748
740
|
limit: z.number().int(),
|
|
749
|
-
sortOrder: z
|
|
741
|
+
sortOrder: z
|
|
742
|
+
.union([z.literal(1), z.literal(2)])
|
|
743
|
+
.optional()
|
|
744
|
+
.default(1),
|
|
750
745
|
cursor: z.string().optional(),
|
|
751
746
|
},
|
|
752
747
|
response: Patch_ApiPageResponse_GamePassResponse,
|
|
@@ -766,11 +761,20 @@ export const patchGamesUniverseidUserVotes = endpoint({
|
|
|
766
761
|
body: z.object({ vote: z.boolean() }),
|
|
767
762
|
response: z.object({}),
|
|
768
763
|
errors: [
|
|
769
|
-
{
|
|
764
|
+
{
|
|
765
|
+
status: 400,
|
|
766
|
+
description: `2: The universe's root place is invalid.\n3: The asset is not voteable.\n4: The requested vote is invalid.`,
|
|
767
|
+
},
|
|
770
768
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
771
|
-
{
|
|
769
|
+
{
|
|
770
|
+
status: 403,
|
|
771
|
+
description: `0: Token Validation Failed\n6: The user needs to play the game before vote.\n7: The user needs additional permission to vote.`,
|
|
772
|
+
},
|
|
772
773
|
{ status: 404, description: `1: The requested universe does not exist.` },
|
|
773
|
-
{
|
|
774
|
+
{
|
|
775
|
+
status: 429,
|
|
776
|
+
description: `5: Too many attempts to vote. Please try again later.\n10: Internal service busy. Please try again later.`,
|
|
777
|
+
},
|
|
774
778
|
{ status: 500, description: `0: An unknown error occurred.` },
|
|
775
779
|
],
|
|
776
780
|
});
|
|
@@ -817,7 +821,10 @@ export const getGamesVotes = endpoint({
|
|
|
817
821
|
parameters: { universeIds: z.array(z.number()) },
|
|
818
822
|
response: Patch_ApiArrayResponse_GameVoteResponse,
|
|
819
823
|
errors: [
|
|
820
|
-
{
|
|
824
|
+
{
|
|
825
|
+
status: 400,
|
|
826
|
+
description: `3: The asset is not voteable.\n8: No universe IDs were specified.\n9: Too many universe IDs were requested.`,
|
|
827
|
+
},
|
|
821
828
|
{ status: 429, description: `10: Internal service busy. Please try again later.` },
|
|
822
829
|
{ status: 500, description: `0: An unknown error occurred.` },
|
|
823
830
|
],
|
|
@@ -871,7 +878,10 @@ export const getVipServersId = endpoint({
|
|
|
871
878
|
{ status: 400, description: `8: The creator of this game has disabled private servers for this game.` },
|
|
872
879
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
873
880
|
{ status: 403, description: `2: You are not the owner of this private server.` },
|
|
874
|
-
{
|
|
881
|
+
{
|
|
882
|
+
status: 404,
|
|
883
|
+
description: `1: The private server is invalid or does not exist.\n4: The universe does not exist.`,
|
|
884
|
+
},
|
|
875
885
|
],
|
|
876
886
|
});
|
|
877
887
|
|
|
@@ -885,10 +895,19 @@ export const patchVipServersId = endpoint({
|
|
|
885
895
|
body: Patch_VipServerUpdateRequest,
|
|
886
896
|
response: Patch_VipServerResponse,
|
|
887
897
|
errors: [
|
|
888
|
-
{
|
|
898
|
+
{
|
|
899
|
+
status: 400,
|
|
900
|
+
description: `8: The creator of this game has disabled private servers for this game.\n10: The name of the private server is either empty or too long.`,
|
|
901
|
+
},
|
|
889
902
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
890
|
-
{
|
|
891
|
-
|
|
903
|
+
{
|
|
904
|
+
status: 403,
|
|
905
|
+
description: `0: Token Validation Failed\n2: You are not the owner of this private server.\n11: You cannot activate a cancelled private server.\n12: The game must not be Friends Only to allow private servers.\n13: Join Link can be generated only for active private servers.`,
|
|
906
|
+
},
|
|
907
|
+
{
|
|
908
|
+
status: 404,
|
|
909
|
+
description: `1: The private server is invalid or does not exist.\n4: The universe does not exist.`,
|
|
910
|
+
},
|
|
892
911
|
{ status: 429, description: `3: Please wait a few minutes before configuring your private server again.` },
|
|
893
912
|
],
|
|
894
913
|
});
|
|
@@ -903,10 +922,16 @@ export const patchVipServersIdPermissions = endpoint({
|
|
|
903
922
|
body: Patch_VipServerUpdatePermissionsRequest,
|
|
904
923
|
response: Patch_VipServerPermissionsResponse,
|
|
905
924
|
errors: [
|
|
906
|
-
{
|
|
925
|
+
{
|
|
926
|
+
status: 400,
|
|
927
|
+
description: `6: You cannot add so many players to the private server's invite list.\n8: The creator of this game has disabled private servers for this game.\n12: The game must not be Friends Only to allow private servers.\n28: You may only add or remove valid players to your private server's invite list.\n29: You may only add or remove players when your private server is active.`,
|
|
928
|
+
},
|
|
907
929
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
908
930
|
{ status: 403, description: `0: Token Validation Failed\n2: You are not the owner of this private server.` },
|
|
909
|
-
{
|
|
931
|
+
{
|
|
932
|
+
status: 404,
|
|
933
|
+
description: `1: The private server is invalid or does not exist.\n4: The universe does not exist.`,
|
|
934
|
+
},
|
|
910
935
|
],
|
|
911
936
|
});
|
|
912
937
|
|
|
@@ -920,10 +945,19 @@ export const patchVipServersIdSubscription = endpoint({
|
|
|
920
945
|
body: Patch_VipServerUpdateSubscriptionRequest,
|
|
921
946
|
response: Patch_VipServerSubscriptionResponse,
|
|
922
947
|
errors: [
|
|
923
|
-
{
|
|
948
|
+
{
|
|
949
|
+
status: 400,
|
|
950
|
+
description: `8: The creator of this game has disabled private servers for this game.\n32: You do not have enough funds available to renew the subscription for this private server.`,
|
|
951
|
+
},
|
|
924
952
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
925
|
-
{
|
|
926
|
-
|
|
953
|
+
{
|
|
954
|
+
status: 403,
|
|
955
|
+
description: `0: Token Validation Failed\n2: You are not the owner of this private server.\n21: You may not configure a cancelled private server. Please renew your subscription before configuring.`,
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
status: 404,
|
|
959
|
+
description: `1: The private server is invalid or does not exist.\n4: The universe does not exist.`,
|
|
960
|
+
},
|
|
927
961
|
{ status: 429, description: `3: Please wait a few minutes before configuring your private server again.` },
|
|
928
962
|
],
|
|
929
963
|
});
|
|
@@ -938,11 +972,17 @@ export const postGamesVipServersUniverseid = endpoint({
|
|
|
938
972
|
body: Patch_CreateVipServersRequest,
|
|
939
973
|
response: Roblox_Web_Responses_Games_GameServerResponse,
|
|
940
974
|
errors: [
|
|
941
|
-
{
|
|
975
|
+
{
|
|
976
|
+
status: 400,
|
|
977
|
+
description: `15: The price for purchasing this private server has changed. Please refresh the page and try again.`,
|
|
978
|
+
},
|
|
942
979
|
{ status: 401, description: `0: Authorization has been denied for this request.` },
|
|
943
980
|
{ status: 403, description: `0: Token Validation Failed` },
|
|
944
981
|
{ status: 404, description: `4: The universe does not exist.` },
|
|
945
|
-
{
|
|
982
|
+
{
|
|
983
|
+
status: 500,
|
|
984
|
+
description: `16: We are having a problem completing your purchase. Please try again in a few minutes.`,
|
|
985
|
+
},
|
|
946
986
|
],
|
|
947
987
|
});
|
|
948
988
|
|
|
@@ -990,7 +1030,5 @@ export const getPrivateServersEnabledInUniverseUniverseid = endpoint({
|
|
|
990
1030
|
serializationMethod: { universeId: { style: 'simple' } },
|
|
991
1031
|
parameters: { universeId: z.number().int() },
|
|
992
1032
|
response: z.object({ privateServersEnabled: z.boolean() }),
|
|
993
|
-
errors: [
|
|
994
|
-
{ status: 400, description: `8: The universe IDs specified are invalid.` },
|
|
995
|
-
],
|
|
1033
|
+
errors: [{ status: 400, description: `8: The universe IDs specified are invalid.` }],
|
|
996
1034
|
});
|