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,33 +1,34 @@
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_Assets_IAssetItemError = z.object({
5
5
  Code: z.number().int(),
6
6
  Message: z.string(),
7
7
  CustomErrorCode: z.enum([
8
- "UnknownError",
9
- "NoPermissionToAsset",
10
- "AssetPermissionCheckFailed",
11
- "NotAuthorizedForAgeRecommendation",
12
- "AgeRecommendationCheckFailed",
13
- "InvalidPlaceRequestFromGameServer",
14
- "BlockedAssetTypeRequestedFromInsertService",
15
- "BlockedAssetTypeRequestedFromGameServer",
16
- "AssetTypeMismatch",
17
- "MissingAssetTypeInRequestHeader",
18
- "AssetNotTrustedForPlace",
19
- "NoAuthentication",
20
- "AssetContentRepresentationBlockedDueToModeration",
21
- "AssetNotFound",
22
- "AssetVersionNotFound",
23
- "AssetContentRepresentationNotFound",
24
- "BlockedByAgeGeoRestriction",
25
- "BlockedAssetTypeRequestedFromNonGameServer",
26
- "AssetPendingReview",
27
- "NotApprovedForRequestor",
28
- "NotApprovedByContentCompliance",
29
- "AssetContentRepresentationGenerating",
30
- "AssetArchived",
8
+ 'UnknownError',
9
+ 'NoPermissionToAsset',
10
+ 'AssetPermissionCheckFailed',
11
+ 'NotAuthorizedForAgeRecommendation',
12
+ 'AgeRecommendationCheckFailed',
13
+ 'InvalidPlaceRequestFromGameServer',
14
+ 'BlockedAssetTypeRequestedFromInsertService',
15
+ 'BlockedAssetTypeRequestedFromGameServer',
16
+ 'AssetTypeMismatch',
17
+ 'MissingAssetTypeInRequestHeader',
18
+ 'AssetNotTrustedForPlace',
19
+ 'NoAuthentication',
20
+ 'AssetContentRepresentationBlockedDueToModeration',
21
+ 'AssetNotFound',
22
+ 'AssetVersionNotFound',
23
+ 'AssetContentRepresentationNotFound',
24
+ 'BlockedByAgeGeoRestriction',
25
+ 'BlockedAssetTypeRequestedFromNonGameServer',
26
+ 'AssetPendingReview',
27
+ 'NotApprovedForRequestor',
28
+ 'NotApprovedByContentCompliance',
29
+ 'AssetContentRepresentationGenerating',
30
+ 'AssetArchived',
31
+ 'AssetUsageNotAllowed',
31
32
  ]),
32
33
  });
33
34
  const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
@@ -37,7 +38,7 @@ const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
37
38
  skipGenerationIfNotExist: z.boolean(),
38
39
  });
39
40
  const Roblox_AssetDelivery_Api_AssetMetadata = z.object({
40
- metadataType: z.literal("UncompressedSize"),
41
+ metadataType: z.literal('UncompressedSize'),
41
42
  value: z.string(),
42
43
  });
43
44
  const Roblox_Web_Assets_AssetResponseItemV1 = z.object({
@@ -46,8 +47,7 @@ const Roblox_Web_Assets_AssetResponseItemV1 = z.object({
46
47
  requestId: z.string(),
47
48
  isArchived: z.boolean(),
48
49
  assetTypeId: z.number().int(),
49
- contentRepresentationSpecifier:
50
- Roblox_Web_Assets_AssetContentRepresentationSpecifier,
50
+ contentRepresentationSpecifier: Roblox_Web_Assets_AssetContentRepresentationSpecifier,
51
51
  assetMetadatas: z.array(Roblox_AssetDelivery_Api_AssetMetadata),
52
52
  isRecordable: z.boolean(),
53
53
  });
@@ -69,9 +69,10 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
69
69
  assetVersionId: z.number().int(),
70
70
  modulePlaceId: z.number().int(),
71
71
  assetFormat: z.string(),
72
- "roblox-assetFormat": z.string(),
72
+ 'roblox-assetFormat': z.string(),
73
73
  assetResolutionMode: z.string(),
74
74
  accessContext: z.string(),
75
+ usageContext: z.number().int(),
75
76
  contentRepresentationPriorityList: z.string(),
76
77
  doNotFallbackToBaselineRepresentation: z.boolean(),
77
78
  });
@@ -93,71 +94,76 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
93
94
  * @param serverplaceid
94
95
  * @param expectedAssetType
