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.
Files changed (87) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +75 -451
  3. package/lib/endpoints/accountinformationv1.d.ts +92 -95
  4. package/lib/endpoints/accountsettingsv1.d.ts +88 -110
  5. package/lib/endpoints/adconfigurationv2.d.ts +108 -215
  6. package/lib/endpoints/assetdeliveryv1.d.ts +267 -230
  7. package/lib/endpoints/assetdeliveryv1.js +38 -0
  8. package/lib/endpoints/assetdeliveryv2.d.ts +201 -176
  9. package/lib/endpoints/assetdeliveryv2.js +26 -0
  10. package/lib/endpoints/authv1.d.ts +480 -517
  11. package/lib/endpoints/authv1.js +3 -1
  12. package/lib/endpoints/authv2.d.ts +210 -222
  13. package/lib/endpoints/authv2.js +1 -1
  14. package/lib/endpoints/authv3.d.ts +32 -35
  15. package/lib/endpoints/avatarv1.d.ts +112 -117
  16. package/lib/endpoints/avatarv2.d.ts +71 -76
  17. package/lib/endpoints/avatarv3.d.ts +27 -33
  18. package/lib/endpoints/badgesv1.d.ts +96 -99
  19. package/lib/endpoints/badgesv1.js +4 -0
  20. package/lib/endpoints/catalogv1.d.ts +209 -234
  21. package/lib/endpoints/catalogv1.js +2 -1
  22. package/lib/endpoints/catalogv2.d.ts +106 -136
  23. package/lib/endpoints/catalogv2.js +21 -17
  24. package/lib/endpoints/chatv2.d.ts +778 -778
  25. package/lib/endpoints/clientsettingsv1.d.ts +33 -35
  26. package/lib/endpoints/clientsettingsv2.d.ts +62 -68
  27. package/lib/endpoints/contactsv1.d.ts +18 -20
  28. package/lib/endpoints/developv1.d.ts +233 -293
  29. package/lib/endpoints/developv1.js +3 -0
  30. package/lib/endpoints/developv2.d.ts +87 -138
  31. package/lib/endpoints/developv2.js +3 -1
  32. package/lib/endpoints/economycreatorstatsv1.d.ts +12 -12
  33. package/lib/endpoints/economyv1.d.ts +6 -6
  34. package/lib/endpoints/engagementpayoutsv1.d.ts +9 -9
  35. package/lib/endpoints/followingsv1.d.ts +33 -34
  36. package/lib/endpoints/followingsv2.d.ts +9 -9
  37. package/lib/endpoints/friendsv1.d.ts +416 -545
  38. package/lib/endpoints/friendsv1.js +213 -313
  39. package/lib/endpoints/gameinternationalizationv1.d.ts +1509 -1642
  40. package/lib/endpoints/gameinternationalizationv2.d.ts +62 -64
  41. package/lib/endpoints/gamejoinv1.d.ts +458 -458
  42. package/lib/endpoints/gamesv1.d.ts +183 -143
  43. package/lib/endpoints/gamesv1.js +2 -0
  44. package/lib/endpoints/gamesv2.d.ts +161 -158
  45. package/lib/endpoints/gamesv2.js +9 -0
  46. package/lib/endpoints/groupsv1.d.ts +967 -976
  47. package/lib/endpoints/groupsv1.js +48 -4
  48. package/lib/endpoints/groupsv2.d.ts +259 -277
  49. package/lib/endpoints/groupsv2.js +1 -0
  50. package/lib/endpoints/inventoryv1.d.ts +93 -122
  51. package/lib/endpoints/inventoryv1.js +3 -1
  52. package/lib/endpoints/inventoryv2.d.ts +163 -178
  53. package/lib/endpoints/inventoryv2.js +2 -0
  54. package/lib/endpoints/itemconfigurationv1.d.ts +33 -40
  55. package/lib/endpoints/localev1.d.ts +47 -48
  56. package/lib/endpoints/localizationtablesv1.d.ts +315 -353
  57. package/lib/endpoints/matchmakingv1.d.ts +184 -190
  58. package/lib/endpoints/metricsv1.d.ts +88 -88
  59. package/lib/endpoints/notificationsv2.d.ts +144 -158
  60. package/lib/endpoints/premiumfeaturesv1.d.ts +14 -14
  61. package/lib/endpoints/presencev1.d.ts +7 -12
  62. package/lib/endpoints/privatemessagesv1.d.ts +56 -64
  63. package/lib/endpoints/publishv1.d.ts +32 -32
  64. package/lib/endpoints/thumbnailsresizerv1.d.ts +52 -53
  65. package/lib/endpoints/thumbnailsv1.d.ts +317 -361
  66. package/lib/endpoints/thumbnailsv1.js +25 -0
  67. package/lib/endpoints/tradesv1.d.ts +92 -104
  68. package/lib/endpoints/tradesv2.d.ts +81 -84
  69. package/lib/endpoints/translationrolesv1.d.ts +46 -51
  70. package/lib/endpoints/twostepverificationv1.d.ts +233 -237
  71. package/lib/endpoints/usersv1.d.ts +110 -114
  72. package/lib/index.d.ts +152 -4
  73. package/lib/index.js +273 -4
  74. package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
  75. package/lib/opencloud/v1/assets.d.ts +9 -9
  76. package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
  77. package/lib/opencloud/v1/datastores.d.ts +8 -8
  78. package/lib/opencloud/v1/developer-products.d.ts +4 -4
  79. package/lib/opencloud/v1/game-passes.d.ts +4 -4
  80. package/lib/opencloud/v1/messaging.d.ts +1 -1
  81. package/lib/opencloud/v1/open-eval.d.ts +2 -2
  82. package/lib/opencloud/v1/secrets-store.d.ts +5 -5
  83. package/lib/opencloud/v1/toolbox.d.ts +2 -2
  84. package/lib/opencloud/v1/universes.d.ts +1 -1
  85. package/lib/opencloud/v2/cloud.d.ts +172 -84
  86. package/lib/opencloud/v2/cloud.js +25 -9
  87. package/package.json +2 -2
