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,16 +1,14 @@
|
|
|
1
|
-
import { z } from
|
|
2
|
-
import { endpoint } from
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { endpoint } from '..';
|
|
3
3
|
|
|
4
|
-
const Roblox_Friends_Api_Models_Response_FriendsPageMetadataResponse = z.object(
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}
|
|
13
|
-
);
|
|
4
|
+
const Roblox_Friends_Api_Models_Response_FriendsPageMetadataResponse = z.object({
|
|
5
|
+
isFriendsFilterBarEnabled: z.boolean(),
|
|
6
|
+
isFriendsPageSortExperimentEnabled: z.boolean(),
|
|
7
|
+
isFriendsUserDataStoreCacheEnabled: z.boolean(),
|
|
8
|
+
frequentFriendSortRollout: z.number().int(),
|
|
9
|
+
userName: z.string(),
|
|
10
|
+
displayName: z.string(),
|
|
11
|
+
});
|
|
14
12
|
const Roblox_Friends_Api_FriendsCountResponse = z.object({
|
|
15
13
|
count: z.number().int(),
|
|
16
14
|
});
|
|
@@ -19,18 +17,18 @@ const Roblox_Friends_Api_FriendRequest = z.object({
|
|
|
19
17
|
senderId: z.number().int(),
|
|
20
18
|
sourceUniverseId: z.number().int(),
|
|
21
19
|
originSourceType: z.enum([
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
20
|
+
'Unknown',
|
|
21
|
+
'PlayerSearch',
|
|
22
|
+
'QrCode',
|
|
23
|
+
'InGame',
|
|
24
|
+
'UserProfile',
|
|
25
|
+
'QqContactImporter',
|
|
26
|
+
'WeChatContactImporter',
|
|
27
|
+
'ProfileShare',
|
|
28
|
+
'PhoneContactImporter',
|
|
29
|
+
'FriendRecommendations',
|
|
30
|
+
'UserCommunities',
|
|
31
|
+
'TrustedFriend',
|
|
34
32
|
]),
|
|
35
33
|
contactName: z.string(),
|
|
36
34
|
senderNickname: z.string(),
|
|
@@ -47,26 +45,18 @@ const Roblox_Friends_Api_FriendRequestResponse = z.object({
|
|
|
47
45
|
name: z.string(),
|
|
48
46
|
displayName: z.string(),
|
|
49
47
|
});
|
|
50
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_FriendRequestResponse_ =
|
|
51
|
-
z.
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
const Roblox_Friends_Api_Models_Response_NewFriendRequestsCountResponse =
|
|
57
|
-
z.object({ count: z.number().int() });
|
|
48
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_FriendRequestResponse_ = z.object({
|
|
49
|
+
previousPageCursor: z.string(),
|
|
50
|
+
nextPageCursor: z.string(),
|
|
51
|
+
data: z.array(Roblox_Friends_Api_FriendRequestResponse),
|
|
52
|
+
});
|
|
53
|
+
const Roblox_Friends_Api_Models_Response_NewFriendRequestsCountResponse = z.object({ count: z.number().int() });
|
|
58
54
|
const Roblox_Friends_Api_PendingFriendRequestCountModel = z.object({
|
|
59
55
|
count: z.number().int(),
|
|
60
56
|
});
|
|
61
57
|
const Roblox_Friends_Api_Models_Response_UserResponse = z.object({
|
|
62
58
|
isOnline: z.boolean(),
|
|
63
|
-
presenceType: z.union([
|
|
64
|
-
z.literal(0),
|
|
65
|
-
z.literal(1),
|
|
66
|
-
z.literal(2),
|
|
67
|
-
z.literal(3),
|
|
68
|
-
z.literal(4),
|
|
69
|
-
]),
|
|
59
|
+
presenceType: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
|
|
70
60
|
isDeleted: z.boolean(),
|
|
71
61
|
friendFrequentScore: z.number().int(),
|
|
72
62
|
friendFrequentRank: z.number().int(),
|
|
@@ -79,28 +69,27 @@ const Roblox_Friends_Api_Models_Response_UserResponse = z.object({
|
|
|
79
69
|
name: z.string(),
|
|
80
70
|
displayName: z.string(),
|
|
81
71
|
});
|
|
82
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_ =
|
|
83
|
-
z.
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
});
|
|
72
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_ = z.object({
|
|
73
|
+
previousPageCursor: z.string(),
|
|
74
|
+
nextPageCursor: z.string(),
|
|
75
|
+
data: z.array(Roblox_Friends_Api_Models_Response_UserResponse),
|
|
76
|
+
});
|
|
88
77
|
const Roblox_Friends_Api_FollowCountResponse = z.object({
|
|
89
78
|
count: z.number().int(),
|
|
90
79
|
});
|
|
91
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_ =
|
|
92
|
-
|
|
80
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_ = z.object({
|
|
81
|
+
data: z.array(Roblox_Friends_Api_Models_Response_UserResponse),
|
|
82
|
+
});
|
|
93
83
|
const Roblox_Friends_Api_Models_Response_FriendResponse = z.object({
|
|
94
84
|
id: z.number().int(),
|
|
95
85
|
hasVerifiedBadge: z.boolean(),
|
|
96
86
|
});
|
|
97
|
-
const Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_ =
|
|
98
|
-
z.
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
});
|
|
87
|
+
const Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_ = z.object({
|
|
88
|
+
PreviousCursor: z.string(),
|
|
89
|
+
PageItems: z.array(Roblox_Friends_Api_Models_Response_FriendResponse),
|
|
90
|
+
NextCursor: z.string(),
|
|
91
|
+
HasMore: z.boolean(),
|
|
92
|
+
});
|
|
104
93
|
const Roblox_Friends_Api_Models_Response_UserPresenceResponseModel = z.object({
|
|
105
94
|
UserPresenceType: z.string(),
|
|
106
95
|
UserLocationType: z.string(),
|
|
@@ -118,16 +107,16 @@ const Roblox_Friends_Api_Models_Response_UserPresenceResponse = z.object({
|
|
|
118
107
|
name: z.string(),
|
|
119
108
|
displayName: z.string(),
|
|
120
109
|
});
|
|
121
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserPresenceResponse_ =
|
|
122
|
-
z.
|
|
123
|
-
|
|
124
|
-
});
|
|
110
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserPresenceResponse_ = z.object({
|
|
111
|
+
data: z.array(Roblox_Friends_Api_Models_Response_UserPresenceResponse),
|
|
112
|
+
});
|
|
125
113
|
const Roblox_Friends_Api_FriendStatusResponse = z.object({
|
|
126
114
|
id: z.number().int(),
|
|
127
|
-
status: z.enum([
|
|
115
|
+
status: z.enum(['NotFriends', 'Friends', 'RequestSent', 'RequestReceived']),
|
|
116
|
+
});
|
|
117
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_FriendStatusResponse_ = z.object({
|
|
118
|
+
data: z.array(Roblox_Friends_Api_FriendStatusResponse),
|
|
128
119
|
});
|
|
129
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_FriendStatusResponse_ =
|
|
130
|
-
z.object({ data: z.array(Roblox_Friends_Api_FriendStatusResponse) });
|
|
131
120
|
const Roblox_Friends_Api_Models_Response_RefreshQrSessionResponse = z.object({
|
|
132
121
|
Success: z.boolean(),
|
|
133
122
|
});
|
|
@@ -145,12 +134,9 @@ const Roblox_Friends_Api_Models_Response_FollowingExistsResponse = z.object({
|
|
|
145
134
|
isFollowed: z.boolean(),
|
|
146
135
|
userId: z.number().int(),
|
|
147
136
|
});
|
|
148
|
-
const Roblox_Friends_Api_Models_Response_FollowingExistsResponseModel =
|
|
149
|
-
z.
|
|
150
|
-
|
|
151
|
-
Roblox_Friends_Api_Models_Response_FollowingExistsResponse
|
|
152
|
-
),
|
|
153
|
-
});
|
|
137
|
+
const Roblox_Friends_Api_Models_Response_FollowingExistsResponseModel = z.object({
|
|
138
|
+
followings: z.array(Roblox_Friends_Api_Models_Response_FollowingExistsResponse),
|
|
139
|
+
});
|
|
154
140
|
const Roblox_Web_Captcha_Models_Request_CaptchaTokenRequest = z.object({
|
|
155
141
|
captchaId: z.string(),
|
|
156
142
|
captchaToken: z.string(),
|
|
@@ -168,13 +154,13 @@ const Roblox_Web_WebAPI_ApiEmptyResponseModel = z.object({});
|
|
|
168
154
|
* @param targetUserId
|
|
169
155
|
*/
|
|
170
156
|
export const getMetadata = endpoint({
|
|
171
|
-
method:
|
|
172
|
-
path:
|
|
173
|
-
baseUrl:
|
|
174
|
-
requestFormat:
|
|
157
|
+
method: 'GET',
|
|
158
|
+
path: '/v1/metadata',
|
|
159
|
+
baseUrl: 'https://friends.roblox.com',
|
|
160
|
+
requestFormat: 'json',
|
|
175
161
|
serializationMethod: {
|
|
176
162
|
targetUserId: {
|
|
177
|
-
style:
|
|
163
|
+
style: 'form',
|
|
178
164
|
explode: true,
|
|
179
165
|
},
|
|
180
166
|
},
|
|
@@ -189,13 +175,13 @@ export const getMetadata = endpoint({
|
|
|
189
175
|
* @param userId user Id that shows the qr code
|
|
190
176
|
*/
|
|
191
177
|
export const getMyFriendsUseridCheckQrSession = endpoint({
|
|
192
|
-
method:
|
|
193
|
-
path:
|
|
194
|
-
baseUrl:
|
|
195
|
-
requestFormat:
|
|
178
|
+
method: 'GET',
|
|
179
|
+
path: '/v1/my/friends/:userId/check-qr-session',
|
|
180
|
+
baseUrl: 'https://friends.roblox.com',
|
|
181
|
+
requestFormat: 'json',
|
|
196
182
|
serializationMethod: {
|
|
197
183
|
userId: {
|
|
198
|
-
style:
|
|
184
|
+
style: 'simple',
|
|
199
185
|
},
|
|
200
186
|
},
|
|
201
187
|
parameters: {
|
|
@@ -214,10 +200,10 @@ export const getMyFriendsUseridCheckQrSession = endpoint({
|
|
|
214
200
|
* @summary Get the number of friends a user has
|
|
215
201
|
*/
|
|
216
202
|
export const getMyFriendsCount = endpoint({
|
|
217
|
-
method:
|
|
218
|
-
path:
|
|
219
|
-
baseUrl:
|
|
220
|
-
requestFormat:
|
|
203
|
+
method: 'GET',
|
|
204
|
+
path: '/v1/my/friends/count',
|
|
205
|
+
baseUrl: 'https://friends.roblox.com',
|
|
206
|
+
requestFormat: 'json',
|
|
221
207
|
response: z.object({ count: z.number().int() }),
|
|
222
208
|
errors: [
|
|
223
209
|
{
|
|
@@ -230,10 +216,10 @@ export const getMyFriendsCount = endpoint({
|
|
|
230
216
|
* @api POST https://friends.roblox.com/v1/my/friends/refresh-qr-session
|
|
231
217
|
*/
|
|
232
218
|
export const postMyFriendsRefreshQrSession = endpoint({
|
|
233
|
-
method:
|
|
234
|
-
path:
|
|
235
|
-
baseUrl:
|
|
236
|
-
requestFormat:
|
|
219
|
+
method: 'POST',
|
|
220
|
+
path: '/v1/my/friends/refresh-qr-session',
|
|
221
|
+
baseUrl: 'https://friends.roblox.com',
|
|
222
|
+
requestFormat: 'json',
|
|
237
223
|
response: z.object({ Success: z.boolean() }),
|
|
238
224
|
errors: [
|
|
239
225
|
{
|
|
@@ -255,25 +241,25 @@ export const postMyFriendsRefreshQrSession = endpoint({
|
|
|
255
241
|
* @param friendRequestSort
|
|
256
242
|
*/
|
|
257
243
|
export const getMyFriendsRequests = endpoint({
|
|
258
|
-
method:
|
|
259
|
-
path:
|
|
260
|
-
baseUrl:
|
|
261
|
-
requestFormat:
|
|
244
|
+
method: 'GET',
|
|
245
|
+
path: '/v1/my/friends/requests',
|
|
246
|
+
baseUrl: 'https://friends.roblox.com',
|
|
247
|
+
requestFormat: 'json',
|
|
262
248
|
serializationMethod: {
|
|
263
249
|
limit: {
|
|
264
|
-
style:
|
|
250
|
+
style: 'form',
|
|
265
251
|
explode: true,
|
|
266
252
|
},
|
|
267
253
|
cursor: {
|
|
268
|
-
style:
|
|
254
|
+
style: 'form',
|
|
269
255
|
explode: true,
|
|
270
256
|
},
|
|
271
257
|
sessionId: {
|
|
272
|
-
style:
|
|
258
|
+
style: 'form',
|
|
273
259
|
explode: true,
|
|
274
260
|
},
|
|
275
261
|
friendRequestSort: {
|
|
276
|
-
style:
|
|
262
|
+
style: 'form',
|
|
277
263
|
explode: true,
|
|
278
264
|
},
|
|
279
265
|
},
|
|
@@ -286,8 +272,7 @@ export const getMyFriendsRequests = endpoint({
|
|
|
286
272
|
.optional()
|
|
287
273
|
.default(1),
|
|
288
274
|
},
|
|
289
|
-
response:
|
|
290
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_FriendRequestResponse_,
|
|
275
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_FriendRequestResponse_,
|
|
291
276
|
errors: [
|
|
292
277
|
{
|
|
293
278
|
status: 400,
|
|
@@ -313,10 +298,10 @@ export const getMyFriendsRequests = endpoint({
|
|
|
313
298
|
* @api GET https://friends.roblox.com/v1/my/new-friend-requests/count
|
|
314
299
|
*/
|
|
315
300
|
export const getMyNewFriendRequestsCount = endpoint({
|
|
316
|
-
method:
|
|
317
|
-
path:
|
|
318
|
-
baseUrl:
|
|
319
|
-
requestFormat:
|
|
301
|
+
method: 'GET',
|
|
302
|
+
path: '/v1/my/new-friend-requests/count',
|
|
303
|
+
baseUrl: 'https://friends.roblox.com',
|
|
304
|
+
requestFormat: 'json',
|
|
320
305
|
response: z.object({ count: z.number().int() }),
|
|
321
306
|
errors: [
|
|
322
307
|
{
|
|
@@ -330,10 +315,10 @@ export const getMyNewFriendRequestsCount = endpoint({
|
|
|
330
315
|
* @summary Get the number of trusted friends a user has
|
|
331
316
|
*/
|
|
332
317
|
export const getMyTrustedFriendsCount = endpoint({
|
|
333
|
-
method:
|
|
334
|
-
path:
|
|
335
|
-
baseUrl:
|
|
336
|
-
requestFormat:
|
|
318
|
+
method: 'GET',
|
|
319
|
+
path: '/v1/my/trusted-friends/count',
|
|
320
|
+
baseUrl: 'https://friends.roblox.com',
|
|
321
|
+
requestFormat: 'json',
|
|
337
322
|
response: z.object({ count: z.number().int() }),
|
|
338
323
|
errors: [
|
|
339
324
|
{
|
|
@@ -349,14 +334,14 @@ export const getMyTrustedFriendsCount = endpoint({
|
|
|
349
334
|
* @param userId The requesting userId.
|
|
350
335
|
*/
|
|
351
336
|
export const postUserUseridMultigetAreFriends = endpoint({
|
|
352
|
-
method:
|
|
353
|
-
path:
|
|
354
|
-
baseUrl:
|
|
355
|
-
requestFormat:
|
|
337
|
+
method: 'POST',
|
|
338
|
+
path: '/v1/user/:userId/multiget-are-friends',
|
|
339
|
+
baseUrl: 'https://friends.roblox.com',
|
|
340
|
+
requestFormat: 'json',
|
|
356
341
|
serializationMethod: {
|
|
357
342
|
body: {},
|
|
358
343
|
userId: {
|
|
359
|
-
style:
|
|
344
|
+
style: 'simple',
|
|
360
345
|
},
|
|
361
346
|
},
|
|
362
347
|
parameters: {
|
|
@@ -381,10 +366,10 @@ export const postUserUseridMultigetAreFriends = endpoint({
|
|
|
381
366
|
* @param body The userIds potentially being followed
|
|
382
367
|
*/
|
|
383
368
|
export const postUserFollowingExists = endpoint({
|
|
384
|
-
method:
|
|
385
|
-
path:
|
|
386
|
-
baseUrl:
|
|
387
|
-
requestFormat:
|
|
369
|
+
method: 'POST',
|
|
370
|
+
path: '/v1/user/following-exists',
|
|
371
|
+
baseUrl: 'https://friends.roblox.com',
|
|
372
|
+
requestFormat: 'json',
|
|
388
373
|
serializationMethod: {
|
|
389
374
|
body: {},
|
|
390
375
|
},
|
|
@@ -415,10 +400,10 @@ export const postUserFollowingExists = endpoint({
|
|
|
415
400
|
* @summary Return the number of pending friend requests.
|
|
416
401
|
*/
|
|
417
402
|
export const getUserFriendRequestsCount = endpoint({
|
|
418
|
-
method:
|
|
419
|
-
path:
|
|
420
|
-
baseUrl:
|
|
421
|
-
requestFormat:
|
|
403
|
+
method: 'GET',
|
|
404
|
+
path: '/v1/user/friend-requests/count',
|
|
405
|
+
baseUrl: 'https://friends.roblox.com',
|
|
406
|
+
requestFormat: 'json',
|
|
422
407
|
response: z.object({ count: z.number().int() }),
|
|
423
408
|
errors: [
|
|
424
409
|
{
|
|
@@ -434,14 +419,14 @@ export const getUserFriendRequestsCount = endpoint({
|
|
|
434
419
|
* @param targetUserId
|
|
435
420
|
*/
|
|
436
421
|
export const postUsersTargetuseridFollow = endpoint({
|
|
437
|
-
method:
|
|
438
|
-
path:
|
|
439
|
-
baseUrl:
|
|
440
|
-
requestFormat:
|
|
422
|
+
method: 'POST',
|
|
423
|
+
path: '/v1/users/:targetUserId/follow',
|
|
424
|
+
baseUrl: 'https://friends.roblox.com',
|
|
425
|
+
requestFormat: 'json',
|
|
441
426
|
serializationMethod: {
|
|
442
427
|
body: {},
|
|
443
428
|
targetUserId: {
|
|
444
|
-
style:
|
|
429
|
+
style: 'simple',
|
|
445
430
|
},
|
|
446
431
|
},
|
|
447
432
|
parameters: {
|
|
@@ -482,44 +467,37 @@ export const postUsersTargetuseridFollow = endpoint({
|
|
|
482
467
|
* @param sortOrder The order the results are sorted in.
|
|
483
468
|
*/
|
|
484
469
|
export const getUsersTargetuseridFollowers = endpoint({
|
|
485
|
-
method:
|
|
486
|
-
path:
|
|
487
|
-
baseUrl:
|
|
488
|
-
requestFormat:
|
|
470
|
+
method: 'GET',
|
|
471
|
+
path: '/v1/users/:targetUserId/followers',
|
|
472
|
+
baseUrl: 'https://friends.roblox.com',
|
|
473
|
+
requestFormat: 'json',
|
|
489
474
|
serializationMethod: {
|
|
490
475
|
targetUserId: {
|
|
491
|
-
style:
|
|
476
|
+
style: 'simple',
|
|
492
477
|
},
|
|
493
478
|
limit: {
|
|
494
|
-
style:
|
|
479
|
+
style: 'form',
|
|
495
480
|
explode: true,
|
|
496
481
|
},
|
|
497
482
|
cursor: {
|
|
498
|
-
style:
|
|
483
|
+
style: 'form',
|
|
499
484
|
explode: true,
|
|
500
485
|
},
|
|
501
486
|
sortOrder: {
|
|
502
|
-
style:
|
|
487
|
+
style: 'form',
|
|
503
488
|
explode: true,
|
|
504
489
|
},
|
|
505
490
|
},
|
|
506
491
|
parameters: {
|
|
507
492
|
targetUserId: z.number().int(),
|
|
508
493
|
limit: z
|
|
509
|
-
.union([
|
|
510
|
-
z.literal(10),
|
|
511
|
-
z.literal(18),
|
|
512
|
-
z.literal(25),
|
|
513
|
-
z.literal(50),
|
|
514
|
-
z.literal(100),
|
|
515
|
-
])
|
|
494
|
+
.union([z.literal(10), z.literal(18), z.literal(25), z.literal(50), z.literal(100)])
|
|
516
495
|
.optional()
|
|
517
496
|
.default(10),
|
|
518
497
|
cursor: z.string().optional(),
|
|
519
|
-
sortOrder: z.enum([
|
|
498
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
520
499
|
},
|
|
521
|
-
response:
|
|
522
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
500
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
523
501
|
errors: [
|
|
524
502
|
{
|
|
525
503
|
status: 400,
|
|
@@ -543,13 +521,13 @@ export const getUsersTargetuseridFollowers = endpoint({
|
|
|
543
521
|
* @param targetUserId
|
|
544
522
|
*/
|
|
545
523
|
export const getUsersTargetuseridFollowersCount = endpoint({
|
|
546
|
-
method:
|
|
547
|
-
path:
|
|
548
|
-
baseUrl:
|
|
549
|
-
requestFormat:
|
|
524
|
+
method: 'GET',
|
|
525
|
+
path: '/v1/users/:targetUserId/followers/count',
|
|
526
|
+
baseUrl: 'https://friends.roblox.com',
|
|
527
|
+
requestFormat: 'json',
|
|
550
528
|
serializationMethod: {
|
|
551
529
|
targetUserId: {
|
|
552
|
-
style:
|
|
530
|
+
style: 'simple',
|
|
553
531
|
},
|
|
554
532
|
},
|
|
555
533
|
parameters: {
|
|
@@ -572,44 +550,37 @@ export const getUsersTargetuseridFollowersCount = endpoint({
|
|
|
572
550
|
* @param sortOrder The order the results are sorted in.
|
|
573
551
|
*/
|
|
574
552
|
export const getUsersTargetuseridFollowings = endpoint({
|
|
575
|
-
method:
|
|
576
|
-
path:
|
|
577
|
-
baseUrl:
|
|
578
|
-
requestFormat:
|
|
553
|
+
method: 'GET',
|
|
554
|
+
path: '/v1/users/:targetUserId/followings',
|
|
555
|
+
baseUrl: 'https://friends.roblox.com',
|
|
556
|
+
requestFormat: 'json',
|
|
579
557
|
serializationMethod: {
|
|
580
558
|
targetUserId: {
|
|
581
|
-
style:
|
|
559
|
+
style: 'simple',
|
|
582
560
|
},
|
|
583
561
|
limit: {
|
|
584
|
-
style:
|
|
562
|
+
style: 'form',
|
|
585
563
|
explode: true,
|
|
586
564
|
},
|
|
587
565
|
cursor: {
|
|
588
|
-
style:
|
|
566
|
+
style: 'form',
|
|
589
567
|
explode: true,
|
|
590
568
|
},
|
|
591
569
|
sortOrder: {
|
|
592
|
-
style:
|
|
570
|
+
style: 'form',
|
|
593
571
|
explode: true,
|
|
594
572
|
},
|
|
595
573
|
},
|
|
596
574
|
parameters: {
|
|
597
575
|
targetUserId: z.number().int(),
|
|
598
576
|
limit: z
|
|
599
|
-
.union([
|
|
600
|
-
z.literal(10),
|
|
601
|
-
z.literal(18),
|
|
602
|
-
z.literal(25),
|
|
603
|
-
z.literal(50),
|
|
604
|
-
z.literal(100),
|
|
605
|
-
])
|
|
577
|
+
.union([z.literal(10), z.literal(18), z.literal(25), z.literal(50), z.literal(100)])
|
|
606
578
|
.optional()
|
|
607
579
|
.default(10),
|
|
608
580
|
cursor: z.string().optional(),
|
|
609
|
-
sortOrder: z.enum([
|
|
581
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
610
582
|
},
|
|
611
|
-
response:
|
|
612
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
583
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
613
584
|
errors: [
|
|
614
585
|
{
|
|
615
586
|
status: 400,
|
|
@@ -633,13 +604,13 @@ export const getUsersTargetuseridFollowings = endpoint({
|
|
|
633
604
|
* @param targetUserId
|
|
634
605
|
*/
|
|
635
606
|
export const getUsersTargetuseridFollowingsCount = endpoint({
|
|
636
|
-
method:
|
|
637
|
-
path:
|
|
638
|
-
baseUrl:
|
|
639
|
-
requestFormat:
|
|
607
|
+
method: 'GET',
|
|
608
|
+
path: '/v1/users/:targetUserId/followings/count',
|
|
609
|
+
baseUrl: 'https://friends.roblox.com',
|
|
610
|
+
requestFormat: 'json',
|
|
640
611
|
serializationMethod: {
|
|
641
612
|
targetUserId: {
|
|
642
|
-
style:
|
|
613
|
+
style: 'simple',
|
|
643
614
|
},
|
|
644
615
|
},
|
|
645
616
|
parameters: {
|
|
@@ -659,13 +630,13 @@ export const getUsersTargetuseridFollowingsCount = endpoint({
|
|
|
659
630
|
* @param targetUserId
|
|
660
631
|
*/
|
|
661
632
|
export const postUsersTargetuseridUnfollow = endpoint({
|
|
662
|
-
method:
|
|
663
|
-
path:
|
|
664
|
-
baseUrl:
|
|
665
|
-
requestFormat:
|
|
633
|
+
method: 'POST',
|
|
634
|
+
path: '/v1/users/:targetUserId/unfollow',
|
|
635
|
+
baseUrl: 'https://friends.roblox.com',
|
|
636
|
+
requestFormat: 'json',
|
|
666
637
|
serializationMethod: {
|
|
667
638
|
targetUserId: {
|
|
668
|
-
style:
|
|
639
|
+
style: 'simple',
|
|
669
640
|
},
|
|
670
641
|
},
|
|
671
642
|
parameters: {
|
|
@@ -703,16 +674,16 @@ export const postUsersTargetuseridUnfollow = endpoint({
|
|
|
703
674
|
* @param userSort Specifies how to sort the returned friends.
|
|
704
675
|
*/
|
|
705
676
|
export const getUsersUseridFriends = endpoint({
|
|
706
|
-
method:
|
|
707
|
-
path:
|
|
708
|
-
baseUrl:
|
|
709
|
-
requestFormat:
|
|
677
|
+
method: 'GET',
|
|
678
|
+
path: '/v1/users/:userId/friends',
|
|
679
|
+
baseUrl: 'https://friends.roblox.com',
|
|
680
|
+
requestFormat: 'json',
|
|
710
681
|
serializationMethod: {
|
|
711
682
|
userId: {
|
|
712
|
-
style:
|
|
683
|
+
style: 'simple',
|
|
713
684
|
},
|
|
714
685
|
userSort: {
|
|
715
|
-
style:
|
|
686
|
+
style: 'form',
|
|
716
687
|
explode: true,
|
|
717
688
|
},
|
|
718
689
|
},
|
|
@@ -720,8 +691,7 @@ export const getUsersUseridFriends = endpoint({
|
|
|
720
691
|
userId: z.number().int(),
|
|
721
692
|
userSort: z.union([z.literal(0), z.literal(1), z.literal(2)]).optional(),
|
|
722
693
|
},
|
|
723
|
-
response:
|
|
724
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
694
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
725
695
|
errors: [
|
|
726
696
|
{
|
|
727
697
|
status: 400,
|
|
@@ -735,13 +705,13 @@ export const getUsersUseridFriends = endpoint({
|
|
|
735
705
|
* @param userId
|
|
736
706
|
*/
|
|
737
707
|
export const getUsersUseridFriendsCount = endpoint({
|
|
738
|
-
method:
|
|
739
|
-
path:
|
|
740
|
-
baseUrl:
|
|
741
|
-
requestFormat:
|
|
708
|
+
method: 'GET',
|
|
709
|
+
path: '/v1/users/:userId/friends/count',
|
|
710
|
+
baseUrl: 'https://friends.roblox.com',
|
|
711
|
+
requestFormat: 'json',
|
|
742
712
|
serializationMethod: {
|
|
743
713
|
userId: {
|
|
744
|
-
style:
|
|
714
|
+
style: 'simple',
|
|
745
715
|
},
|
|
746
716
|
},
|
|
747
717
|
parameters: {
|
|
@@ -765,28 +735,28 @@ export const getUsersUseridFriendsCount = endpoint({
|
|
|
765
735
|
* @param findFriendsType
|
|
766
736
|
*/
|
|
767
737
|
export const getUsersUseridFriendsFind = endpoint({
|
|
768
|
-
method:
|
|
769
|
-
path:
|
|
770
|
-
baseUrl:
|
|
771
|
-
requestFormat:
|
|
738
|
+
method: 'GET',
|
|
739
|
+
path: '/v1/users/:userId/friends/find',
|
|
740
|
+
baseUrl: 'https://friends.roblox.com',
|
|
741
|
+
requestFormat: 'json',
|
|
772
742
|
serializationMethod: {
|
|
773
743
|
userId: {
|
|
774
|
-
style:
|
|
744
|
+
style: 'simple',
|
|
775
745
|
},
|
|
776
746
|
userSort: {
|
|
777
|
-
style:
|
|
747
|
+
style: 'form',
|
|
778
748
|
explode: true,
|
|
779
749
|
},
|
|
780
750
|
cursor: {
|
|
781
|
-
style:
|
|
751
|
+
style: 'form',
|
|
782
752
|
explode: true,
|
|
783
753
|
},
|
|
784
754
|
limit: {
|
|
785
|
-
style:
|
|
755
|
+
style: 'form',
|
|
786
756
|
explode: true,
|
|
787
757
|
},
|
|
788
758
|
findFriendsType: {
|
|
789
|
-
style:
|
|
759
|
+
style: 'form',
|
|
790
760
|
explode: true,
|
|
791
761
|
},
|
|
792
762
|
},
|
|
@@ -800,8 +770,7 @@ export const getUsersUseridFriendsFind = endpoint({
|
|
|
800
770
|
limit: z.number().int().optional().default(50),
|
|
801
771
|
findFriendsType: z.union([z.literal(0), z.literal(1)]).optional(),
|
|
802
772
|
},
|
|
803
|
-
response:
|
|
804
|
-
Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_,
|
|
773
|
+
response: Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_,
|
|
805
774
|
errors: [
|
|
806
775
|
{
|
|
807
776
|
status: 400,
|
|
@@ -816,20 +785,19 @@ export const getUsersUseridFriendsFind = endpoint({
|
|
|
816
785
|
* @param userId The user Id to get the friends for.
|
|
817
786
|
*/
|
|
818
787
|
export const getUsersUseridFriendsInactive = endpoint({
|
|
819
|
-
method:
|
|
820
|
-
path:
|
|
821
|
-
baseUrl:
|
|
822
|
-
requestFormat:
|
|
788
|
+
method: 'GET',
|
|
789
|
+
path: '/v1/users/:userId/friends/inactive',
|
|
790
|
+
baseUrl: 'https://friends.roblox.com',
|
|
791
|
+
requestFormat: 'json',
|
|
823
792
|
serializationMethod: {
|
|
824
793
|
userId: {
|
|
825
|
-
style:
|
|
794
|
+
style: 'simple',
|
|
826
795
|
},
|
|
827
796
|
},
|
|
828
797
|
parameters: {
|
|
829
798
|
userId: z.number().int(),
|
|
830
799
|
},
|
|
831
|
-
response:
|
|
832
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
800
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserResponse_,
|
|
833
801
|
errors: [
|
|
834
802
|
{
|
|
835
803
|
status: 400,
|
|
@@ -849,16 +817,16 @@ export const getUsersUseridFriendsInactive = endpoint({
|
|
|
849
817
|
* @param userSort The sort order to return the friends.
|
|
850
818
|
*/
|
|
851
819
|
export const getUsersUseridFriendsOnline = endpoint({
|
|
852
|
-
method:
|
|
853
|
-
path:
|
|
854
|
-
baseUrl:
|
|
855
|
-
requestFormat:
|
|
820
|
+
method: 'GET',
|
|
821
|
+
path: '/v1/users/:userId/friends/online',
|
|
822
|
+
baseUrl: 'https://friends.roblox.com',
|
|
823
|
+
requestFormat: 'json',
|
|
856
824
|
serializationMethod: {
|
|
857
825
|
userId: {
|
|
858
|
-
style:
|
|
826
|
+
style: 'simple',
|
|
859
827
|
},
|
|
860
828
|
userSort: {
|
|
861
|
-
style:
|
|
829
|
+
style: 'form',
|
|
862
830
|
explode: true,
|
|
863
831
|
},
|
|
864
832
|
},
|
|
@@ -866,8 +834,7 @@ export const getUsersUseridFriendsOnline = endpoint({
|
|
|
866
834
|
userId: z.number().int(),
|
|
867
835
|
userSort: z.union([z.literal(0), z.literal(1), z.literal(2)]).optional(),
|
|
868
836
|
},
|
|
869
|
-
response:
|
|
870
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserPresenceResponse_,
|
|
837
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_Models_Response_UserPresenceResponse_,
|
|
871
838
|
errors: [
|
|
872
839
|
{
|
|
873
840
|
status: 400,
|
|
@@ -889,24 +856,24 @@ export const getUsersUseridFriendsOnline = endpoint({
|
|
|
889
856
|
* @param limit The number of results per request.
|
|
890
857
|
*/
|
|
891
858
|
export const getUsersUseridFriendsSearch = endpoint({
|
|
892
|
-
method:
|
|
893
|
-
path:
|
|
894
|
-
baseUrl:
|
|
895
|
-
requestFormat:
|
|
859
|
+
method: 'GET',
|
|
860
|
+
path: '/v1/users/:userId/friends/search',
|
|
861
|
+
baseUrl: 'https://friends.roblox.com',
|
|
862
|
+
requestFormat: 'json',
|
|
896
863
|
serializationMethod: {
|
|
897
864
|
userId: {
|
|
898
|
-
style:
|
|
865
|
+
style: 'simple',
|
|
899
866
|
},
|
|
900
867
|
query: {
|
|
901
|
-
style:
|
|
868
|
+
style: 'form',
|
|
902
869
|
explode: true,
|
|
903
870
|
},
|
|
904
871
|
cursor: {
|
|
905
|
-
style:
|
|
872
|
+
style: 'form',
|
|
906
873
|
explode: true,
|
|
907
874
|
},
|
|
908
875
|
limit: {
|
|
909
|
-
style:
|
|
876
|
+
style: 'form',
|
|
910
877
|
explode: true,
|
|
911
878
|
},
|
|
912
879
|
},
|
|
@@ -916,8 +883,7 @@ export const getUsersUseridFriendsSearch = endpoint({
|
|
|
916
883
|
cursor: z.string().optional(),
|
|
917
884
|
limit: z.number().int().optional().default(20),
|
|
918
885
|
},
|
|
919
|
-
response:
|
|
920
|
-
Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_,
|
|
886
|
+
response: Roblox_Paging_CursoredPagedResult_Roblox_Friends_Api_Models_Response_FriendResponse_,
|
|
921
887
|
errors: [
|
|
922
888
|
{
|
|
923
889
|
status: 400,
|
|
@@ -937,24 +903,23 @@ export const getUsersUseridFriendsSearch = endpoint({
|
|
|
937
903
|
* @param userIds
|
|
938
904
|
*/
|
|
939
905
|
export const getUsersUseridFriendsStatuses = endpoint({
|
|
940
|
-
method:
|
|
941
|
-
path:
|
|
942
|
-
baseUrl:
|
|
943
|
-
requestFormat:
|
|
906
|
+
method: 'GET',
|
|
907
|
+
path: '/v1/users/:userId/friends/statuses',
|
|
908
|
+
baseUrl: 'https://friends.roblox.com',
|
|
909
|
+
requestFormat: 'json',
|
|
944
910
|
serializationMethod: {
|
|
945
911
|
userId: {
|
|
946
|
-
style:
|
|
912
|
+
style: 'simple',
|
|
947
913
|
},
|
|
948
914
|
userIds: {
|
|
949
|
-
style:
|
|
915
|
+
style: 'form',
|
|
950
916
|
},
|
|
951
917
|
},
|
|
952
918
|
parameters: {
|
|
953
919
|
userId: z.number().int(),
|
|
954
920
|
userIds: z.array(z.number()),
|
|
955
921
|
},
|
|
956
|
-
response:
|
|
957
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_FriendStatusResponse_,
|
|
922
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_FriendStatusResponse_,
|
|
958
923
|
errors: [
|
|
959
924
|
{
|
|
960
925
|
status: 400,
|
|
@@ -970,13 +935,13 @@ export const getUsersUseridFriendsStatuses = endpoint({
|
|
|
970
935
|
* @param userId
|
|
971
936
|
*/
|
|
972
937
|
export const getUsersUseridTrustedFriendsCount = endpoint({
|
|
973
|
-
method:
|
|
974
|
-
path:
|
|
975
|
-
baseUrl:
|
|
976
|
-
requestFormat:
|
|
938
|
+
method: 'GET',
|
|
939
|
+
path: '/v1/users/:userId/trusted-friends/count',
|
|
940
|
+
baseUrl: 'https://friends.roblox.com',
|
|
941
|
+
requestFormat: 'json',
|
|
977
942
|
serializationMethod: {
|
|
978
943
|
userId: {
|
|
979
|
-
style:
|
|
944
|
+
style: 'simple',
|
|
980
945
|
},
|
|
981
946
|
},
|
|
982
947
|
parameters: {
|
|
@@ -1028,9 +993,7 @@ export const getUserUseridMultigetAreTrustedFriends = endpoint({
|
|
|
1028
993
|
userIds: z.array(z.number()),
|
|
1029
994
|
},
|
|
1030
995
|
response: Patch_MultigetAreTrustedFriendsResponse,
|
|
1031
|
-
errors: [
|
|
1032
|
-
{ status: 400, description: `1: The target user is invalid or does not exist.` },
|
|
1033
|
-
],
|
|
996
|
+
errors: [{ status: 400, description: `1: The target user is invalid or does not exist.` }],
|
|
1034
997
|
});
|
|
1035
998
|
|
|
1036
999
|
// Friend-management write endpoints Roblox removed from its published API docs but
|