rozod 6.7.1 → 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/LICENSE +1 -1
- package/README.md +75 -451
- 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 +267 -230
- package/lib/endpoints/assetdeliveryv1.js +38 -0
- package/lib/endpoints/assetdeliveryv2.d.ts +201 -176
- package/lib/endpoints/assetdeliveryv2.js +26 -0
- package/lib/endpoints/authv1.d.ts +480 -517
- package/lib/endpoints/authv1.js +3 -1
- package/lib/endpoints/authv2.d.ts +210 -222
- package/lib/endpoints/authv2.js +1 -1
- 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 +96 -99
- package/lib/endpoints/badgesv1.js +4 -0
- package/lib/endpoints/catalogv1.d.ts +209 -234
- package/lib/endpoints/catalogv1.js +2 -1
- package/lib/endpoints/catalogv2.d.ts +106 -136
- package/lib/endpoints/catalogv2.js +21 -17
- package/lib/endpoints/chatv2.d.ts +778 -778
- 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 +233 -293
- package/lib/endpoints/developv1.js +3 -0
- package/lib/endpoints/developv2.d.ts +87 -138
- package/lib/endpoints/developv2.js +3 -1
- 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 +416 -545
- package/lib/endpoints/friendsv1.js +213 -313
- package/lib/endpoints/gameinternationalizationv1.d.ts +1509 -1642
- package/lib/endpoints/gameinternationalizationv2.d.ts +62 -64
- package/lib/endpoints/gamejoinv1.d.ts +458 -458
- package/lib/endpoints/gamesv1.d.ts +183 -143
- package/lib/endpoints/gamesv1.js +2 -0
- package/lib/endpoints/gamesv2.d.ts +161 -158
- package/lib/endpoints/gamesv2.js +9 -0
- package/lib/endpoints/groupsv1.d.ts +967 -976
- package/lib/endpoints/groupsv1.js +48 -4
- package/lib/endpoints/groupsv2.d.ts +259 -277
- package/lib/endpoints/groupsv2.js +1 -0
- package/lib/endpoints/inventoryv1.d.ts +93 -122
- package/lib/endpoints/inventoryv1.js +3 -1
- package/lib/endpoints/inventoryv2.d.ts +163 -178
- package/lib/endpoints/inventoryv2.js +2 -0
- 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/metricsv1.d.ts +88 -88
- 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 +317 -361
- package/lib/endpoints/thumbnailsv1.js +25 -0
- 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 +152 -4
- package/lib/index.js +273 -4
- package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
- package/lib/opencloud/v1/assets.d.ts +9 -9
- package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
- package/lib/opencloud/v1/datastores.d.ts +8 -8
- package/lib/opencloud/v1/developer-products.d.ts +4 -4
- package/lib/opencloud/v1/game-passes.d.ts +4 -4
- package/lib/opencloud/v1/messaging.d.ts +1 -1
- package/lib/opencloud/v1/open-eval.d.ts +2 -2
- package/lib/opencloud/v1/secrets-store.d.ts +5 -5
- package/lib/opencloud/v1/toolbox.d.ts +2 -2
- package/lib/opencloud/v1/universes.d.ts +1 -1
- package/lib/opencloud/v2/cloud.d.ts +172 -84
- package/lib/opencloud/v2/cloud.js +25 -9
- package/package.json +2 -2
|
@@ -1,144 +1,137 @@
|
|
|
1
|
-
import { z } from
|
|
2
|
-
import { endpoint } from
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { endpoint } from '..';
|
|
3
3
|
|
|
4
|
-
const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Web_Responses_Groups_GroupOwnerType_ =
|
|
5
|
-
|
|
4
|
+
const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Web_Responses_Groups_GroupOwnerType_ = z.object({
|
|
5
|
+
id: z.number().int(),
|
|
6
|
+
type: z.literal('User'),
|
|
7
|
+
name: z.string(),
|
|
8
|
+
});
|
|
6
9
|
const Roblox_Web_Responses_Groups_GroupResponseV2 = z.object({
|
|
7
10
|
id: z.number().int(),
|
|
8
11
|
name: z.string(),
|
|
9
12
|
description: z.string(),
|
|
10
|
-
owner:
|
|
11
|
-
Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Web_Responses_Groups_GroupOwnerType_,
|
|
13
|
+
owner: Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Web_Responses_Groups_GroupOwnerType_,
|
|
12
14
|
memberCount: z.number().int(),
|
|
13
15
|
created: z.string().datetime({ offset: true }),
|
|
14
16
|
hasVerifiedBadge: z.boolean(),
|
|
15
17
|
});
|
|
16
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Groups_GroupResponseV2_ =
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Assets_AssetType_ =
|
|
25
|
-
z.
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
18
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Groups_GroupResponseV2_ = z.object({
|
|
19
|
+
data: z.array(Roblox_Web_Responses_Groups_GroupResponseV2),
|
|
20
|
+
});
|
|
21
|
+
const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Core_CreatorType_ = z.object({
|
|
22
|
+
id: z.number().int(),
|
|
23
|
+
type: z.enum(['User', 'Group']),
|
|
24
|
+
name: z.string(),
|
|
25
|
+
});
|
|
26
|
+
const Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Assets_AssetType_ = z.object({
|
|
27
|
+
id: z.number().int(),
|
|
28
|
+
type: z.enum([
|
|
29
|
+
'Image',
|
|
30
|
+
'TShirt',
|
|
31
|
+
'Audio',
|
|
32
|
+
'Mesh',
|
|
33
|
+
'Lua',
|
|
34
|
+
'HTML',
|
|
35
|
+
'Text',
|
|
36
|
+
'Hat',
|
|
37
|
+
'Place',
|
|
38
|
+
'Model',
|
|
39
|
+
'Shirt',
|
|
40
|
+
'Pants',
|
|
41
|
+
'Decal',
|
|
42
|
+
'Avatar',
|
|
43
|
+
'Head',
|
|
44
|
+
'Face',
|
|
45
|
+
'Gear',
|
|
46
|
+
'Badge',
|
|
47
|
+
'GroupEmblem',
|
|
48
|
+
'Animation',
|
|
49
|
+
'Arms',
|
|
50
|
+
'Legs',
|
|
51
|
+
'Torso',
|
|
52
|
+
'RightArm',
|
|
53
|
+
'LeftArm',
|
|
54
|
+
'LeftLeg',
|
|
55
|
+
'RightLeg',
|
|
56
|
+
'Package',
|
|
57
|
+
'YouTubeVideo',
|
|
58
|
+
'GamePass',
|
|
59
|
+
'App',
|
|
60
|
+
'Code',
|
|
61
|
+
'Plugin',
|
|
62
|
+
'SolidModel',
|
|
63
|
+
'MeshPart',
|
|
64
|
+
'HairAccessory',
|
|
65
|
+
'FaceAccessory',
|
|
66
|
+
'NeckAccessory',
|
|
67
|
+
'ShoulderAccessory',
|
|
68
|
+
'FrontAccessory',
|
|
69
|
+
'BackAccessory',
|
|
70
|
+
'WaistAccessory',
|
|
71
|
+
'ClimbAnimation',
|
|
72
|
+
'DeathAnimation',
|
|
73
|
+
'FallAnimation',
|
|
74
|
+
'IdleAnimation',
|
|
75
|
+
'JumpAnimation',
|
|
76
|
+
'RunAnimation',
|
|
77
|
+
'SwimAnimation',
|
|
78
|
+
'WalkAnimation',
|
|
79
|
+
'PoseAnimation',
|
|
80
|
+
'LocalizationTableManifest',
|
|
81
|
+
'LocalizationTableTranslation',
|
|
82
|
+
'EmoteAnimation',
|
|
83
|
+
'Video',
|
|
84
|
+
'TexturePack',
|
|
85
|
+
'TShirtAccessory',
|
|
86
|
+
'ShirtAccessory',
|
|
87
|
+
'PantsAccessory',
|
|
88
|
+
'JacketAccessory',
|
|
89
|
+
'SweaterAccessory',
|
|
90
|
+
'ShortsAccessory',
|
|
91
|
+
'LeftShoeAccessory',
|
|
92
|
+
'RightShoeAccessory',
|
|
93
|
+
'DressSkirtAccessory',
|
|
94
|
+
'FontFamily',
|
|
95
|
+
'FontFace',
|
|
96
|
+
'MeshHiddenSurfaceRemoval',
|
|
97
|
+
'EyebrowAccessory',
|
|
98
|
+
'EyelashAccessory',
|
|
99
|
+
'MoodAnimation',
|
|
100
|
+
'DynamicHead',
|
|
101
|
+
'CodeSnippet',
|
|
102
|
+
'AdsVideo',
|
|
103
|
+
'OtaUpdate',
|
|
104
|
+
'Screenshot',
|
|
105
|
+
'RuntimePropertySet',
|
|
106
|
+
'StorePreviewVideo',
|
|
107
|
+
'GamePreviewVideo',
|
|
108
|
+
'CreatorExperienceConfig',
|
|
109
|
+
'FaceMakeup',
|
|
110
|
+
'LipMakeup',
|
|
111
|
+
'EyeMakeup',
|
|
112
|
+
'VoxelFragment',
|
|
113
|
+
'AvatarBackground',
|
|
114
|
+
'TextDocument',
|
|
115
|
+
]),
|
|
116
|
+
name: z.string(),
|
|
117
|
+
});
|
|
116
118
|
const Roblox_Groups_Api_Models_Response_GroupExperienceResponse = z.object({
|
|
117
119
|
id: z.number().int(),
|
|
118
120
|
name: z.string(),
|
|
119
121
|
description: z.string(),
|
|
120
|
-
creator:
|
|
121
|
-
|
|
122
|
-
rootPlace:
|
|
123
|
-
Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Assets_AssetType_,
|
|
122
|
+
creator: Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Core_CreatorType_,
|
|
123
|
+
rootPlace: Roblox_Web_Responses_RelatedEntityTypeResponse_Roblox_Platform_Assets_AssetType_,
|
|
124
124
|
created: z.string().datetime({ offset: true }),
|
|
125
125
|
updated: z.string().datetime({ offset: true }),
|
|
126
126
|
placeVisits: z.number().int(),
|
|
127
127
|
});
|
|
128
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_Models_Response_GroupExperienceResponse_ =
|
|
129
|
-
z.
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
});
|
|
128
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_Models_Response_GroupExperienceResponse_ = z.object({
|
|
129
|
+
previousPageCursor: z.string(),
|
|
130
|
+
nextPageCursor: z.string(),
|
|
131
|
+
data: z.array(Roblox_Groups_Api_Models_Response_GroupExperienceResponse),
|
|
132
|
+
});
|
|
134
133
|
const Roblox_Groups_Api_Models_Response_UserModel = z.object({
|
|
135
|
-
buildersClubMembershipType: z.union([
|
|
136
|
-
z.literal(0),
|
|
137
|
-
z.literal(1),
|
|
138
|
-
z.literal(2),
|
|
139
|
-
z.literal(3),
|
|
140
|
-
z.literal(4),
|
|
141
|
-
]),
|
|
134
|
+
buildersClubMembershipType: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
|
|
142
135
|
hasVerifiedBadge: z.boolean(),
|
|
143
136
|
userId: z.number().int(),
|
|
144
137
|
username: z.string(),
|
|
@@ -163,20 +156,16 @@ const Roblox_Groups_Api_GroupDetailResponse = z.object({
|
|
|
163
156
|
hasVerifiedBadge: z.boolean(),
|
|
164
157
|
hasSocialModules: z.boolean(),
|
|
165
158
|
});
|
|
166
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupDetailResponse_ =
|
|
167
|
-
z.
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
groupResponses:
|
|
177
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupDetailResponse_,
|
|
178
|
-
}
|
|
179
|
-
);
|
|
159
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupDetailResponse_ = z.object({
|
|
160
|
+
previousPageCursor: z.string(),
|
|
161
|
+
nextPageCursor: z.string(),
|
|
162
|
+
data: z.array(Roblox_Groups_Api_GroupDetailResponse),
|
|
163
|
+
});
|
|
164
|
+
const Roblox_Groups_Api_Models_Response_GroupRelationshipsV2Response = z.object({
|
|
165
|
+
groupId: z.number().int(),
|
|
166
|
+
relationshipType: z.enum(['Allies', 'Enemies']),
|
|
167
|
+
groupResponses: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupDetailResponse_,
|
|
168
|
+
});
|
|
180
169
|
const Roblox_Groups_Api_GroupRoleResponse = z.object({
|
|
181
170
|
id: z.number().int(),
|
|
182
171
|
name: z.string(),
|
|
@@ -185,23 +174,23 @@ const Roblox_Groups_Api_GroupRoleResponse = z.object({
|
|
|
185
174
|
memberCount: z.number().int(),
|
|
186
175
|
isBase: z.boolean(),
|
|
187
176
|
color: z.enum([
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
177
|
+
'Invalid',
|
|
178
|
+
'Blue',
|
|
179
|
+
'Green',
|
|
180
|
+
'Purple',
|
|
181
|
+
'Yellow',
|
|
182
|
+
'Orange',
|
|
183
|
+
'Red',
|
|
184
|
+
'Magenta',
|
|
185
|
+
'Teal',
|
|
186
|
+
'Turquoise',
|
|
187
|
+
'Rust',
|
|
188
|
+
'Pistachio',
|
|
189
|
+
'Midnight',
|
|
190
|
+
'Lavender',
|
|
191
|
+
'Pink',
|
|
192
|
+
'Crimson',
|
|
193
|
+
'Plum',
|
|
205
194
|
]),
|
|
206
195
|
});
|
|
207
196
|
const Roblox_Groups_Api_UserGroupRoleResponse = z.object({
|
|
@@ -215,12 +204,11 @@ const Roblox_Groups_Api_GroupWallPostV2Model = z.object({
|
|
|
215
204
|
created: z.string().datetime({ offset: true }),
|
|
216
205
|
updated: z.string().datetime({ offset: true }),
|
|
217
206
|
});
|
|
218
|
-
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupWallPostV2Model_ =
|
|
219
|
-
z.
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
});
|
|
207
|
+
const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupWallPostV2Model_ = z.object({
|
|
208
|
+
previousPageCursor: z.string(),
|
|
209
|
+
nextPageCursor: z.string(),
|
|
210
|
+
data: z.array(Roblox_Groups_Api_GroupWallPostV2Model),
|
|
211
|
+
});
|
|
224
212
|
const Roblox_Groups_Api_CreateWallPostRequest = z.object({
|
|
225
213
|
body: z.string(),
|
|
226
214
|
captchaId: z.string(),
|
|
@@ -241,11 +229,11 @@ const Roblox_Web_Responses_Groups_GroupRoleBasicResponse = z.object({
|
|
|
241
229
|
});
|
|
242
230
|
const Roblox_Groups_Api_GroupNotificationPreferenceData = z.object({
|
|
243
231
|
type: z.enum([
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
232
|
+
'AnnouncementCreatedNotification',
|
|
233
|
+
'ForumPostCreatedNotification',
|
|
234
|
+
'ForumCommentCreatedNotification',
|
|
235
|
+
'ForumCommentReplyCreatedNotification',
|
|
236
|
+
'ForumSubscriberNotification',
|
|
249
237
|
]),
|
|
250
238
|
enabled: z.boolean(),
|
|
251
239
|
name: z.string(),
|
|
@@ -255,12 +243,11 @@ const Roblox_Groups_Api_GroupMembershipResponse = z.object({
|
|
|
255
243
|
group: Roblox_Web_Responses_Groups_GroupBasicResponse,
|
|
256
244
|
role: Roblox_Web_Responses_Groups_GroupRoleBasicResponse,
|
|
257
245
|
isNotificationsEnabled: z.boolean(),
|
|
258
|
-
notificationPreferences: z.array(
|
|
259
|
-
|
|
260
|
-
|
|
246
|
+
notificationPreferences: z.array(Roblox_Groups_Api_GroupNotificationPreferenceData),
|
|
247
|
+
});
|
|
248
|
+
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_GroupMembershipResponse_ = z.object({
|
|
249
|
+
data: z.array(Roblox_Groups_Api_GroupMembershipResponse),
|
|
261
250
|
});
|
|
262
|
-
const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_GroupMembershipResponse_ =
|
|
263
|
-
z.object({ data: z.array(Roblox_Groups_Api_GroupMembershipResponse) });
|
|
264
251
|
|
|
265
252
|
/**
|
|
266
253
|
* @api GET https://groups.roblox.com/v2/groups
|
|
@@ -269,20 +256,19 @@ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_GroupMembershi
|
|
|
269
256
|
* @description If a group comes back as null, it will not be returned in the response.
|
|
270
257
|
*/
|
|
271
258
|
export const getGroups = endpoint({
|
|
272
|
-
method:
|
|
273
|
-
path:
|
|
274
|
-
baseUrl:
|
|
275
|
-
requestFormat:
|
|
259
|
+
method: 'GET',
|
|
260
|
+
path: '/v2/groups',
|
|
261
|
+
baseUrl: 'https://groups.roblox.com',
|
|
262
|
+
requestFormat: 'json',
|
|
276
263
|
serializationMethod: {
|
|
277
264
|
groupIds: {
|
|
278
|
-
style:
|
|
265
|
+
style: 'form',
|
|
279
266
|
},
|
|
280
267
|
},
|
|
281
268
|
parameters: {
|
|
282
269
|
groupIds: z.array(z.number()),
|
|
283
270
|
},
|
|
284
|
-
response:
|
|
285
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Groups_GroupResponseV2_,
|
|
271
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Groups_GroupResponseV2_,
|
|
286
272
|
errors: [
|
|
287
273
|
{
|
|
288
274
|
status: 400,
|
|
@@ -301,28 +287,28 @@ export const getGroups = endpoint({
|
|
|
301
287
|
* @param sortOrder The order the results are sorted in.
|
|
302
288
|
*/
|
|
303
289
|
export const getGroupsGroupidExperiences = endpoint({
|
|
304
|
-
method:
|
|
305
|
-
path:
|
|
306
|
-
baseUrl:
|
|
307
|
-
requestFormat:
|
|
290
|
+
method: 'GET',
|
|
291
|
+
path: '/v2/groups/:groupId/experiences',
|
|
292
|
+
baseUrl: 'https://groups.roblox.com',
|
|
293
|
+
requestFormat: 'json',
|
|
308
294
|
serializationMethod: {
|
|
309
295
|
groupId: {
|
|
310
|
-
style:
|
|
296
|
+
style: 'simple',
|
|
311
297
|
},
|
|
312
298
|
accessFilter: {
|
|
313
|
-
style:
|
|
299
|
+
style: 'form',
|
|
314
300
|
explode: true,
|
|
315
301
|
},
|
|
316
302
|
limit: {
|
|
317
|
-
style:
|
|
303
|
+
style: 'form',
|
|
318
304
|
explode: true,
|
|
319
305
|
},
|
|
320
306
|
cursor: {
|
|
321
|
-
style:
|
|
307
|
+
style: 'form',
|
|
322
308
|
explode: true,
|
|
323
309
|
},
|
|
324
310
|
sortOrder: {
|
|
325
|
-
style:
|
|
311
|
+
style: 'form',
|
|
326
312
|
explode: true,
|
|
327
313
|
},
|
|
328
314
|
},
|
|
@@ -337,10 +323,9 @@ export const getGroupsGroupidExperiences = endpoint({
|
|
|
337
323
|
.optional()
|
|
338
324
|
.default(10),
|
|
339
325
|
cursor: z.string().optional(),
|
|
340
|
-
sortOrder: z.enum([
|
|
326
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
341
327
|
},
|
|
342
|
-
response:
|
|
343
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_Models_Response_GroupExperienceResponse_,
|
|
328
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_Models_Response_GroupExperienceResponse_,
|
|
344
329
|
errors: [
|
|
345
330
|
{
|
|
346
331
|
status: 501,
|
|
@@ -358,27 +343,27 @@ export const getGroupsGroupidExperiences = endpoint({
|
|
|
358
343
|
* @param sortOrder The order the results are sorted in.
|
|
359
344
|
*/
|
|
360
345
|
export const getGroupsGroupidRelationshipsGrouprelationshiptype = endpoint({
|
|
361
|
-
method:
|
|
362
|
-
path:
|
|
363
|
-
baseUrl:
|
|
364
|
-
requestFormat:
|
|
346
|
+
method: 'GET',
|
|
347
|
+
path: '/v2/groups/:groupId/relationships/:groupRelationshipType',
|
|
348
|
+
baseUrl: 'https://groups.roblox.com',
|
|
349
|
+
requestFormat: 'json',
|
|
365
350
|
serializationMethod: {
|
|
366
351
|
groupId: {
|
|
367
|
-
style:
|
|
352
|
+
style: 'simple',
|
|
368
353
|
},
|
|
369
354
|
groupRelationshipType: {
|
|
370
|
-
style:
|
|
355
|
+
style: 'simple',
|
|
371
356
|
},
|
|
372
357
|
limit: {
|
|
373
|
-
style:
|
|
358
|
+
style: 'form',
|
|
374
359
|
explode: true,
|
|
375
360
|
},
|
|
376
361
|
cursor: {
|
|
377
|
-
style:
|
|
362
|
+
style: 'form',
|
|
378
363
|
explode: true,
|
|
379
364
|
},
|
|
380
365
|
sortOrder: {
|
|
381
|
-
style:
|
|
366
|
+
style: 'form',
|
|
382
367
|
explode: true,
|
|
383
368
|
},
|
|
384
369
|
},
|
|
@@ -390,7 +375,7 @@ export const getGroupsGroupidRelationshipsGrouprelationshiptype = endpoint({
|
|
|
390
375
|
.optional()
|
|
391
376
|
.default(10),
|
|
392
377
|
cursor: z.string().optional(),
|
|
393
|
-
sortOrder: z.enum([
|
|
378
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
394
379
|
},
|
|
395
380
|
response: Roblox_Groups_Api_Models_Response_GroupRelationshipsV2Response,
|
|
396
381
|
errors: [
|
|
@@ -411,60 +396,59 @@ export const getGroupsGroupidRelationshipsGrouprelationshiptype = endpoint({
|
|
|
411
396
|
* @param cursor The paging cursor for the previous or next page.
|
|
412
397
|
* @param sortOrder The order the results are sorted in.
|
|
413
398
|
*/
|
|
414
|
-
export const getGroupsGroupidRelationshipsGrouprelationshiptypeRequests =
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
description: `1: Group is invalid or does not exist.
|
|
399
|
+
export const getGroupsGroupidRelationshipsGrouprelationshiptypeRequests = endpoint({
|
|
400
|
+
method: 'GET',
|
|
401
|
+
path: '/v2/groups/:groupId/relationships/:groupRelationshipType/requests',
|
|
402
|
+
baseUrl: 'https://groups.roblox.com',
|
|
403
|
+
requestFormat: 'json',
|
|
404
|
+
serializationMethod: {
|
|
405
|
+
groupId: {
|
|
406
|
+
style: 'simple',
|
|
407
|
+
},
|
|
408
|
+
groupRelationshipType: {
|
|
409
|
+
style: 'simple',
|
|
410
|
+
},
|
|
411
|
+
limit: {
|
|
412
|
+
style: 'form',
|
|
413
|
+
explode: true,
|
|
414
|
+
},
|
|
415
|
+
cursor: {
|
|
416
|
+
style: 'form',
|
|
417
|
+
explode: true,
|
|
418
|
+
},
|
|
419
|
+
sortOrder: {
|
|
420
|
+
style: 'form',
|
|
421
|
+
explode: true,
|
|
422
|
+
},
|
|
423
|
+
},
|
|
424
|
+
parameters: {
|
|
425
|
+
groupId: z.number().int(),
|
|
426
|
+
groupRelationshipType: z.string(),
|
|
427
|
+
limit: z
|
|
428
|
+
.union([z.literal(10), z.literal(25), z.literal(50), z.literal(100)])
|
|
429
|
+
.optional()
|
|
430
|
+
.default(10),
|
|
431
|
+
cursor: z.string().optional(),
|
|
432
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
433
|
+
},
|
|
434
|
+
response: Roblox_Groups_Api_Models_Response_GroupRelationshipsV2Response,
|
|
435
|
+
errors: [
|
|
436
|
+
{
|
|
437
|
+
status: 400,
|
|
438
|
+
description: `1: Group is invalid or does not exist.
|
|
455
439
|
4: Group relationship type or request type is invalid.
|
|
456
440
|
8: Invalid or missing pagination parameters`,
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
status: 401,
|
|
444
|
+
description: `0: Authorization has been denied for this request.`,
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
status: 403,
|
|
448
|
+
description: `5: You don't have permission to manage this group's relationships.`,
|
|
449
|
+
},
|
|
450
|
+
],
|
|
451
|
+
});
|
|
468
452
|
/**
|
|
469
453
|
* @api GET https://groups.roblox.com/v2/groups/:groupId/wall/posts
|
|
470
454
|
* @summary Gets a list of group wall posts.
|
|
@@ -474,24 +458,24 @@ export const getGroupsGroupidRelationshipsGrouprelationshiptypeRequests =
|
|
|
474
458
|
* @param sortOrder Sorted by group wall post Id
|
|
475
459
|
*/
|
|
476
460
|
export const getGroupsGroupidWallPosts = endpoint({
|
|
477
|
-
method:
|
|
478
|
-
path:
|
|
479
|
-
baseUrl:
|
|
480
|
-
requestFormat:
|
|
461
|
+
method: 'GET',
|
|
462
|
+
path: '/v2/groups/:groupId/wall/posts',
|
|
463
|
+
baseUrl: 'https://groups.roblox.com',
|
|
464
|
+
requestFormat: 'json',
|
|
481
465
|
serializationMethod: {
|
|
482
466
|
groupId: {
|
|
483
|
-
style:
|
|
467
|
+
style: 'simple',
|
|
484
468
|
},
|
|
485
469
|
limit: {
|
|
486
|
-
style:
|
|
470
|
+
style: 'form',
|
|
487
471
|
explode: true,
|
|
488
472
|
},
|
|
489
473
|
cursor: {
|
|
490
|
-
style:
|
|
474
|
+
style: 'form',
|
|
491
475
|
explode: true,
|
|
492
476
|
},
|
|
493
477
|
sortOrder: {
|
|
494
|
-
style:
|
|
478
|
+
style: 'form',
|
|
495
479
|
explode: true,
|
|
496
480
|
},
|
|
497
481
|
},
|
|
@@ -502,10 +486,9 @@ export const getGroupsGroupidWallPosts = endpoint({
|
|
|
502
486
|
.optional()
|
|
503
487
|
.default(10),
|
|
504
488
|
cursor: z.string().optional(),
|
|
505
|
-
sortOrder: z.enum([
|
|
489
|
+
sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
|
|
506
490
|
},
|
|
507
|
-
response:
|
|
508
|
-
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupWallPostV2Model_,
|
|
491
|
+
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Groups_Api_GroupWallPostV2Model_,
|
|
509
492
|
errors: [
|
|
510
493
|
{
|
|
511
494
|
status: 400,
|
|
@@ -524,14 +507,14 @@ export const getGroupsGroupidWallPosts = endpoint({
|
|
|
524
507
|
* @param groupId The group id.
|
|
525
508
|
*/
|
|
526
509
|
export const postGroupsGroupidWallPosts = endpoint({
|
|
527
|
-
method:
|
|
528
|
-
path:
|
|
529
|
-
baseUrl:
|
|
530
|
-
requestFormat:
|
|
510
|
+
method: 'POST',
|
|
511
|
+
path: '/v2/groups/:groupId/wall/posts',
|
|
512
|
+
baseUrl: 'https://groups.roblox.com',
|
|
513
|
+
requestFormat: 'json',
|
|
531
514
|
serializationMethod: {
|
|
532
515
|
body: {},
|
|
533
516
|
groupId: {
|
|
534
|
-
style:
|
|
517
|
+
style: 'simple',
|
|
535
518
|
},
|
|
536
519
|
},
|
|
537
520
|
parameters: {
|
|
@@ -570,24 +553,24 @@ export const postGroupsGroupidWallPosts = endpoint({
|
|
|
570
553
|
* @param discoveryType
|
|
571
554
|
*/
|
|
572
555
|
export const getUsersUseridGroupsRoles = endpoint({
|
|
573
|
-
method:
|
|
574
|
-
path:
|
|
575
|
-
baseUrl:
|
|
576
|
-
requestFormat:
|
|
556
|
+
method: 'GET',
|
|
557
|
+
path: '/v2/users/:userId/groups/roles',
|
|
558
|
+
baseUrl: 'https://groups.roblox.com',
|
|
559
|
+
requestFormat: 'json',
|
|
577
560
|
serializationMethod: {
|
|
578
561
|
userId: {
|
|
579
|
-
style:
|
|
562
|
+
style: 'simple',
|
|
580
563
|
},
|
|
581
564
|
includeLocked: {
|
|
582
|
-
style:
|
|
565
|
+
style: 'form',
|
|
583
566
|
explode: true,
|
|
584
567
|
},
|
|
585
568
|
includeNotificationPreferences: {
|
|
586
|
-
style:
|
|
569
|
+
style: 'form',
|
|
587
570
|
explode: true,
|
|
588
571
|
},
|
|
589
572
|
discoveryType: {
|
|
590
|
-
style:
|
|
573
|
+
style: 'form',
|
|
591
574
|
explode: true,
|
|
592
575
|
},
|
|
593
576
|
},
|
|
@@ -597,8 +580,7 @@ export const getUsersUseridGroupsRoles = endpoint({
|
|
|
597
580
|
includeNotificationPreferences: z.boolean(),
|
|
598
581
|
discoveryType: z.union([z.literal(0), z.literal(1)]),
|
|
599
582
|
},
|
|
600
|
-
response:
|
|
601
|
-
Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_GroupMembershipResponse_,
|
|
583
|
+
response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_GroupMembershipResponse_,
|
|
602
584
|
errors: [
|
|
603
585
|
{
|
|
604
586
|
status: 400,
|