@@ -1,23 +1,15 @@
1
- import { z } from "zod";
2
- import { endpoint } from "..";
1
+ import { z } from 'zod';
2
+ import { endpoint } from '..';
3
3
 
4
4
  const Roblox_Web_Responses_Thumbnails_ThumbnailResponse = z.object({
5
5
  targetId: z.number().int(),
6
- state: z.enum([
7
- "Error",
8
- "Completed",
9
- "InReview",
10
- "Pending",
11
- "Blocked",
12
- "TemporarilyUnavailable",
13
- ]),
6
+ state: z.enum(['Error', 'Completed', 'InReview', 'Pending', 'Blocked', 'TemporarilyUnavailable']),
14
7
  imageUrl: z.string(),
15
8
  version: z.string(),
16
9
  });
17
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_ =
18
- z.object({
19
- data: z.array(Roblox_Web_Responses_Thumbnails_ThumbnailResponse),
20
- });
10
+ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_ = z.object({
11
+ data: z.array(Roblox_Web_Responses_Thumbnails_ThumbnailResponse),
12
+ });
21
13
  const Roblox_Web_WebAPI_Models_ApiErrorModel = z.object({
22
14
  code: z.number().int(),
23
15
  message: z.string(),
@@ -30,62 +22,54 @@ const Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse = z.object({
30
22
  error: Roblox_Web_WebAPI_Models_ApiErrorModel,
31
23
  thumbnails: z.array(Roblox_Web_Responses_Thumbnails_ThumbnailResponse),
32
24
  });
33
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse_ =
34
- z.object({
35
- data: z.array(Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse),
36
- });
25
+ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse_ = z.object({
26
+ data: z.array(Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse),
27
+ });
37
28
  const Roblox_Thumbnails_Apis_Models_ThumbnailBatchRequest = z.object({
38
29
  requestId: z.string(),
39
30
  targetId: z.number().int(),
40
31
  token: z.string(),
41
32
  alias: z.string(),
42
33
  type: z.enum([
43
- "Avatar",
44
- "AvatarHeadShot",
45
- "GameIcon",
46
- "BadgeIcon",
47
- "GameThumbnail",
48
- "GamePass",
49
- "Asset",
50
- "BundleThumbnail",
51
- "Outfit",
52
- "GroupIcon",
53
- "DeveloperProduct",
54
- "AvatarBust",
55
- "AutoGeneratedAsset",
56
- "PlaceIcon",
57
- "AutoGeneratedGameIcon",
58
- "ForceAutoGeneratedGameIcon",
59
- "Look",
60
- "CreatorContextAsset",
61
- "Screenshot",
34
+ 'Avatar',
35
+ 'AvatarHeadShot',
36
+ 'GameIcon',
37
+ 'BadgeIcon',
38
+ 'GameThumbnail',
39
+ 'GamePass',
40
+ 'Asset',
41
+ 'BundleThumbnail',
42
+ 'Outfit',
43
+ 'GroupIcon',
44
+ 'DeveloperProduct',
45
+ 'AvatarBust',
46
+ 'AutoGeneratedAsset',
47
+ 'PlaceIcon',
48
+ 'AutoGeneratedGameIcon',
49
+ 'ForceAutoGeneratedGameIcon',
50
+ 'Look',
51
+ 'CreatorContextAsset',
52
+ 'Screenshot',
62
53
  ]),
63
54
  size: z.string(),
64
55
  format: z.string(),
65
56
  isCircular: z.boolean(),
66
57
  accessContext: z.string(),
67
58
  headShape: z.string(),
59
+ includeBackground: z.boolean(),
68
60
  });
69
61
  const Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse = z.object({
70
62
  requestId: z.string(),
71
63
  errorCode: z.number().int(),
72
64
  errorMessage: z.string(),
73
65
  targetId: z.number().int(),
74
- state: z.enum([
75
- "Error",
76
- "Completed",
77
- "InReview",
78
- "Pending",
79
- "Blocked",
80
- "TemporarilyUnavailable",
81
- ]),
66
+ state: z.enum(['Error', 'Completed', 'InReview', 'Pending', 'Blocked', 'TemporarilyUnavailable']),
82
67
  imageUrl: z.string(),
83
68
  version: z.string(),
84
69
  });
85
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse_ =
86
- z.object({
87
- data: z.array(Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse),
88
- });
70
+ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse_ = z.object({
71
+ data: z.array(Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse),
72
+ });
89
73
 
90
74
  /**
91
75
  * @api GET https://thumbnails.roblox.com/v1/asset-thumbnail-animated
@@ -94,22 +78,22 @@ const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_
94
78
  * @param Roblox-Place-Id (optional) placeid
95
79
  */
96
80
  export const getAssetThumbnailAnimated = endpoint({
97
- method: "GET",
98
- path: "/v1/asset-thumbnail-animated",
99
- baseUrl: "https://thumbnails.roblox.com",
100
- requestFormat: "json",
81
+ method: 'GET',
82
+ path: '/v1/asset-thumbnail-animated',
83
+ baseUrl: 'https://thumbnails.roblox.com',
84
+ requestFormat: 'json',
101
85
  serializationMethod: {
102
86
  assetId: {
103
- style: "form",
87
+ style: 'form',
104
88
  explode: true,
105
89
  },
106
- "Roblox-Place-Id": {
107
- style: "simple",
90
+ 'Roblox-Place-Id': {
91
+ style: 'simple',
108
92
  },
109
93
  },
110
94
  parameters: {
111
95
  assetId: z.number().int(),
112
- "Roblox-Place-Id": z.number().int().optional(),
96
+ 'Roblox-Place-Id': z.number().int().optional(),
113
97
  },
114
98
  response: Roblox_Web_Responses_Thumbnails_ThumbnailResponse,
115
99
  errors: [
@@ -130,86 +114,80 @@ export const getAssetThumbnailAnimated = endpoint({
130
114
  * @param isCircular The circle thumbnail output parameter, true or false
131
115
  */
132
116
  export const getAssets = endpoint({
133
- method: "GET",
134
- path: "/v1/assets",
135
- baseUrl: "https://thumbnails.roblox.com",
136
- requestFormat: "json",
117
+ method: 'GET',
118
+ path: '/v1/assets',
119
+ baseUrl: 'https://thumbnails.roblox.com',
120
+ requestFormat: 'json',
137
121
  serializationMethod: {
138
122
  assetIds: {
139
- style: "form",
123
+ style: 'form',
140
124
  },
141
- "Roblox-Place-Id": {
142
- style: "simple",
125
+ 'Roblox-Place-Id': {
126
+ style: 'simple',
143
127
  },
144
128
  returnPolicy: {
145
- style: "form",
129
+ style: 'form',
146
130
  explode: true,
147
131
  },
148
132
  size: {
149
- style: "form",
133
+ style: 'form',
150
134
  explode: true,
151
135
  },
152
136
  format: {
153
- style: "form",
137
+ style: 'form',
154
138
  explode: true,
155
139
  },
156
140
  isCircular: {
157
- style: "form",
141
+ style: 'form',
158
142
  explode: true,
159
143
  },
160
144
  },
161
145
  parameters: {
162
146
  assetIds: z.array(z.number()),
163
- "Roblox-Place-Id": z.number().int().optional(),
147
+ 'Roblox-Place-Id': z.number().int().optional(),
164
148
  returnPolicy: z
165
- .enum([
166
- "PlaceHolder",
167
- "ForcePlaceHolder",
168
- "AutoGenerated",
169
- "ForceAutoGenerated",
170
- ])
149
+ .enum(['PlaceHolder', 'ForcePlaceHolder', 'AutoGenerated', 'ForceAutoGenerated'])
171
150
  .optional()
172
- .default("PlaceHolder"),
151
+ .default('PlaceHolder'),
173
152
  size: z
174
153
  .enum([
175
- "30x30",
176
- "42x42",
177
- "50x50",
178
- "60x62",
179
- "75x75",
180
- "110x110",
181
- "140x140",
182
- "150x150",
183
- "160x100",
184
- "160x600",
185
- "250x250",
186
- "256x144",
187
- "300x250",
188
- "304x166",
189
- "384x216",
190
- "396x216",
191
- "420x420",
192
- "480x270",
193
- "512x512",
194
- "576x324",
195
- "700x700",
196
- "728x90",
197
- "768x432",
198
- "1200x80",
199
- "330x110",
200
- "660x220",
201
- "1320x440",
202
- "720x228",
203
- "1440x456",
204
- "930x480",
154
+ '30x30',
155
+ '42x42',
156
+ '50x50',
157
+ '60x62',
158
+ '75x75',
159
+ '110x110',
160
+ '140x140',
161
+ '150x150',
162
+ '160x100',
163
+ '160x600',
164
+ '250x250',
165
+ '256x144',
166
+ '300x250',
167
+ '304x166',
168
+ '384x216',
169
+ '396x216',
170
+ '420x420',
171
+ '480x270',
172
+ '512x512',
173
+ '576x324',
174
+ '700x700',
175
+ '728x90',
176
+ '768x432',
177
+ '1200x80',
178
+ '330x110',
179
+ '660x220',
180
+ '1320x440',
181
+ '720x228',
182
+ '1440x456',
183
+ '930x480',
205
184
  ])
206
185
  .optional()
207
- .default("30x30"),
208
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
186
+ .default('30x30'),
187
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
209
188
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
210
189
  },
211
- response:
212
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
190
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
213
191
  errors: [
214
192
  {
215
193
  status: 400,
@@ -234,27 +212,27 @@ export const getAssets = endpoint({
234
212
  * @param Roblox-Place-Id (optional) placeid
235
213
  */
236
214
  export const getAssetsThumbnail3d = endpoint({
237
- method: "GET",
238
- path: "/v1/assets-thumbnail-3d",
239
- baseUrl: "https://thumbnails.roblox.com",
240
- requestFormat: "json",
215
+ method: 'GET',
216
+ path: '/v1/assets-thumbnail-3d',
217
+ baseUrl: 'https://thumbnails.roblox.com',
218
+ requestFormat: 'json',
241
219
  serializationMethod: {
242
220
  assetId: {
243
- style: "form",
221
+ style: 'form',
244
222
  explode: true,
245
223
  },
246
224
  useGltf: {
247
- style: "form",
225
+ style: 'form',
248
226
  explode: true,
249
227
  },
250
- "Roblox-Place-Id": {
251
- style: "simple",
228
+ 'Roblox-Place-Id': {
229
+ style: 'simple',
252
230
  },
253
231
  },
254
232
  parameters: {
255
233
  assetId: z.number().int(),
256
234
  useGltf: z.boolean().optional(),
257
- "Roblox-Place-Id": z.number().int().optional(),
235
+ 'Roblox-Place-Id': z.number().int().optional(),
258
236
  },
259
237
  response: Roblox_Web_Responses_Thumbnails_ThumbnailResponse,
260
238
  errors: [
@@ -273,35 +251,34 @@ export const getAssetsThumbnail3d = endpoint({
273
251
  * @param isCircular The circle thumbnail output parameter, true or false
274
252
  */
275
253
  export const getBadgesIcons = endpoint({
276
- method: "GET",
277
- path: "/v1/badges/icons",
278
- baseUrl: "https://thumbnails.roblox.com",
279
- requestFormat: "json",
254
+ method: 'GET',
255
+ path: '/v1/badges/icons',
256
+ baseUrl: 'https://thumbnails.roblox.com',
257
+ requestFormat: 'json',
280
258
  serializationMethod: {
281
259
  badgeIds: {
282
- style: "form",
260
+ style: 'form',
283
261
  },
284
262
  size: {
285
- style: "form",
263
+ style: 'form',
286
264
  explode: true,
287
265
  },
288
266
  format: {
289
- style: "form",
267
+ style: 'form',
290
268
  explode: true,
291
269
  },
292
270
  isCircular: {
293
- style: "form",
271
+ style: 'form',
294
272
  explode: true,
295
273
  },
296
274
  },
297
275
  parameters: {
298
276
  badgeIds: z.array(z.number()),
299
- size: z.literal("150x150").optional().default("150x150"),
300
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
277
+ size: z.literal('150x150').optional().default('150x150'),
278
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
301
279
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
302
280
  },
303
- response:
304
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
281
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
305
282
  errors: [
306
283
  {
307
284
  status: 400,
@@ -339,22 +316,21 @@ export const getBadgesIcons = endpoint({
339
316
  * @param Roblox-Place-Id (optional) placeid
340
317
  */
341
318
  export const postBatch = endpoint({
342
- method: "POST",
343
- path: "/v1/batch",
344
- baseUrl: "https://thumbnails.roblox.com",
345
- requestFormat: "json",
319
+ method: 'POST',
320
+ path: '/v1/batch',
321
+ baseUrl: 'https://thumbnails.roblox.com',
322
+ requestFormat: 'json',
346
323
  serializationMethod: {
347
324
  body: {},
348
- "Roblox-Place-Id": {
349
- style: "simple",
325
+ 'Roblox-Place-Id': {
326
+ style: 'simple',
350
327
  },
351
328
  },
352
329
  parameters: {
353
- "Roblox-Place-Id": z.number().int().optional(),
330
+ 'Roblox-Place-Id': z.number().int().optional(),
354
331
  },
355
332
  body: z.array(Roblox_Thumbnails_Apis_Models_ThumbnailBatchRequest),
356
- response:
357
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse_,
333
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse_,
358
334
  errors: [
359
335
  {
360
336
  status: 400,
@@ -379,35 +355,34 @@ export const postBatch = endpoint({
379
355
  * @param isCircular The circle thumbnail output parameter, true or false
380
356
  */
381
357
  export const getBundlesThumbnails = endpoint({
382
- method: "GET",
383
- path: "/v1/bundles/thumbnails",
384
- baseUrl: "https://thumbnails.roblox.com",
385
- requestFormat: "json",
358
+ method: 'GET',
359
+ path: '/v1/bundles/thumbnails',
360
+ baseUrl: 'https://thumbnails.roblox.com',
361
+ requestFormat: 'json',
386
362
  serializationMethod: {
387
363
  bundleIds: {
388
- style: "form",
364
+ style: 'form',
389
365
  },
390
366
  size: {
391
- style: "form",
367
+ style: 'form',
392
368
  explode: true,
393
369
  },
394
370
  format: {
395
- style: "form",
371
+ style: 'form',
396
372
  explode: true,
397
373
  },
398
374
  isCircular: {
399
- style: "form",
375
+ style: 'form',
400
376
  explode: true,
401
377
  },
402
378
  },
403
379
  parameters: {
404
380
  bundleIds: z.array(z.number()),
405
- size: z.enum(["150x150", "420x420"]).optional().default("150x150"),
406
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
381
+ size: z.enum(['150x150', '420x420']).optional().default('150x150'),
382
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
407
383
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
408
384
  },
409
- response:
410
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
385
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
411
386
  errors: [
412
387
  {
413
388
  status: 400,
@@ -428,35 +403,34 @@ export const getBundlesThumbnails = endpoint({
428
403
  * @param isCircular The circle thumbnail output parameter, true or false
429
404
  */
430
405
  export const getDeveloperProductsIcons = endpoint({
431
- method: "GET",
432
- path: "/v1/developer-products/icons",
433
- baseUrl: "https://thumbnails.roblox.com",
434
- requestFormat: "json",
406
+ method: 'GET',
407
+ path: '/v1/developer-products/icons',
408
+ baseUrl: 'https://thumbnails.roblox.com',
409
+ requestFormat: 'json',
435
410
  serializationMethod: {
436
411
  developerProductIds: {
437
- style: "form",
412
+ style: 'form',
438
413
  },
439
414
  size: {
440
- style: "form",
415
+ style: 'form',
441
416
  explode: true,
442
417
  },
443
418
  format: {
444
- style: "form",
419
+ style: 'form',
445
420
  explode: true,
446
421
  },
447
422
  isCircular: {
448
- style: "form",
423
+ style: 'form',
449
424
  explode: true,
450
425
  },
451
426
  },
452
427
  parameters: {
453
428
  developerProductIds: z.array(z.number()),
454
- size: z.enum(["150x150", "420x420"]).optional().default("150x150"),
455
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
429
+ size: z.enum(['150x150', '420x420']).optional().default('150x150'),
430
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
456
431
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
457
432
  },
458
- response:
459
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
433
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
460
434
  errors: [
461
435
  {
462
436
  status: 400,
@@ -477,35 +451,34 @@ export const getDeveloperProductsIcons = endpoint({
477
451
  * @param isCircular The circle thumbnail output parameter, true or false
478
452
  */
479
453
  export const getGamePasses = endpoint({
480
- method: "GET",
481
- path: "/v1/game-passes",
482
- baseUrl: "https://thumbnails.roblox.com",
483
- requestFormat: "json",
454
+ method: 'GET',
455
+ path: '/v1/game-passes',
456
+ baseUrl: 'https://thumbnails.roblox.com',
457
+ requestFormat: 'json',
484
458
  serializationMethod: {
485
459
  gamePassIds: {
486
- style: "form",
460
+ style: 'form',
487
461
  },
488
462
  size: {
489
- style: "form",
463
+ style: 'form',
490
464
  explode: true,
491
465
  },
492
466
  format: {
493
- style: "form",
467
+ style: 'form',
494
468
  explode: true,
495
469
  },
496
470
  isCircular: {
497
- style: "form",
471
+ style: 'form',
498
472
  explode: true,
499
473
  },
500
474
  },
501
475
  parameters: {
502
476
  gamePassIds: z.array(z.number()),
503
- size: z.literal("150x150").optional().default("150x150"),
504
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
477
+ size: z.literal('150x150').optional().default('150x150'),
478
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
505
479
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
506
480
  },
507
- response:
508
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
481
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
509
482
  errors: [
510
483
  {
511
484
  status: 400,
@@ -527,42 +500,38 @@ export const getGamePasses = endpoint({
527
500
  * @param isCircular The circle thumbnail output parameter, true or false
528
501
  */
529
502
  export const getGamesUniverseidThumbnails = endpoint({
530
- method: "GET",
531
- path: "/v1/games/:universeId/thumbnails",
532
- baseUrl: "https://thumbnails.roblox.com",
533
- requestFormat: "json",
503
+ method: 'GET',
504
+ path: '/v1/games/:universeId/thumbnails',
505
+ baseUrl: 'https://thumbnails.roblox.com',
506
+ requestFormat: 'json',
534
507
  serializationMethod: {
535
508
  universeId: {
536
- style: "simple",
509
+ style: 'simple',
537
510
  },
538
511
  thumbnailIds: {
539
- style: "form",
512
+ style: 'form',
540
513
  },
541
514
  size: {
542
- style: "form",
515
+ style: 'form',
543
516
  explode: true,
544
517
  },
545
518
  format: {
546
- style: "form",
519
+ style: 'form',
547
520
  explode: true,
548
521
  },
549
522
  isCircular: {
550
- style: "form",
523
+ style: 'form',
551
524
  explode: true,
552
525
  },
553
526
  },
554
527
  parameters: {
555
528
  universeId: z.number().int(),
556
529
  thumbnailIds: z.array(z.number()),
557
- size: z
558
- .enum(["768x432", "576x324", "480x270", "384x216", "256x144"])
559
- .optional()
560
- .default("768x432"),
561
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
530
+ size: z.enum(['768x432', '576x324', '480x270', '384x216', '256x144']).optional().default('768x432'),
531
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
562
532
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
563
533
  },
564
- response:
565
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
534
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
566
535
  errors: [
567
536
  {
568
537
  status: 400,
@@ -590,51 +559,42 @@ use the 'targetId' of the objects in the result array.
590
559
  * @param isCircular The circle thumbnail output parameter, true or false
591
560
  */
592
561
  export const getGamesIcons = endpoint({
593
- method: "GET",
594
- path: "/v1/games/icons",
595
- baseUrl: "https://thumbnails.roblox.com",
596
- requestFormat: "json",
562
+ method: 'GET',
563
+ path: '/v1/games/icons',
564
+ baseUrl: 'https://thumbnails.roblox.com',
565
+ requestFormat: 'json',
597
566
  serializationMethod: {
598
567
  universeIds: {
599
- style: "form",
568
+ style: 'form',
600
569
  },
601
570
  returnPolicy: {
602
- style: "form",
571
+ style: 'form',
603
572
  explode: true,
604
573
  },
605
574
  size: {
606
- style: "form",
575
+ style: 'form',
607
576
  explode: true,
608
577
  },
609
578
  format: {
610
- style: "form",
579
+ style: 'form',
611
580
  explode: true,
612
581
  },
613
582
  isCircular: {
614
- style: "form",
583
+ style: 'form',
615
584
  explode: true,
616
585
  },
617
586
  },
618
587
  parameters: {
619
588
  universeIds: z.array(z.number()),
620
589
  returnPolicy: z
621
- .enum([
622
- "PlaceHolder",
623
- "ForcePlaceHolder",
624
- "AutoGenerated",
625
- "ForceAutoGenerated",
626
- ])
590
+ .enum(['PlaceHolder', 'ForcePlaceHolder', 'AutoGenerated', 'ForceAutoGenerated'])
627
591
  .optional()
628
- .default("PlaceHolder"),
629
- size: z
630
- .enum(["50x50", "128x128", "150x150", "256x256", "420x420", "512x512"])
631
- .optional()
632
- .default("50x50"),
633
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
592
+ .default('PlaceHolder'),
593
+ size: z.enum(['50x50', '128x128', '150x150', '256x256', '420x420', '512x512']).optional().default('50x50'),
594
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
634
595
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
635
596
  },
636
- response:
637
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
597
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
638
598
  errors: [
639
599
  {
640
600
  status: 400,
@@ -662,32 +622,32 @@ export const getGamesIcons = endpoint({
662
622
  * @param isCircular The circle thumbnail output parameter, true or false
663
623
  */
664
624
  export const getGamesMultigetThumbnails = endpoint({
665
- method: "GET",
666
- path: "/v1/games/multiget/thumbnails",
667
- baseUrl: "https://thumbnails.roblox.com",
668
- requestFormat: "json",
625
+ method: 'GET',
626
+ path: '/v1/games/multiget/thumbnails',
627
+ baseUrl: 'https://thumbnails.roblox.com',
628
+ requestFormat: 'json',
669
629
  serializationMethod: {
670
630
  universeIds: {
671
- style: "form",
631
+ style: 'form',
672
632
  },
673
633
  countPerUniverse: {
674
- style: "form",
634
+ style: 'form',
675
635
  explode: true,
676
636
  },
677
637
  defaults: {
678
- style: "form",
638
+ style: 'form',
679
639
  explode: true,
680
640
  },
681
641
  size: {
682
- style: "form",
642
+ style: 'form',
683
643
  explode: true,
684
644
  },
685
645
  format: {
686
- style: "form",
646
+ style: 'form',
687
647
  explode: true,
688
648
  },
689
649
  isCircular: {
690
- style: "form",
650
+ style: 'form',
691
651
  explode: true,
692
652
  },
693
653
  },
@@ -695,15 +655,11 @@ export const getGamesMultigetThumbnails = endpoint({
695
655
  universeIds: z.array(z.number()),
696
656
  countPerUniverse: z.number().int().optional().default(1),
697
657
  defaults: z.boolean().optional().default(true),
698
- size: z
699
- .enum(["768x432", "576x324", "480x270", "384x216", "256x144"])
700
- .optional()
701
- .default("768x432"),
702
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
658
+ size: z.enum(['768x432', '576x324', '480x270', '384x216', '256x144']).optional().default('768x432'),
659
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
703
660
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
704
661
  },
705
- response:
706
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse_,
662
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Thumbnails_Api_Models_UniverseThumbnailsResponse_,
707
663
  errors: [
708
664
  {
709
665
  status: 400,
@@ -724,35 +680,34 @@ export const getGamesMultigetThumbnails = endpoint({
724
680
  * @param isCircular The circle thumbnail output parameter, true or false
725
681
  */
726
682
  export const getGroupsIcons = endpoint({
727
- method: "GET",
728
- path: "/v1/groups/icons",
729
- baseUrl: "https://thumbnails.roblox.com",
730
- requestFormat: "json",
683
+ method: 'GET',
684
+ path: '/v1/groups/icons',
685
+ baseUrl: 'https://thumbnails.roblox.com',
686
+ requestFormat: 'json',
731
687
  serializationMethod: {
732
688
  groupIds: {
733
- style: "form",
689
+ style: 'form',
734
690
  },
735
691
  size: {
736
- style: "form",
692
+ style: 'form',
737
693
  explode: true,
738
694
  },
739
695
  format: {
740
- style: "form",
696
+ style: 'form',
741
697
  explode: true,
742
698
  },
743
699
  isCircular: {
744
- style: "form",
700
+ style: 'form',
745
701
  explode: true,
746
702
  },
747
703
  },
748
704
  parameters: {
749
705
  groupIds: z.array(z.number()),
750
- size: z.enum(["150x150", "420x420"]).optional().default("150x150"),
751
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
706
+ size: z.enum(['150x150', '420x420']).optional().default('150x150'),
707
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
752
708
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
753
709
  },
754
- response:
755
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
710
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
756
711
  errors: [
757
712
  {
758
713
  status: 400,
@@ -774,51 +729,42 @@ export const getGroupsIcons = endpoint({
774
729
  * @param isCircular The circle thumbnail output parameter, true or false
775
730
  */
776
731
  export const getPlacesGameicons = endpoint({
777
- method: "GET",
778
- path: "/v1/places/gameicons",
779
- baseUrl: "https://thumbnails.roblox.com",
780
- requestFormat: "json",
732
+ method: 'GET',
733
+ path: '/v1/places/gameicons',
734
+ baseUrl: 'https://thumbnails.roblox.com',
735
+ requestFormat: 'json',
781
736
  serializationMethod: {
782
737
  placeIds: {
783
- style: "form",
738
+ style: 'form',
784
739
  },
785
740
  returnPolicy: {
786
- style: "form",
741
+ style: 'form',
787
742
  explode: true,
788
743
  },
789
744
  size: {
790
- style: "form",
745
+ style: 'form',
791
746
  explode: true,
792
747
  },
793
748
  format: {
794
- style: "form",
749
+ style: 'form',
795
750
  explode: true,
796
751
  },
797
752
  isCircular: {
798
- style: "form",
753
+ style: 'form',
799
754
  explode: true,
800
755
  },
801
756
  },
802
757
  parameters: {
803
758
  placeIds: z.array(z.number()),
804
759
  returnPolicy: z
805
- .enum([
806
- "PlaceHolder",
807
- "ForcePlaceHolder",
808
- "AutoGenerated",
809
- "ForceAutoGenerated",
810
- ])
811
- .optional()
812
- .default("PlaceHolder"),
813
- size: z
814
- .enum(["50x50", "128x128", "150x150", "256x256", "420x420", "512x512"])
760
+ .enum(['PlaceHolder', 'ForcePlaceHolder', 'AutoGenerated', 'ForceAutoGenerated'])
815
761
  .optional()
816
- .default("50x50"),
817
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
762
+ .default('PlaceHolder'),
763
+ size: z.enum(['50x50', '128x128', '150x150', '256x256', '420x420', '512x512']).optional().default('50x50'),
764
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
818
765
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
819
766
  },
820
- response:
821
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
767
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
822
768
  errors: [
823
769
  {
824
770
  status: 400,
@@ -839,58 +785,63 @@ export const getPlacesGameicons = endpoint({
839
785
  * @api GET https://thumbnails.roblox.com/v1/users/avatar
840
786
  * @summary Get Avatar Full body shots for the given CSV of userIds
841
787
  * @param userIds CSV for the userIds to get avatar full body shots
788
+ * @param includeBackground Whether to include a background in the thumbnail (defaults to false)
842
789
  * @param size The thumbnail size, formatted widthxheight
843
790
  * @param format The thumbnail format
844
791
  * @param isCircular The circle thumbnail output parameter, true or false
845
792
  */
846
793
  export const getUsersAvatar = endpoint({
847
- method: "GET",
848
- path: "/v1/users/avatar",
849
- baseUrl: "https://thumbnails.roblox.com",
850
- requestFormat: "json",
794
+ method: 'GET',
795
+ path: '/v1/users/avatar',
796
+ baseUrl: 'https://thumbnails.roblox.com',
797
+ requestFormat: 'json',
851
798
  serializationMethod: {
852
799
  userIds: {
853
- style: "form",
800
+ style: 'form',
801
+ },
802
+ includeBackground: {
803
+ style: 'form',
804
+ explode: true,
854
805
  },
855
806
  size: {
856
- style: "form",
807
+ style: 'form',
857
808
  explode: true,
858
809
  },
859
810
  format: {
860
- style: "form",
811
+ style: 'form',
861
812
  explode: true,
862
813
  },
863
814
  isCircular: {
864
- style: "form",
815
+ style: 'form',
865
816
  explode: true,
866
817
  },
867
818
  },
868
819
  parameters: {
869
820
  userIds: z.array(z.number()),
821
+ includeBackground: z.boolean().optional(),
870
822
  size: z
871
823
  .enum([
872
- "30x30",
873
- "48x48",
874
- "60x60",
875
- "75x75",
876
- "100x100",
877
- "110x110",
878
- "140x140",
879
- "150x150",
880
- "150x200",
881
- "180x180",
882
- "250x250",
883
- "352x352",
884
- "420x420",
885
- "720x720",
824
+ '30x30',
825
+ '48x48',
826
+ '60x60',
827
+ '75x75',
828
+ '100x100',
829
+ '110x110',
830
+ '140x140',
831
+ '150x150',
832
+ '150x200',
833
+ '180x180',
834
+ '250x250',
835
+ '352x352',
836
+ '420x420',
837
+ '720x720',
886
838
  ])
887
839
  .optional()
888
- .default("30x30"),
889
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
840
+ .default('30x30'),
841
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
890
842
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
891
843
  },
892
- response:
893
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
844
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
894
845
  errors: [
895
846
  {
896
847
  status: 400,
@@ -908,13 +859,13 @@ export const getUsersAvatar = endpoint({
908
859
  * @param userId user Id for avatar
909
860
  */
910
861
  export const getUsersAvatar3d = endpoint({
911
- method: "GET",
912
- path: "/v1/users/avatar-3d",
913
- baseUrl: "https://thumbnails.roblox.com",
914
- requestFormat: "json",
862
+ method: 'GET',
863
+ path: '/v1/users/avatar-3d',
864
+ baseUrl: 'https://thumbnails.roblox.com',
865
+ requestFormat: 'json',
915
866
  serializationMethod: {
916
867
  userId: {
917
- style: "form",
868
+ style: 'form',
918
869
  explode: true,
919
870
  },
920
871
  },
@@ -933,53 +884,48 @@ export const getUsersAvatar3d = endpoint({
933
884
  * @api GET https://thumbnails.roblox.com/v1/users/avatar-bust
934
885
  * @summary Get Avatar Busts for the given CSV of userIds
935
886
  * @param userIds CSV for the userIds to get avatar headshots
887
+ * @param includeBackground Whether to include a background in the thumbnail (defaults to false)
936
888
  * @param size The thumbnail size, formatted widthxheight
937
889
  * @param format The thumbnail format
938
890
  * @param isCircular The circle thumbnail output parameter, true or false
939
891
  */
940
892
  export const getUsersAvatarBust = endpoint({
941
- method: "GET",
942
- path: "/v1/users/avatar-bust",
943
- baseUrl: "https://thumbnails.roblox.com",
944
- requestFormat: "json",
893
+ method: 'GET',
894
+ path: '/v1/users/avatar-bust',
895
+ baseUrl: 'https://thumbnails.roblox.com',
896
+ requestFormat: 'json',
945
897
  serializationMethod: {
946
898
  userIds: {
947
- style: "form",
899
+ style: 'form',
900
+ },
901
+ includeBackground: {
902
+ style: 'form',
903
+ explode: true,
948
904
  },
949
905
  size: {
950
- style: "form",
906
+ style: 'form',
951
907
  explode: true,
952
908
  },
953
909
  format: {
954
- style: "form",
910
+ style: 'form',
955
911
  explode: true,
956
912
  },
957
913
  isCircular: {
958
- style: "form",
914
+ style: 'form',
959
915
  explode: true,
960
916
  },
961
917
  },
962
918
  parameters: {
963
919
  userIds: z.array(z.number()),
920
+ includeBackground: z.boolean().optional(),
964
921
  size: z
965
- .enum([
966
- "48x48",
967
- "50x50",
968
- "60x60",
969
- "75x75",
970
- "100x100",
971
- "150x150",
972
- "180x180",
973
- "352x352",
974
- "420x420",
975
- ])
922
+ .enum(['48x48', '50x50', '60x60', '75x75', '100x100', '150x150', '180x180', '352x352', '420x420'])
976
923
  .optional()
977
- .default("48x48"),
978
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
924
+ .default('48x48'),
925
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
979
926
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
980
927
  },
981
- response:
982
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
928
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
983
929
  errors: [
984
930
  {
985
931
  status: 400,
@@ -995,55 +941,60 @@ export const getUsersAvatarBust = endpoint({
995
941
  * @api GET https://thumbnails.roblox.com/v1/users/avatar-headshot
996
942
  * @summary Get Avatar Headshots for the given CSV of userIds
997
943
  * @param userIds CSV for the userIds to get avatar headshots
944
+ * @param includeBackground Whether to include a background in the thumbnail (defaults to false)
998
945
  * @param size The thumbnail size, formatted widthxheight
999
946
  * @param format The thumbnail format
1000
947
  * @param isCircular The circle thumbnail output parameter, true or false
1001
948
  */
1002
949
  export const getUsersAvatarHeadshot = endpoint({
1003
- method: "GET",
1004
- path: "/v1/users/avatar-headshot",
1005
- baseUrl: "https://thumbnails.roblox.com",
1006
- requestFormat: "json",
950
+ method: 'GET',
951
+ path: '/v1/users/avatar-headshot',
952
+ baseUrl: 'https://thumbnails.roblox.com',
953
+ requestFormat: 'json',
1007
954
  serializationMethod: {
1008
955
  userIds: {
1009
- style: "form",
956
+ style: 'form',
957
+ },
958
+ includeBackground: {
959
+ style: 'form',
960
+ explode: true,
1010
961
  },
1011
962
  size: {
1012
- style: "form",
963
+ style: 'form',
1013
964
  explode: true,
1014
965
  },
1015
966
  format: {
1016
- style: "form",
967
+ style: 'form',
1017
968
  explode: true,
1018
969
  },
1019
970
  isCircular: {
1020
- style: "form",
971
+ style: 'form',
1021
972
  explode: true,
1022
973
  },
1023
974
  },
1024
975
  parameters: {
1025
976
  userIds: z.array(z.number()),
977
+ includeBackground: z.boolean().optional(),
1026
978
  size: z
1027
979
  .enum([
1028
- "48x48",
1029
- "50x50",
1030
- "60x60",
1031
- "75x75",
1032
- "100x100",
1033
- "110x110",
1034
- "150x150",
1035
- "180x180",
1036
- "352x352",
1037
- "420x420",
1038
- "720x720",
980
+ '48x48',
981
+ '50x50',
982
+ '60x60',
983
+ '75x75',
984
+ '100x100',
985
+ '110x110',
986
+ '150x150',
987
+ '180x180',
988
+ '352x352',
989
+ '420x420',
990
+ '720x720',
1039
991
  ])
1040
992
  .optional()
1041
- .default("48x48"),
1042
- format: z.enum(["Png", "Jpeg", "Webp"]).optional().default("Png"),
993
+ .default('48x48'),
994
+ format: z.enum(['Png', 'Jpeg', 'Webp']).optional().default('Png'),
1043
995
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
1044
996
  },
1045
- response:
1046
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
997
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
1047
998
  errors: [
1048
999
  {
1049
1000
  status: 400,
@@ -1061,13 +1012,13 @@ export const getUsersAvatarHeadshot = endpoint({
1061
1012
  * @param outfitId CSV for the userIds to get user outfits
1062
1013
  */
1063
1014
  export const getUsersOutfit3d = endpoint({
1064
- method: "GET",
1065
- path: "/v1/users/outfit-3d",
1066
- baseUrl: "https://thumbnails.roblox.com",
1067
- requestFormat: "json",
1015
+ method: 'GET',
1016
+ path: '/v1/users/outfit-3d',
1017
+ baseUrl: 'https://thumbnails.roblox.com',
1018
+ requestFormat: 'json',
1068
1019
  serializationMethod: {
1069
1020
  outfitId: {
1070
- style: "form",
1021
+ style: 'form',
1071
1022
  explode: true,
1072
1023
  },
1073
1024
  },
@@ -1081,40 +1032,45 @@ export const getUsersOutfit3d = endpoint({
1081
1032
  * @api GET https://thumbnails.roblox.com/v1/users/outfits
1082
1033
  * @summary Get outfits for the given CSV of userOutfitIds
1083
1034
  * @param userOutfitIds CSV for the userOutfitIds to get user outfits
1035
+ * @param includeBackground Whether to include a background in the thumbnail (defaults to false)
1084
1036
  * @param size The thumbnail size, formatted widthxheight
1085
1037
  * @param format The thumbnail format
1086
1038
  * @param isCircular The circle thumbnail output parameter, true or false
1087
1039
  */
1088
1040
  export const getUsersOutfits = endpoint({
1089
- method: "GET",
1090
- path: "/v1/users/outfits",
1091
- baseUrl: "https://thumbnails.roblox.com",
1092
- requestFormat: "json",
1041
+ method: 'GET',
1042
+ path: '/v1/users/outfits',
1043
+ baseUrl: 'https://thumbnails.roblox.com',
1044
+ requestFormat: 'json',
1093
1045
  serializationMethod: {
1094
1046
  userOutfitIds: {
1095
- style: "form",
1047
+ style: 'form',
1048
+ },
1049
+ includeBackground: {
1050
+ style: 'form',
1051
+ explode: true,
1096
1052
  },
1097
1053
  size: {
1098
- style: "form",
1054
+ style: 'form',
1099
1055
  explode: true,
1100
1056
  },
1101
1057
  format: {
1102
- style: "form",
1058
+ style: 'form',
1103
1059
  explode: true,
1104
1060
  },
1105
1061
  isCircular: {
1106
- style: "form",
1062
+ style: 'form',
1107
1063
  explode: true,
1108
1064
  },
1109
1065
  },
1110
1066
  parameters: {
1111
1067
  userOutfitIds: z.array(z.number()),
1112
- size: z.enum(["150x150", "420x420"]).optional().default("150x150"),
1113
- format: z.enum(["Png", "Webp"]).optional().default("Png"),
1068
+ includeBackground: z.boolean().optional(),
1069
+ size: z.enum(['150x150', '420x420']).optional().default('150x150'),
1070
+ format: z.enum(['Png', 'Webp']).optional().default('Png'),
1114
1071
  isCircular: z.union([z.literal(true), z.literal(false)]).optional(),
1115
1072
  },
1116
- response:
1117
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
1073
+ response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Web_Responses_Thumbnails_ThumbnailResponse_,
1118
1074
  errors: [
1119
1075
  {
1120
1076
  status: 400,