95
96
  * @param accessContext
97
+ * @param usageContext
96
98
  */
97
99
  export const getAliasAlias = endpoint({
98
- method: "GET",
99
- path: "/v1/alias/:alias",
100
- baseUrl: "https://assetdelivery.roblox.com",
101
- requestFormat: "json",
100
+ method: 'GET',
101
+ path: '/v1/alias/:alias',
102
+ baseUrl: 'https://assetdelivery.roblox.com',
103
+ requestFormat: 'json',
102
104
  serializationMethod: {
103
105
  alias: {
104
- style: "simple",
106
+ style: 'simple',
105
107
  },
106
- "Accept-Encoding": {
107
- style: "simple",
108
+ 'Accept-Encoding': {
109
+ style: 'simple',
108
110
  },
109
- "Roblox-Place-Id": {
110
- style: "simple",
111
+ 'Roblox-Place-Id': {
112
+ style: 'simple',
111
113
  },
112
114
  AssetType: {
113
- style: "simple",
115
+ style: 'simple',
114
116
  },
115
117
  Accept: {
116
- style: "simple",
118
+ style: 'simple',
117
119
  },
118
120
  AssetFormat: {
119
- style: "simple",
121
+ style: 'simple',
120
122
  },
121
- "Roblox-AssetFormat": {
122
- style: "simple",
123
+ 'Roblox-AssetFormat': {
124
+ style: 'simple',
123
125
  },
124
126
  skipSigningScripts: {
125
- style: "form",
127
+ style: 'form',
126
128
  explode: true,
127
129
  },
128
130
  clientInsert: {
129
- style: "form",
131
+ style: 'form',
130
132
  explode: true,
131
133
  },
132
134
  scriptinsert: {
133
- style: "form",
135
+ style: 'form',
134
136
  explode: true,
135
137
  },
136
138
  modulePlaceId: {
137
- style: "form",
139
+ style: 'form',
138
140
  explode: true,
139
141
  },
140
142
  serverplaceid: {
141
- style: "form",
143
+ style: 'form',
142
144
  explode: true,
143
145
  },
144
146
  expectedAssetType: {
145
- style: "form",
147
+ style: 'form',
146
148
  explode: true,
147
149
  },
148
150
  accessContext: {
149
- style: "form",
151
+ style: 'form',
152
+ explode: true,
153
+ },
154
+ usageContext: {
155
+ style: 'form',
150
156
  explode: true,
151
157
  },
152
158
  },
153
159
  parameters: {
154
160
  alias: z.string().regex(/^[0-9]+\/.+/),
155
- "Accept-Encoding": z.string(),
156
- "Roblox-Place-Id": z.number().int(),
161
+ 'Accept-Encoding': z.string(),
162
+ 'Roblox-Place-Id': z.number().int(),
157
163
  AssetType: z.string(),
158
164
  Accept: z.string(),
159
165
  AssetFormat: z.string(),
160
- "Roblox-AssetFormat": z.string(),
166
+ 'Roblox-AssetFormat': z.string(),
161
167
  skipSigningScripts: z.boolean().optional(),
162
168
  clientInsert: z.number().int().optional(),
163
169
  scriptinsert: z.number().int().optional(),
@@ -165,6 +171,7 @@ export const getAliasAlias = endpoint({
165
171
  serverplaceid: z.number().int().optional(),
166
172
  expectedAssetType: z.string().optional(),
167
173
  accessContext: z.string().optional(),
174
+ usageContext: z.number().int().optional(),
168
175
  },
169
176
  response: Roblox_Web_Assets_AssetResponseItemV1,
170
177
  errors: [],
@@ -197,119 +204,124 @@ export const getAliasAlias = endpoint({
197
204
  * @param contentRepresentationPriorityList
198
205
  * @param assetResolutionMode
199
206
  * @param accessContext
207
+ * @param usageContext
200
208
  */
201
209
  export const getAsset = endpoint({
202
- method: "GET",
203
- path: "/v1/asset",
204
- baseUrl: "https://assetdelivery.roblox.com",
205
- requestFormat: "json",
210
+ method: 'GET',
211
+ path: '/v1/asset',
212
+ baseUrl: 'https://assetdelivery.roblox.com',
213
+ requestFormat: 'json',
206
214
  serializationMethod: {
207
- "Accept-Encoding": {
208
- style: "simple",
215
+ 'Accept-Encoding': {
216
+ style: 'simple',
209
217
  },
210
- "Roblox-Place-Id": {
211
- style: "simple",
218
+ 'Roblox-Place-Id': {
219
+ style: 'simple',
212
220
  },
213
221
  AssetType: {
214
- style: "simple",
222
+ style: 'simple',
215
223
  },
216
224
  Accept: {
217
- style: "simple",
225
+ style: 'simple',
218
226
  },
219
227
  AssetFormat: {
220
- style: "simple",
228
+ style: 'simple',
221
229
  },
222
- "Roblox-AssetFormat": {
223
- style: "simple",
230
+ 'Roblox-AssetFormat': {
231
+ style: 'simple',
224
232
  },
225
233
  id: {
226
- style: "form",
234
+ style: 'form',
227
235
  explode: true,
228
236
  },
229
237
  userAssetId: {
230
- style: "form",
238
+ style: 'form',
231
239
  explode: true,
232
240
  },
233
241
  assetVersionId: {
234
- style: "form",
242
+ style: 'form',
235
243
  explode: true,
236
244
  },
237
245
  version: {
238
- style: "form",
246
+ style: 'form',
239
247
  explode: true,
240
248
  },
241
249
  universeId: {
242
- style: "form",
250
+ style: 'form',
243
251
  explode: true,
244
252
  },
245
253
  clientInsert: {
246
- style: "form",
254
+ style: 'form',
247
255
  explode: true,
248
256
  },
249
257
  scriptinsert: {
250
- style: "form",
258
+ style: 'form',
251
259
  explode: true,
252
260
  },
253
261
  modulePlaceId: {
254
- style: "form",
262
+ style: 'form',
255
263
  explode: true,
256
264
  },
257
265
  serverplaceid: {
258
- style: "form",
266
+ style: 'form',
259
267
  explode: true,
260
268
  },
261
269
  assetName: {
262
- style: "form",
270
+ style: 'form',
263
271
  explode: true,
264
272
  },
265
273
  hash: {
266
- style: "form",
274
+ style: 'form',
267
275
  explode: true,
268
276
  },
269
277
  marAssetHash: {
270
- style: "form",
278
+ style: 'form',
271
279
  explode: true,
272
280
  },
273
281
  marCheckSum: {
274
- style: "form",
282
+ style: 'form',
275
283
  explode: true,
276
284
  },
277
285
  expectedAssetType: {
278
- style: "form",
286
+ style: 'form',
279
287
  explode: true,
280
288
  },
281
289
  skipSigningScripts: {
282
- style: "form",
290
+ style: 'form',
283
291
  explode: true,
284
292
  },
285
293
  permissionContext: {
286
- style: "form",
294
+ style: 'form',
287
295
  explode: true,
288
296
  },
289
297
  doNotFallbackToBaselineRepresentation: {
290
- style: "form",
298
+ style: 'form',
291
299
  explode: true,
292
300
  },
293
301
  contentRepresentationPriorityList: {
294
- style: "form",
302
+ style: 'form',
295
303
  explode: true,
296
304
  },
297
305
  assetResolutionMode: {
298
- style: "form",
306
+ style: 'form',
299
307
  explode: true,
300
308
  },
301
309
  accessContext: {
302
- style: "form",
310
+ style: 'form',
311
+ explode: true,
312
+ },
313
+ usageContext: {
314
+ style: 'form',
303
315
  explode: true,
304
316
  },
305
317
  },
306
318
  parameters: {
307
- "Accept-Encoding": z.string(),
308
- "Roblox-Place-Id": z.number().int(),
319
+ 'Accept-Encoding': z.string(),
320
+ 'Roblox-Place-Id': z.number().int(),
309
321
  AssetType: z.string(),
310
322
  Accept: z.string(),
311
323
  AssetFormat: z.string(),
312
- "Roblox-AssetFormat": z.string(),
324
+ 'Roblox-AssetFormat': z.string(),
313
325
  id: z.number().int().optional(),
314
326
  userAssetId: z.number().int().optional(),
315
327
  assetVersionId: z.number().int().optional(),
@@ -330,6 +342,7 @@ export const getAsset = endpoint({
330
342
  contentRepresentationPriorityList: z.string().optional(),
331
343
  assetResolutionMode: z.string().optional(),
332
344
  accessContext: z.string().optional(),
345
+ usageContext: z.number().int().optional(),
333
346
  },
334
347
  response: z.void(),
335
348
  errors: [],
@@ -353,79 +366,84 @@ export const getAsset = endpoint({
353
366
  * @param doNotFallbackToBaselineRepresentation
354
367
  * @param contentRepresentationPriorityList
355
368
  * @param accessContext
369
+ * @param usageContext
356
370
  */
357
371
  export const getAssetidAssetid = endpoint({
358
- method: "GET",
359
- path: "/v1/assetId/:assetId",
360
- baseUrl: "https://assetdelivery.roblox.com",
361
- requestFormat: "json",
372
+ method: 'GET',
373
+ path: '/v1/assetId/:assetId',
374
+ baseUrl: 'https://assetdelivery.roblox.com',
375
+ requestFormat: 'json',
362
376
  serializationMethod: {
363
377
  assetId: {
364
- style: "simple",
378
+ style: 'simple',
365
379
  },
366
- "Accept-Encoding": {
367
- style: "simple",
380
+ 'Accept-Encoding': {
381
+ style: 'simple',
368
382
  },
369
- "Roblox-Place-Id": {
370
- style: "simple",
383
+ 'Roblox-Place-Id': {
384
+ style: 'simple',
371
385
  },
372
386
  AssetType: {
373
- style: "simple",
387
+ style: 'simple',
374
388
  },
375
389
  Accept: {
376
- style: "simple",
390
+ style: 'simple',
377
391
  },
378
392
  AssetFormat: {
379
- style: "simple",
393
+ style: 'simple',
380
394
  },
381
- "Roblox-AssetFormat": {
382
- style: "simple",
395
+ 'Roblox-AssetFormat': {
396
+ style: 'simple',
383
397
  },
384
398
  skipSigningScripts: {
385
- style: "form",
399
+ style: 'form',
386
400
  explode: true,
387
401
  },
388
402
  clientInsert: {
389
- style: "form",
403
+ style: 'form',
390
404
  explode: true,
391
405
  },
392
406
  scriptinsert: {
393
- style: "form",
407
+ style: 'form',
394
408
  explode: true,
395
409
  },
396
410
  modulePlaceId: {
397
- style: "form",
411
+ style: 'form',
398
412
  explode: true,
399
413
  },
400
414
  serverplaceid: {
401
- style: "form",
415
+ style: 'form',
402
416
  explode: true,
403
417
  },
404
418
  expectedAssetType: {
405
- style: "form",
419
+ style: 'form',
406
420
  explode: true,
407
421
  },
408
422
  doNotFallbackToBaselineRepresentation: {
409
- style: "form",
423
+ style: 'form',
410
424
  explode: true,
411
425
  },
412
426
  contentRepresentationPriorityList: {
413
- style: "form",
427
+ style: 'form',
414
428
  explode: true,
415
429
  },
416
430
  accessContext: {
417
- style: "form",
431
+ style: 'form',
432
+ explode: true,
433
+ },
434
+ usageContext: {
435
+ style: 'form',
418
436
  explode: true,
419
437
  },
420
438
  },
421
439
  parameters: {
422
440
  assetId: z.number().int(),
423
- "Accept-Encoding": z.string(),
424
- "Roblox-Place-Id": z.number().int(),
441
+ 'Accept-Encoding': z.string(),
442
+ 'Roblox-Place-Id': z.number().int(),
425
443
  AssetType: z.string(),
426
444
  Accept: z.string(),
427
445
  AssetFormat: z.string(),
428
- "Roblox-AssetFormat": z.string(),
446
+ 'Roblox-AssetFormat': z.string(),
429
447
  skipSigningScripts: z.boolean().optional(),
430
448
  clientInsert: z.number().int().optional(),
431
449
  scriptinsert: z.number().int().optional(),
@@ -435,6 +453,7 @@ export const getAssetidAssetid = endpoint({
435
453
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
436
454
  contentRepresentationPriorityList: z.string().optional(),
437
455
  accessContext: z.string().optional(),
456
+ usageContext: z.number().int().optional(),
438
457
  },
439
458
  response: Roblox_Web_Assets_AssetResponseItemV1,
440
459
  errors: [],
@@ -459,83 +478,88 @@ export const getAssetidAssetid = endpoint({
459
478
  * @param doNotFallbackToBaselineRepresentation
460
479
  * @param contentRepresentationPriorityList
461
480
  * @param accessContext
481
+ * @param usageContext
462
482
  */
463
483
  export const getAssetidAssetidVersionVersionnumber = endpoint({
464
- method: "GET",
465
- path: "/v1/assetId/:assetId/version/:versionNumber",
466
- baseUrl: "https://assetdelivery.roblox.com",
467
- requestFormat: "json",
484
+ method: 'GET',
485
+ path: '/v1/assetId/:assetId/version/:versionNumber',
486
+ baseUrl: 'https://assetdelivery.roblox.com',
487
+ requestFormat: 'json',
468
488
  serializationMethod: {
469
489
  assetId: {
470
- style: "simple",
490
+ style: 'simple',
471
491
  },
472
492
  versionNumber: {
473
- style: "simple",
493
+ style: 'simple',
474
494
  },
475
- "Accept-Encoding": {
476
- style: "simple",
495
+ 'Accept-Encoding': {
496
+ style: 'simple',
477
497
  },
478
- "Roblox-Place-Id": {
479
- style: "simple",
498
+ 'Roblox-Place-Id': {
499
+ style: 'simple',
480
500
  },
481
501
  AssetType: {
482
- style: "simple",
502
+ style: 'simple',
483
503
  },
484
504
  Accept: {
485
- style: "simple",
505
+ style: 'simple',
486
506
  },
487
507
  AssetFormat: {
488
- style: "simple",
508
+ style: 'simple',
489
509
  },
490
- "Roblox-AssetFormat": {
491
- style: "simple",
510
+ 'Roblox-AssetFormat': {
511
+ style: 'simple',
492
512
  },
493
513
  skipSigningScripts: {
494
- style: "form",
514
+ style: 'form',
495
515
  explode: true,
496
516
  },
497
517
  clientInsert: {
498
- style: "form",
518
+ style: 'form',
499
519
  explode: true,
500
520
  },
501
521
  scriptinsert: {
502
- style: "form",
522
+ style: 'form',
503
523
  explode: true,
504
524
  },
505
525
  modulePlaceId: {
506
- style: "form",
526
+ style: 'form',
507
527
  explode: true,
508
528
  },
509
529
  serverplaceid: {
510
- style: "form",
530
+ style: 'form',
511
531
  explode: true,
512
532
  },
513
533
  expectedAssetType: {
514
- style: "form",
534
+ style: 'form',
515
535
  explode: true,
516
536
  },
517
537
  doNotFallbackToBaselineRepresentation: {
518
- style: "form",
538
+ style: 'form',
519
539
  explode: true,
520
540
  },
521
541
  contentRepresentationPriorityList: {
522
- style: "form",
542
+ style: 'form',
523
543
  explode: true,
524
544
  },
525
545
  accessContext: {
526
- style: "form",
546
+ style: 'form',
547
+ explode: true,
548
+ },
549
+ usageContext: {
550
+ style: 'form',
527
551
  explode: true,
528
552
  },
529
553
  },
530
554
  parameters: {
531
555
  assetId: z.number().int(),
532
556
  versionNumber: z.number().int(),
533
- "Accept-Encoding": z.string(),
534
- "Roblox-Place-Id": z.number().int(),
557
+ 'Accept-Encoding': z.string(),
558
+ 'Roblox-Place-Id': z.number().int(),
535
559
  AssetType: z.string(),
536
560
  Accept: z.string(),
537
561
  AssetFormat: z.string(),
538
- "Roblox-AssetFormat": z.string(),
562
+ 'Roblox-AssetFormat': z.string(),
539
563
  skipSigningScripts: z.boolean().optional(),
540
564
  clientInsert: z.number().int().optional(),
541
565
  scriptinsert: z.number().int().optional(),
@@ -545,6 +569,7 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
545
569
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
546
570
  contentRepresentationPriorityList: z.string().optional(),
547
571
  accessContext: z.string().optional(),
572
+ usageContext: z.number().int().optional(),
548
573
  },
549
574
  response: Roblox_Web_Assets_AssetResponseItemV1,
550
575
  errors: [],
@@ -557,26 +582,26 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
557
582
  * @param Roblox-Browser-Asset-Request
558
583
  */
559
584
  export const postAssetsBatch = endpoint({
560
- method: "POST",
561
- path: "/v1/assets/batch",
562
- baseUrl: "https://assetdelivery.roblox.com",
563
- requestFormat: "json",
585
+ method: 'POST',
586
+ path: '/v1/assets/batch',
587
+ baseUrl: 'https://assetdelivery.roblox.com',
588
+ requestFormat: 'json',
564
589
  serializationMethod: {
565
590
  body: {},
566
- "Roblox-Place-Id": {
567
- style: "simple",
591
+ 'Roblox-Place-Id': {
592
+ style: 'simple',
568
593
  },
569
594
  Accept: {
570
- style: "simple",
595
+ style: 'simple',
571
596
  },
572
- "Roblox-Browser-Asset-Request": {
573
- style: "simple",
597
+ 'Roblox-Browser-Asset-Request': {
598
+ style: 'simple',
574
599
  },
575
600
  },
576
601
  parameters: {
577
- "Roblox-Place-Id": z.number().int(),
602
+ 'Roblox-Place-Id': z.number().int(),
578
603
  Accept: z.string(),
579
- "Roblox-Browser-Asset-Request": z.string(),
604
+ 'Roblox-Browser-Asset-Request': z.string(),
580
605
  },
581
606
  body: z.array(Roblox_Web_Assets_BatchAssetRequestItem),
582
607
  response: z.array(Roblox_Web_Assets_AssetResponseItemV1),
@@ -601,69 +626,69 @@ export const postAssetsBatch = endpoint({
601
626
  * @param expectedAssetType
602
627
  */
603
628
  export const getMarassethashMarassethashMarchecksumMarchecksum = endpoint({
604
- method: "GET",
605
- path: "/v1/marAssetHash/:marAssetHash/marCheckSum/:marCheckSum",
606
- baseUrl: "https://assetdelivery.roblox.com",
607
- requestFormat: "json",
629
+ method: 'GET',
630
+ path: '/v1/marAssetHash/:marAssetHash/marCheckSum/:marCheckSum',
631
+ baseUrl: 'https://assetdelivery.roblox.com',
632
+ requestFormat: 'json',
608
633
  serializationMethod: {
609
634
  marAssetHash: {
610
- style: "simple",
635
+ style: 'simple',
611
636
  },
612
637
  marCheckSum: {
613
- style: "simple",
638
+ style: 'simple',
614
639
  },
615
- "Accept-Encoding": {
616
- style: "simple",
640
+ 'Accept-Encoding': {
641
+ style: 'simple',
617
642
  },
618
- "Roblox-Place-Id": {
619
- style: "simple",
643
+ 'Roblox-Place-Id': {
644
+ style: 'simple',
620
645
  },
621
646
  AssetType: {
622
- style: "simple",
647
+ style: 'simple',
623
648
  },
624
649
  Accept: {
625
- style: "simple",
650
+ style: 'simple',
626
651
  },
627
652
  AssetFormat: {
628
- style: "simple",
653
+ style: 'simple',
629
654
  },
630
- "Roblox-AssetFormat": {
631
- style: "simple",
655
+ 'Roblox-AssetFormat': {
656
+ style: 'simple',
632
657
  },
633
658
  skipSigningScripts: {
634
- style: "form",
659
+ style: 'form',
635
660
  explode: true,
636
661
  },
637
662
  clientInsert: {
638
- style: "form",
663
+ style: 'form',
639
664
  explode: true,
640
665
  },
641
666
  scriptinsert: {
642
- style: "form",
667
+ style: 'form',
643
668
  explode: true,
644
669
  },
645
670
  modulePlaceId: {
646
- style: "form",
671
+ style: 'form',
647
672
  explode: true,
648
673
  },
649
674
  serverplaceid: {
650
- style: "form",
675
+ style: 'form',
651
676
  explode: true,
652
677
  },
653
678
  expectedAssetType: {
654
- style: "form",
679
+ style: 'form',
655
680
  explode: true,
656
681
  },
657
682
  },
658
683
  parameters: {
659
684
  marAssetHash: z.string(),
660
685
  marCheckSum: z.string(),
661
- "Accept-Encoding": z.string(),
662
- "Roblox-Place-Id": z.number().int(),
686
+ 'Accept-Encoding': z.string(),
687
+ 'Roblox-Place-Id': z.number().int(),
663
688
  AssetType: z.string(),
664
689
  Accept: z.string(),
665
690
  AssetFormat: z.string(),
666
- "Roblox-AssetFormat": z.string(),
691
+ 'Roblox-AssetFormat': z.string(),
667
692
  skipSigningScripts: z.boolean().optional(),
668
693
  clientInsert: z.number().int().optional(),
669
694
  scriptinsert: z.number().int().optional(),
@@ -703,6 +728,7 @@ export const getMarassethashMarassethashMarchecksumMarchecksum = endpoint({
703
728
  * @param doNotFallbackToBaselineRepresentation Whether to prevent fallback to baseline representation when specific content representations are not available.
704
729
  * @param contentRepresentationPriorityList Base64URL-encoded JSON string specifying the priority list of desired content representations (format, version, fidelity).
705
730
  * @param accessContext
731
+ * @param usageContext
706
732
  * @description Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported.
707
733
  You should request that URL with the `Accept-Encoding: gzip` header and decompress the result if the response is gzipped. If you are using cURL, the `--compressed` flag will automate these steps for you.
708
734
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`.
@@ -710,77 +736,81 @@ While you are able to make requests to this endpoint with Cookie authentication
710
736
  Expect unannounced removal of this second route in the future.
711
737
  */
712
738
  export const getOpencloudAssetidAssetid = endpoint({
713
- method: "GET",
714
- path: "/v1/openCloud/assetId/:assetId",
715
- baseUrl: "https://assetdelivery.roblox.com",
716
- requestFormat: "json",
739
+ method: 'GET',
740
+ path: '/v1/openCloud/assetId/:assetId',
741
+ baseUrl: 'https://assetdelivery.roblox.com',
742
+ requestFormat: 'json',
717
743
  serializationMethod: {
718
744
  assetId: {
719
- style: "simple",
745
+ style: 'simple',
720
746
  },
721
- "Accept-Encoding": {
722
- style: "simple",
747
+ 'Accept-Encoding': {
748
+ style: 'simple',
723
749
  },
724
- "Roblox-Place-Id": {
725
- style: "simple",
750
+ 'Roblox-Place-Id': {
751
+ style: 'simple',
726
752
  },
727
753
  AssetType: {
728
- style: "simple",
754
+ style: 'simple',
729
755
  },
730
756
  Accept: {
731
- style: "simple",
757
+ style: 'simple',
732
758
  },
733
759
  AssetFormat: {
734
- style: "simple",
760
+ style: 'simple',
735
761
  },
736
- "Roblox-AssetFormat": {
737
- style: "simple",
762
+ 'Roblox-AssetFormat': {
763
+ style: 'simple',
738
764
  },
739
765
  skipSigningScripts: {
740
- style: "form",
766
+ style: 'form',
741
767
  explode: true,
742
768
  },
743
769
  clientInsert: {
744
- style: "form",
770
+ style: 'form',
745
771
  explode: true,
746
772
  },
747
773
  scriptinsert: {
748
- style: "form",
774
+ style: 'form',
749
775
  explode: true,
750
776
  },
751
777
  modulePlaceId: {
752
- style: "form",
778
+ style: 'form',
753
779
  explode: true,
754
780
  },
755
781
  serverplaceid: {
756
- style: "form",
782
+ style: 'form',
757
783
  explode: true,
758
784
  },
759
785
  expectedAssetType: {
760
- style: "form",
786
+ style: 'form',
761
787
  explode: true,
762
788
  },
763
789
  doNotFallbackToBaselineRepresentation: {
764
- style: "form",
790
+ style: 'form',
765
791
  explode: true,
766
792
  },
767
793
  contentRepresentationPriorityList: {
768
- style: "form",
794
+ style: 'form',
769
795
  explode: true,
770
796
  },
771
797
  accessContext: {
772
- style: "form",
798
+ style: 'form',
799
+ explode: true,
800
+ },
801
+ usageContext: {
802
+ style: 'form',
773
803
  explode: true,
774
804
  },
775
805
  },
776
806
  parameters: {
777
807
  assetId: z.number().int(),
778
- "Accept-Encoding": z.string().optional(),
779
- "Roblox-Place-Id": z.number().int().optional(),
808
+ 'Accept-Encoding': z.string().optional(),
809
+ 'Roblox-Place-Id': z.number().int().optional(),
780
810
  AssetType: z.string().optional(),
781
811
  Accept: z.string().optional(),
782
812
  AssetFormat: z.string().optional(),
783
- "Roblox-AssetFormat": z.string().optional(),
813
+ 'Roblox-AssetFormat': z.string().optional(),
784
814
  skipSigningScripts: z.boolean().optional(),
785
815
  clientInsert: z.number().int().optional(),
786
816
  scriptinsert: z.number().int().optional(),
@@ -790,6 +820,7 @@ export const getOpencloudAssetidAssetid = endpoint({
790
820
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
791
821
  contentRepresentationPriorityList: z.string().optional(),
792
822
  accessContext: z.string().optional(),
823
+ usageContext: z.number().int().optional(),
793
824
  },
794
825
  response: Roblox_Web_Assets_AssetResponseItemV1,
795
826
  errors: [
@@ -819,87 +850,92 @@ export const getOpencloudAssetidAssetid = endpoint({
819
850
  * @param doNotFallbackToBaselineRepresentation
820
851
  * @param contentRepresentationPriorityList
821
852
  * @param accessContext
853
+ * @param usageContext
822
854
  * @description Refer to the assetId endpoint for details on usage.
823
855
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`.
824
856
  While you are able to make requests to this endpoint with Cookie authentication via `assetdelivery.roblox.com/v1/openCloud/assetId/{assetId}/version/{versionNumber}`, we highly discourage use this way.
825
857
  Expect unannounced removal of this second route in the future.
826
858
  */
827
859
  export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
828
- method: "GET",
829
- path: "/v1/openCloud/assetId/:assetId/version/:versionNumber",
830
- baseUrl: "https://assetdelivery.roblox.com",
831
- requestFormat: "json",
860
+ method: 'GET',
861
+ path: '/v1/openCloud/assetId/:assetId/version/:versionNumber',
862
+ baseUrl: 'https://assetdelivery.roblox.com',
863
+ requestFormat: 'json',
832
864
  serializationMethod: {
833
865
  assetId: {
834
- style: "simple",
866
+ style: 'simple',
835
867
  },
836
868
  versionNumber: {
837
- style: "simple",
869
+ style: 'simple',
838
870
  },
839
- "Accept-Encoding": {
840
- style: "simple",
871
+ 'Accept-Encoding': {
872
+ style: 'simple',
841
873
  },
842
- "Roblox-Place-Id": {
843
- style: "simple",
874
+ 'Roblox-Place-Id': {
875
+ style: 'simple',
844
876
  },
845
877
  AssetType: {
846
- style: "simple",
878
+ style: 'simple',
847
879
  },
848
880
  Accept: {
849
- style: "simple",
881
+ style: 'simple',
850
882
  },
851
883
  AssetFormat: {
852
- style: "simple",
884
+ style: 'simple',
853
885
  },
854
- "Roblox-AssetFormat": {
855
- style: "simple",
886
+ 'Roblox-AssetFormat': {
887
+ style: 'simple',
856
888
  },
857
889
  skipSigningScripts: {
858
- style: "form",
890
+ style: 'form',
859
891
  explode: true,
860
892
  },
861
893
  clientInsert: {
862
- style: "form",
894
+ style: 'form',
863
895
  explode: true,
864
896
  },
865
897
  scriptinsert: {
866
- style: "form",
898
+ style: 'form',
867
899
  explode: true,
868
900
  },
869
901
  modulePlaceId: {
870
- style: "form",
902
+ style: 'form',
871
903
  explode: true,
872
904
  },
873
905
  serverplaceid: {
874
- style: "form",
906
+ style: 'form',
875
907
  explode: true,
876
908
  },
877
909
  expectedAssetType: {
878
- style: "form",
910
+ style: 'form',
879
911
  explode: true,
880
912
  },
881
913
  doNotFallbackToBaselineRepresentation: {
882
- style: "form",
914
+ style: 'form',
883
915
  explode: true,
884
916
  },
885
917
  contentRepresentationPriorityList: {
886
- style: "form",
918
+ style: 'form',
887
919
  explode: true,
888
920
  },
889
921
  accessContext: {
890
- style: "form",
922
+ style: 'form',
923
+ explode: true,
924
+ },
925
+ usageContext: {
926
+ style: 'form',
891
927
  explode: true,
892
928
  },
893
929
  },
894
930
  parameters: {
895
931
  assetId: z.number().int(),
896
932
  versionNumber: z.number().int(),
897
- "Accept-Encoding": z.string().optional(),
898
- "Roblox-Place-Id": z.number().int().optional(),
933
+ 'Accept-Encoding': z.string().optional(),
934
+ 'Roblox-Place-Id': z.number().int().optional(),
899
935
  AssetType: z.string().optional(),
900
936
  Accept: z.string().optional(),
901
937
  AssetFormat: z.string().optional(),
902
- "Roblox-AssetFormat": z.string().optional(),
938
+ 'Roblox-AssetFormat': z.string().optional(),
903
939
  skipSigningScripts: z.boolean().optional(),
904
940
  clientInsert: z.number().int().optional(),
905
941
  scriptinsert: z.number().int().optional(),
@@ -909,6 +945,7 @@ export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
909
945
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
910
946
  contentRepresentationPriorityList: z.string().optional(),
911
947
  accessContext: z.string().optional(),
948
+ usageContext: z.number().int().optional(),
912
949
  },
913
950
  response: Roblox_Web_Assets_AssetResponseItemV1,
914
951
  errors: [