rozod 6.7.1 → 6.8.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/assetdeliveryv1.d.ts +38 -0
- package/lib/endpoints/assetdeliveryv1.js +38 -0
- package/lib/endpoints/assetdeliveryv2.d.ts +26 -0
- package/lib/endpoints/assetdeliveryv2.js +26 -0
- package/lib/endpoints/authv1.d.ts +7 -2
- package/lib/endpoints/authv1.js +3 -1
- package/lib/endpoints/authv2.d.ts +1 -1
- package/lib/endpoints/authv2.js +1 -1
- package/lib/endpoints/badgesv1.d.ts +4 -0
- package/lib/endpoints/badgesv1.js +4 -0
- package/lib/endpoints/catalogv1.d.ts +2 -1
- package/lib/endpoints/catalogv1.js +2 -1
- package/lib/endpoints/catalogv2.d.ts +53 -45
- package/lib/endpoints/catalogv2.js +21 -17
- package/lib/endpoints/chatv2.d.ts +778 -778
- package/lib/endpoints/developv1.d.ts +3 -0
- package/lib/endpoints/developv1.js +3 -0
- package/lib/endpoints/developv2.d.ts +3 -1
- package/lib/endpoints/developv2.js +3 -1
- package/lib/endpoints/friendsv1.d.ts +222 -314
- package/lib/endpoints/friendsv1.js +213 -313
- package/lib/endpoints/gamejoinv1.d.ts +458 -458
- package/lib/endpoints/gamesv1.d.ts +2 -0
- package/lib/endpoints/gamesv1.js +2 -0
- package/lib/endpoints/gamesv2.d.ts +11 -0
- package/lib/endpoints/gamesv2.js +9 -0
- package/lib/endpoints/groupsv1.d.ts +42 -1
- package/lib/endpoints/groupsv1.js +48 -4
- package/lib/endpoints/groupsv2.d.ts +1 -0
- package/lib/endpoints/groupsv2.js +1 -0
- package/lib/endpoints/inventoryv1.d.ts +3 -1
- package/lib/endpoints/inventoryv1.js +3 -1
- package/lib/endpoints/inventoryv2.d.ts +2 -0
- package/lib/endpoints/inventoryv2.js +2 -0
- package/lib/endpoints/metricsv1.d.ts +88 -88
- package/lib/endpoints/thumbnailsv1.d.ts +44 -87
- package/lib/endpoints/thumbnailsv1.js +25 -0
- package/lib/index.d.ts +96 -3
- package/lib/index.js +114 -1
- 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 +1 -1
|
@@ -28,6 +28,7 @@ const Roblox_Web_Assets_IAssetItemError = z.object({
|
|
|
28
28
|
"NotApprovedByContentCompliance",
|
|
29
29
|
"AssetContentRepresentationGenerating",
|
|
30
30
|
"AssetArchived",
|
|
31
|
+
"AssetUsageNotAllowed",
|
|
31
32
|
]),
|
|
32
33
|
});
|
|
33
34
|
const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
|
|
@@ -72,6 +73,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
|
|
|
72
73
|
"roblox-assetFormat": z.string(),
|
|
73
74
|
assetResolutionMode: z.string(),
|
|
74
75
|
accessContext: z.string(),
|
|
76
|
+
usageContext: z.number().int(),
|
|
75
77
|
contentRepresentationPriorityList: z.string(),
|
|
76
78
|
doNotFallbackToBaselineRepresentation: z.boolean(),
|
|
77
79
|
});
|
|
@@ -93,6 +95,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
|
|
|
93
95
|
* @param serverplaceid
|
|
94
96
|
* @param expectedAssetType
|
|
95
97
|
* @param accessContext
|
|
98
|
+
* @param usageContext
|
|
96
99
|
*/
|
|
97
100
|
export const getAliasAlias = endpoint({
|
|
98
101
|
method: "GET",
|
|
@@ -149,6 +152,10 @@ export const getAliasAlias = endpoint({
|
|
|
149
152
|
style: "form",
|
|
150
153
|
explode: true,
|
|
151
154
|
},
|
|
155
|
+
usageContext: {
|
|
156
|
+
style: "form",
|
|
157
|
+
explode: true,
|
|
158
|
+
},
|
|
152
159
|
},
|
|
153
160
|
parameters: {
|
|
154
161
|
alias: z.string().regex(/^[0-9]+\/.+/),
|
|
@@ -165,6 +172,7 @@ export const getAliasAlias = endpoint({
|
|
|
165
172
|
serverplaceid: z.number().int().optional(),
|
|
166
173
|
expectedAssetType: z.string().optional(),
|
|
167
174
|
accessContext: z.string().optional(),
|
|
175
|
+
usageContext: z.number().int().optional(),
|
|
168
176
|
},
|
|
169
177
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
170
178
|
errors: [],
|
|
@@ -197,6 +205,7 @@ export const getAliasAlias = endpoint({
|
|
|
197
205
|
* @param contentRepresentationPriorityList
|
|
198
206
|
* @param assetResolutionMode
|
|
199
207
|
* @param accessContext
|
|
208
|
+
* @param usageContext
|
|
200
209
|
*/
|
|
201
210
|
export const getAsset = endpoint({
|
|
202
211
|
method: "GET",
|
|
@@ -302,6 +311,10 @@ export const getAsset = endpoint({
|
|
|
302
311
|
style: "form",
|
|
303
312
|
explode: true,
|
|
304
313
|
},
|
|
314
|
+
usageContext: {
|
|
315
|
+
style: "form",
|
|
316
|
+
explode: true,
|
|
317
|
+
},
|
|
305
318
|
},
|
|
306
319
|
parameters: {
|
|
307
320
|
"Accept-Encoding": z.string(),
|
|
@@ -330,6 +343,7 @@ export const getAsset = endpoint({
|
|
|
330
343
|
contentRepresentationPriorityList: z.string().optional(),
|
|
331
344
|
assetResolutionMode: z.string().optional(),
|
|
332
345
|
accessContext: z.string().optional(),
|
|
346
|
+
usageContext: z.number().int().optional(),
|
|
333
347
|
},
|
|
334
348
|
response: z.void(),
|
|
335
349
|
errors: [],
|
|
@@ -353,6 +367,7 @@ export const getAsset = endpoint({
|
|
|
353
367
|
* @param doNotFallbackToBaselineRepresentation
|
|
354
368
|
* @param contentRepresentationPriorityList
|
|
355
369
|
* @param accessContext
|
|
370
|
+
* @param usageContext
|
|
356
371
|
*/
|
|
357
372
|
export const getAssetidAssetid = endpoint({
|
|
358
373
|
method: "GET",
|
|
@@ -417,6 +432,10 @@ export const getAssetidAssetid = endpoint({
|
|
|
417
432
|
style: "form",
|
|
418
433
|
explode: true,
|
|
419
434
|
},
|
|
435
|
+
usageContext: {
|
|
436
|
+
style: "form",
|
|
437
|
+
explode: true,
|
|
438
|
+
},
|
|
420
439
|
},
|
|
421
440
|
parameters: {
|
|
422
441
|
assetId: z.number().int(),
|
|
@@ -435,6 +454,7 @@ export const getAssetidAssetid = endpoint({
|
|
|
435
454
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
436
455
|
contentRepresentationPriorityList: z.string().optional(),
|
|
437
456
|
accessContext: z.string().optional(),
|
|
457
|
+
usageContext: z.number().int().optional(),
|
|
438
458
|
},
|
|
439
459
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
440
460
|
errors: [],
|
|
@@ -459,6 +479,7 @@ export const getAssetidAssetid = endpoint({
|
|
|
459
479
|
* @param doNotFallbackToBaselineRepresentation
|
|
460
480
|
* @param contentRepresentationPriorityList
|
|
461
481
|
* @param accessContext
|
|
482
|
+
* @param usageContext
|
|
462
483
|
*/
|
|
463
484
|
export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
464
485
|
method: "GET",
|
|
@@ -526,6 +547,10 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
526
547
|
style: "form",
|
|
527
548
|
explode: true,
|
|
528
549
|
},
|
|
550
|
+
usageContext: {
|
|
551
|
+
style: "form",
|
|
552
|
+
explode: true,
|
|
553
|
+
},
|
|
529
554
|
},
|
|
530
555
|
parameters: {
|
|
531
556
|
assetId: z.number().int(),
|
|
@@ -545,6 +570,7 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
545
570
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
546
571
|
contentRepresentationPriorityList: z.string().optional(),
|
|
547
572
|
accessContext: z.string().optional(),
|
|
573
|
+
usageContext: z.number().int().optional(),
|
|
548
574
|
},
|
|
549
575
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
550
576
|
errors: [],
|
|
@@ -703,6 +729,7 @@ export const getMarassethashMarassethashMarchecksumMarchecksum = endpoint({
|
|
|
703
729
|
* @param doNotFallbackToBaselineRepresentation Whether to prevent fallback to baseline representation when specific content representations are not available.
|
|
704
730
|
* @param contentRepresentationPriorityList Base64URL-encoded JSON string specifying the priority list of desired content representations (format, version, fidelity).
|
|
705
731
|
* @param accessContext
|
|
732
|
+
* @param usageContext
|
|
706
733
|
* @description Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported.
|
|
707
734
|
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
735
|
This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`.
|
|
@@ -772,6 +799,10 @@ export const getOpencloudAssetidAssetid = endpoint({
|
|
|
772
799
|
style: "form",
|
|
773
800
|
explode: true,
|
|
774
801
|
},
|
|
802
|
+
usageContext: {
|
|
803
|
+
style: "form",
|
|
804
|
+
explode: true,
|
|
805
|
+
},
|
|
775
806
|
},
|
|
776
807
|
parameters: {
|
|
777
808
|
assetId: z.number().int(),
|
|
@@ -790,6 +821,7 @@ export const getOpencloudAssetidAssetid = endpoint({
|
|
|
790
821
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
791
822
|
contentRepresentationPriorityList: z.string().optional(),
|
|
792
823
|
accessContext: z.string().optional(),
|
|
824
|
+
usageContext: z.number().int().optional(),
|
|
793
825
|
},
|
|
794
826
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
795
827
|
errors: [
|
|
@@ -819,6 +851,7 @@ export const getOpencloudAssetidAssetid = endpoint({
|
|
|
819
851
|
* @param doNotFallbackToBaselineRepresentation
|
|
820
852
|
* @param contentRepresentationPriorityList
|
|
821
853
|
* @param accessContext
|
|
854
|
+
* @param usageContext
|
|
822
855
|
* @description Refer to the assetId endpoint for details on usage.
|
|
823
856
|
This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`.
|
|
824
857
|
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.
|
|
@@ -890,6 +923,10 @@ export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
890
923
|
style: "form",
|
|
891
924
|
explode: true,
|
|
892
925
|
},
|
|
926
|
+
usageContext: {
|
|
927
|
+
style: "form",
|
|
928
|
+
explode: true,
|
|
929
|
+
},
|
|
893
930
|
},
|
|
894
931
|
parameters: {
|
|
895
932
|
assetId: z.number().int(),
|
|
@@ -909,6 +946,7 @@ export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
909
946
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
910
947
|
contentRepresentationPriorityList: z.string().optional(),
|
|
911
948
|
accessContext: z.string().optional(),
|
|
949
|
+
usageContext: z.number().int().optional(),
|
|
912
950
|
},
|
|
913
951
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
914
952
|
errors: [
|
|
@@ -30,6 +30,7 @@ const Roblox_Web_Assets_IAssetItemError = zod_1.z.object({
|
|
|
30
30
|
'NotApprovedByContentCompliance',
|
|
31
31
|
'AssetContentRepresentationGenerating',
|
|
32
32
|
'AssetArchived',
|
|
33
|
+
'AssetUsageNotAllowed',
|
|
33
34
|
]),
|
|
34
35
|
});
|
|
35
36
|
const Roblox_Web_Assets_AssetContentRepresentationSpecifier = zod_1.z.object({
|
|
@@ -73,6 +74,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
|
|
|
73
74
|
'roblox-assetFormat': zod_1.z.string(),
|
|
74
75
|
assetResolutionMode: zod_1.z.string(),
|
|
75
76
|
accessContext: zod_1.z.string(),
|
|
77
|
+
usageContext: zod_1.z.number().int(),
|
|
76
78
|
contentRepresentationPriorityList: zod_1.z.string(),
|
|
77
79
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean(),
|
|
78
80
|
});
|
|
@@ -93,6 +95,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
|
|
|
93
95
|
* @param serverplaceid
|
|
94
96
|
* @param expectedAssetType
|
|
95
97
|
* @param accessContext
|
|
98
|
+
* @param usageContext
|
|
96
99
|
*/
|
|
97
100
|
exports.getAliasAlias = (0, __1.endpoint)({
|
|
98
101
|
method: 'GET',
|
|
@@ -149,6 +152,10 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
149
152
|
style: 'form',
|
|
150
153
|
explode: true,
|
|
151
154
|
},
|
|
155
|
+
usageContext: {
|
|
156
|
+
style: 'form',
|
|
157
|
+
explode: true,
|
|
158
|
+
},
|
|
152
159
|
},
|
|
153
160
|
parameters: {
|
|
154
161
|
alias: zod_1.z.string().regex(/^[0-9]+\/.+/),
|
|
@@ -165,6 +172,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
165
172
|
serverplaceid: zod_1.z.number().int().optional(),
|
|
166
173
|
expectedAssetType: zod_1.z.string().optional(),
|
|
167
174
|
accessContext: zod_1.z.string().optional(),
|
|
175
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
168
176
|
},
|
|
169
177
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
170
178
|
errors: [],
|
|
@@ -197,6 +205,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
197
205
|
* @param contentRepresentationPriorityList
|
|
198
206
|
* @param assetResolutionMode
|
|
199
207
|
* @param accessContext
|
|
208
|
+
* @param usageContext
|
|
200
209
|
*/
|
|
201
210
|
exports.getAsset = (0, __1.endpoint)({
|
|
202
211
|
method: 'GET',
|
|
@@ -302,6 +311,10 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
302
311
|
style: 'form',
|
|
303
312
|
explode: true,
|
|
304
313
|
},
|
|
314
|
+
usageContext: {
|
|
315
|
+
style: 'form',
|
|
316
|
+
explode: true,
|
|
317
|
+
},
|
|
305
318
|
},
|
|
306
319
|
parameters: {
|
|
307
320
|
'Accept-Encoding': zod_1.z.string(),
|
|
@@ -330,6 +343,7 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
330
343
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
331
344
|
assetResolutionMode: zod_1.z.string().optional(),
|
|
332
345
|
accessContext: zod_1.z.string().optional(),
|
|
346
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
333
347
|
},
|
|
334
348
|
response: zod_1.z.void(),
|
|
335
349
|
errors: [],
|
|
@@ -353,6 +367,7 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
353
367
|
* @param doNotFallbackToBaselineRepresentation
|
|
354
368
|
* @param contentRepresentationPriorityList
|
|
355
369
|
* @param accessContext
|
|
370
|
+
* @param usageContext
|
|
356
371
|
*/
|
|
357
372
|
exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
358
373
|
method: 'GET',
|
|
@@ -417,6 +432,10 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
417
432
|
style: 'form',
|
|
418
433
|
explode: true,
|
|
419
434
|
},
|
|
435
|
+
usageContext: {
|
|
436
|
+
style: 'form',
|
|
437
|
+
explode: true,
|
|
438
|
+
},
|
|
420
439
|
},
|
|
421
440
|
parameters: {
|
|
422
441
|
assetId: zod_1.z.number().int(),
|
|
@@ -435,6 +454,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
435
454
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
436
455
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
437
456
|
accessContext: zod_1.z.string().optional(),
|
|
457
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
438
458
|
},
|
|
439
459
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
440
460
|
errors: [],
|
|
@@ -459,6 +479,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
459
479
|
* @param doNotFallbackToBaselineRepresentation
|
|
460
480
|
* @param contentRepresentationPriorityList
|
|
461
481
|
* @param accessContext
|
|
482
|
+
* @param usageContext
|
|
462
483
|
*/
|
|
463
484
|
exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
464
485
|
method: 'GET',
|
|
@@ -526,6 +547,10 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
526
547
|
style: 'form',
|
|
527
548
|
explode: true,
|
|
528
549
|
},
|
|
550
|
+
usageContext: {
|
|
551
|
+
style: 'form',
|
|
552
|
+
explode: true,
|
|
553
|
+
},
|
|
529
554
|
},
|
|
530
555
|
parameters: {
|
|
531
556
|
assetId: zod_1.z.number().int(),
|
|
@@ -545,6 +570,7 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
545
570
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
546
571
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
547
572
|
accessContext: zod_1.z.string().optional(),
|
|
573
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
548
574
|
},
|
|
549
575
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
550
576
|
errors: [],
|
|
@@ -703,6 +729,7 @@ exports.getMarassethashMarassethashMarchecksumMarchecksum = (0, __1.endpoint)({
|
|
|
703
729
|
* @param doNotFallbackToBaselineRepresentation Whether to prevent fallback to baseline representation when specific content representations are not available.
|
|
704
730
|
* @param contentRepresentationPriorityList Base64URL-encoded JSON string specifying the priority list of desired content representations (format, version, fidelity).
|
|
705
731
|
* @param accessContext
|
|
732
|
+
* @param usageContext
|
|
706
733
|
* @description Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported.
|
|
707
734
|
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
735
|
This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`.
|
|
@@ -772,6 +799,10 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
|
|
|
772
799
|
style: 'form',
|
|
773
800
|
explode: true,
|
|
774
801
|
},
|
|
802
|
+
usageContext: {
|
|
803
|
+
style: 'form',
|
|
804
|
+
explode: true,
|
|
805
|
+
},
|
|
775
806
|
},
|
|
776
807
|
parameters: {
|
|
777
808
|
assetId: zod_1.z.number().int(),
|
|
@@ -790,6 +821,7 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
|
|
|
790
821
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
791
822
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
792
823
|
accessContext: zod_1.z.string().optional(),
|
|
824
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
793
825
|
},
|
|
794
826
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
795
827
|
errors: [
|
|
@@ -819,6 +851,7 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
|
|
|
819
851
|
* @param doNotFallbackToBaselineRepresentation
|
|
820
852
|
* @param contentRepresentationPriorityList
|
|
821
853
|
* @param accessContext
|
|
854
|
+
* @param usageContext
|
|
822
855
|
* @description Refer to the assetId endpoint for details on usage.
|
|
823
856
|
This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`.
|
|
824
857
|
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.
|
|
@@ -890,6 +923,10 @@ exports.getOpencloudAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
890
923
|
style: 'form',
|
|
891
924
|
explode: true,
|
|
892
925
|
},
|
|
926
|
+
usageContext: {
|
|
927
|
+
style: 'form',
|
|
928
|
+
explode: true,
|
|
929
|
+
},
|
|
893
930
|
},
|
|
894
931
|
parameters: {
|
|
895
932
|
assetId: zod_1.z.number().int(),
|
|
@@ -909,6 +946,7 @@ exports.getOpencloudAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
909
946
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
910
947
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
911
948
|
accessContext: zod_1.z.string().optional(),
|
|
949
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
912
950
|
},
|
|
913
951
|
response: Roblox_Web_Assets_AssetResponseItemV1,
|
|
914
952
|
errors: [
|
|
@@ -37,6 +37,7 @@ const Roblox_Web_Assets_IAssetItemError = z.object({
|
|
|
37
37
|
"NotApprovedByContentCompliance",
|
|
38
38
|
"AssetContentRepresentationGenerating",
|
|
39
39
|
"AssetArchived",
|
|
40
|
+
"AssetUsageNotAllowed",
|
|
40
41
|
]),
|
|
41
42
|
});
|
|
42
43
|
const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
|
|
@@ -76,6 +77,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
|
|
|
76
77
|
"roblox-assetFormat": z.string(),
|
|
77
78
|
assetResolutionMode: z.string(),
|
|
78
79
|
accessContext: z.string(),
|
|
80
|
+
usageContext: z.number().int(),
|
|
79
81
|
contentRepresentationPriorityList: z.string(),
|
|
80
82
|
doNotFallbackToBaselineRepresentation: z.boolean(),
|
|
81
83
|
});
|
|
@@ -96,6 +98,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
|
|
|
96
98
|
* @param serverplaceid
|
|
97
99
|
* @param expectedAssetType
|
|
98
100
|
* @param accessContext
|
|
101
|
+
* @param usageContext
|
|
99
102
|
*/
|
|
100
103
|
export const getAliasAlias = endpoint({
|
|
101
104
|
method: "GET",
|
|
@@ -152,6 +155,10 @@ export const getAliasAlias = endpoint({
|
|
|
152
155
|
style: "form",
|
|
153
156
|
explode: true,
|
|
154
157
|
},
|
|
158
|
+
usageContext: {
|
|
159
|
+
style: "form",
|
|
160
|
+
explode: true,
|
|
161
|
+
},
|
|
155
162
|
},
|
|
156
163
|
parameters: {
|
|
157
164
|
alias: z.string().regex(/^[0-9]+\/.+/),
|
|
@@ -168,6 +175,7 @@ export const getAliasAlias = endpoint({
|
|
|
168
175
|
serverplaceid: z.number().int().optional(),
|
|
169
176
|
expectedAssetType: z.string().optional(),
|
|
170
177
|
accessContext: z.string().optional(),
|
|
178
|
+
usageContext: z.number().int().optional(),
|
|
171
179
|
},
|
|
172
180
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
173
181
|
errors: [],
|
|
@@ -199,6 +207,7 @@ export const getAliasAlias = endpoint({
|
|
|
199
207
|
* @param doNotFallbackToBaselineRepresentation
|
|
200
208
|
* @param contentRepresentationPriorityList
|
|
201
209
|
* @param accessContext
|
|
210
|
+
* @param usageContext
|
|
202
211
|
*/
|
|
203
212
|
export const getAsset = endpoint({
|
|
204
213
|
method: "GET",
|
|
@@ -300,6 +309,10 @@ export const getAsset = endpoint({
|
|
|
300
309
|
style: "form",
|
|
301
310
|
explode: true,
|
|
302
311
|
},
|
|
312
|
+
usageContext: {
|
|
313
|
+
style: "form",
|
|
314
|
+
explode: true,
|
|
315
|
+
},
|
|
303
316
|
},
|
|
304
317
|
parameters: {
|
|
305
318
|
"Accept-Encoding": z.string(),
|
|
@@ -327,6 +340,7 @@ export const getAsset = endpoint({
|
|
|
327
340
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
328
341
|
contentRepresentationPriorityList: z.string().optional(),
|
|
329
342
|
accessContext: z.string().optional(),
|
|
343
|
+
usageContext: z.number().int().optional(),
|
|
330
344
|
},
|
|
331
345
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
332
346
|
errors: [],
|
|
@@ -349,6 +363,7 @@ export const getAsset = endpoint({
|
|
|
349
363
|
* @param doNotFallbackToBaselineRepresentation
|
|
350
364
|
* @param contentRepresentationPriorityList
|
|
351
365
|
* @param accessContext
|
|
366
|
+
* @param usageContext
|
|
352
367
|
*/
|
|
353
368
|
export const getAssetidAssetid = endpoint({
|
|
354
369
|
method: "GET",
|
|
@@ -413,6 +428,10 @@ export const getAssetidAssetid = endpoint({
|
|
|
413
428
|
style: "form",
|
|
414
429
|
explode: true,
|
|
415
430
|
},
|
|
431
|
+
usageContext: {
|
|
432
|
+
style: "form",
|
|
433
|
+
explode: true,
|
|
434
|
+
},
|
|
416
435
|
},
|
|
417
436
|
parameters: {
|
|
418
437
|
assetId: z.number().int(),
|
|
@@ -431,6 +450,7 @@ export const getAssetidAssetid = endpoint({
|
|
|
431
450
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
432
451
|
contentRepresentationPriorityList: z.string().optional(),
|
|
433
452
|
accessContext: z.string().optional(),
|
|
453
|
+
usageContext: z.number().int().optional(),
|
|
434
454
|
},
|
|
435
455
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
436
456
|
errors: [],
|
|
@@ -454,6 +474,7 @@ export const getAssetidAssetid = endpoint({
|
|
|
454
474
|
* @param doNotFallbackToBaselineRepresentation
|
|
455
475
|
* @param contentRepresentationPriorityList
|
|
456
476
|
* @param accessContext
|
|
477
|
+
* @param usageContext
|
|
457
478
|
*/
|
|
458
479
|
export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
459
480
|
method: "GET",
|
|
@@ -521,6 +542,10 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
521
542
|
style: "form",
|
|
522
543
|
explode: true,
|
|
523
544
|
},
|
|
545
|
+
usageContext: {
|
|
546
|
+
style: "form",
|
|
547
|
+
explode: true,
|
|
548
|
+
},
|
|
524
549
|
},
|
|
525
550
|
parameters: {
|
|
526
551
|
assetId: z.number().int(),
|
|
@@ -540,6 +565,7 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
|
|
|
540
565
|
doNotFallbackToBaselineRepresentation: z.boolean().optional(),
|
|
541
566
|
contentRepresentationPriorityList: z.string().optional(),
|
|
542
567
|
accessContext: z.string().optional(),
|
|
568
|
+
usageContext: z.number().int().optional(),
|
|
543
569
|
},
|
|
544
570
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
545
571
|
errors: [],
|
|
@@ -39,6 +39,7 @@ const Roblox_Web_Assets_IAssetItemError = zod_1.z.object({
|
|
|
39
39
|
'NotApprovedByContentCompliance',
|
|
40
40
|
'AssetContentRepresentationGenerating',
|
|
41
41
|
'AssetArchived',
|
|
42
|
+
'AssetUsageNotAllowed',
|
|
42
43
|
]),
|
|
43
44
|
});
|
|
44
45
|
const Roblox_Web_Assets_AssetContentRepresentationSpecifier = zod_1.z.object({
|
|
@@ -77,6 +78,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
|
|
|
77
78
|
'roblox-assetFormat': zod_1.z.string(),
|
|
78
79
|
assetResolutionMode: zod_1.z.string(),
|
|
79
80
|
accessContext: zod_1.z.string(),
|
|
81
|
+
usageContext: zod_1.z.number().int(),
|
|
80
82
|
contentRepresentationPriorityList: zod_1.z.string(),
|
|
81
83
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean(),
|
|
82
84
|
});
|
|
@@ -96,6 +98,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
|
|
|
96
98
|
* @param serverplaceid
|
|
97
99
|
* @param expectedAssetType
|
|
98
100
|
* @param accessContext
|
|
101
|
+
* @param usageContext
|
|
99
102
|
*/
|
|
100
103
|
exports.getAliasAlias = (0, __1.endpoint)({
|
|
101
104
|
method: 'GET',
|
|
@@ -152,6 +155,10 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
152
155
|
style: 'form',
|
|
153
156
|
explode: true,
|
|
154
157
|
},
|
|
158
|
+
usageContext: {
|
|
159
|
+
style: 'form',
|
|
160
|
+
explode: true,
|
|
161
|
+
},
|
|
155
162
|
},
|
|
156
163
|
parameters: {
|
|
157
164
|
alias: zod_1.z.string().regex(/^[0-9]+\/.+/),
|
|
@@ -168,6 +175,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
168
175
|
serverplaceid: zod_1.z.number().int().optional(),
|
|
169
176
|
expectedAssetType: zod_1.z.string().optional(),
|
|
170
177
|
accessContext: zod_1.z.string().optional(),
|
|
178
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
171
179
|
},
|
|
172
180
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
173
181
|
errors: [],
|
|
@@ -199,6 +207,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
|
|
|
199
207
|
* @param doNotFallbackToBaselineRepresentation
|
|
200
208
|
* @param contentRepresentationPriorityList
|
|
201
209
|
* @param accessContext
|
|
210
|
+
* @param usageContext
|
|
202
211
|
*/
|
|
203
212
|
exports.getAsset = (0, __1.endpoint)({
|
|
204
213
|
method: 'GET',
|
|
@@ -300,6 +309,10 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
300
309
|
style: 'form',
|
|
301
310
|
explode: true,
|
|
302
311
|
},
|
|
312
|
+
usageContext: {
|
|
313
|
+
style: 'form',
|
|
314
|
+
explode: true,
|
|
315
|
+
},
|
|
303
316
|
},
|
|
304
317
|
parameters: {
|
|
305
318
|
'Accept-Encoding': zod_1.z.string(),
|
|
@@ -327,6 +340,7 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
327
340
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
328
341
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
329
342
|
accessContext: zod_1.z.string().optional(),
|
|
343
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
330
344
|
},
|
|
331
345
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
332
346
|
errors: [],
|
|
@@ -349,6 +363,7 @@ exports.getAsset = (0, __1.endpoint)({
|
|
|
349
363
|
* @param doNotFallbackToBaselineRepresentation
|
|
350
364
|
* @param contentRepresentationPriorityList
|
|
351
365
|
* @param accessContext
|
|
366
|
+
* @param usageContext
|
|
352
367
|
*/
|
|
353
368
|
exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
354
369
|
method: 'GET',
|
|
@@ -413,6 +428,10 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
413
428
|
style: 'form',
|
|
414
429
|
explode: true,
|
|
415
430
|
},
|
|
431
|
+
usageContext: {
|
|
432
|
+
style: 'form',
|
|
433
|
+
explode: true,
|
|
434
|
+
},
|
|
416
435
|
},
|
|
417
436
|
parameters: {
|
|
418
437
|
assetId: zod_1.z.number().int(),
|
|
@@ -431,6 +450,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
431
450
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
432
451
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
433
452
|
accessContext: zod_1.z.string().optional(),
|
|
453
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
434
454
|
},
|
|
435
455
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
436
456
|
errors: [],
|
|
@@ -454,6 +474,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
|
|
|
454
474
|
* @param doNotFallbackToBaselineRepresentation
|
|
455
475
|
* @param contentRepresentationPriorityList
|
|
456
476
|
* @param accessContext
|
|
477
|
+
* @param usageContext
|
|
457
478
|
*/
|
|
458
479
|
exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
459
480
|
method: 'GET',
|
|
@@ -521,6 +542,10 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
521
542
|
style: 'form',
|
|
522
543
|
explode: true,
|
|
523
544
|
},
|
|
545
|
+
usageContext: {
|
|
546
|
+
style: 'form',
|
|
547
|
+
explode: true,
|
|
548
|
+
},
|
|
524
549
|
},
|
|
525
550
|
parameters: {
|
|
526
551
|
assetId: zod_1.z.number().int(),
|
|
@@ -540,6 +565,7 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
|
|
|
540
565
|
doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
|
|
541
566
|
contentRepresentationPriorityList: zod_1.z.string().optional(),
|
|
542
567
|
accessContext: zod_1.z.string().optional(),
|
|
568
|
+
usageContext: zod_1.z.number().int().optional(),
|
|
543
569
|
},
|
|
544
570
|
response: Roblox_Web_Assets_AssetResponseItemV2,
|
|
545
571
|
errors: [],
|
|
@@ -349,9 +349,14 @@ const Roblox_Authentication_Api_Models_Request_FinishARPreAuthPasskeyRegistratio
|
|
|
349
349
|
passkeyRegistrationResponse: z.string(),
|
|
350
350
|
userId: z.number().int(),
|
|
351
351
|
isPostRecovery: z.boolean(),
|
|
352
|
+
source: z.string(),
|
|
352
353
|
});
|
|
353
354
|
const Roblox_Authentication_Api_Models_Request_FinishPasskeyPreauthRegistrationRequest =
|
|
354
|
-
z.object({
|
|
355
|
+
z.object({
|
|
356
|
+
sessionId: z.string(),
|
|
357
|
+
registrationResponse: z.string(),
|
|
358
|
+
source: z.string(),
|
|
359
|
+
});
|
|
355
360
|
const Roblox_Authentication_Api_Models_Request_FinishPasskeyRegistrationRequest =
|
|
356
361
|
z.object({
|
|
357
362
|
sessionId: z.string(),
|
|
@@ -1920,7 +1925,7 @@ export const getUsernames = endpoint({
|
|
|
1920
1925
|
},
|
|
1921
1926
|
},
|
|
1922
1927
|
parameters: {
|
|
1923
|
-
username: z.string()
|
|
1928
|
+
username: z.string(),
|
|
1924
1929
|
},
|
|
1925
1930
|
response: Roblox_Authentication_Api_Models_UsernamesResponse,
|
|
1926
1931
|
errors: [],
|
package/lib/endpoints/authv1.js
CHANGED
|
@@ -316,10 +316,12 @@ const Roblox_Authentication_Api_Models_Request_FinishARPreAuthPasskeyRegistratio
|
|
|
316
316
|
passkeyRegistrationResponse: zod_1.z.string(),
|
|
317
317
|
userId: zod_1.z.number().int(),
|
|
318
318
|
isPostRecovery: zod_1.z.boolean(),
|
|
319
|
+
source: zod_1.z.string(),
|
|
319
320
|
});
|
|
320
321
|
const Roblox_Authentication_Api_Models_Request_FinishPasskeyPreauthRegistrationRequest = zod_1.z.object({
|
|
321
322
|
sessionId: zod_1.z.string(),
|
|
322
323
|
registrationResponse: zod_1.z.string(),
|
|
324
|
+
source: zod_1.z.string(),
|
|
323
325
|
});
|
|
324
326
|
const Roblox_Authentication_Api_Models_Request_FinishPasskeyRegistrationRequest = zod_1.z.object({
|
|
325
327
|
sessionId: zod_1.z.string(),
|
|
@@ -1883,7 +1885,7 @@ exports.getUsernames = (0, __1.endpoint)({
|
|
|
1883
1885
|
},
|
|
1884
1886
|
},
|
|
1885
1887
|
parameters: {
|
|
1886
|
-
username: zod_1.z.string()
|
|
1888
|
+
username: zod_1.z.string(),
|
|
1887
1889
|
},
|
|
1888
1890
|
response: Roblox_Authentication_Api_Models_UsernamesResponse,
|
|
1889
1891
|
errors: [],
|
package/lib/endpoints/authv2.js
CHANGED
|
@@ -1118,7 +1118,7 @@ exports.getUsernames = (0, __1.endpoint)({
|
|
|
1118
1118
|
},
|
|
1119
1119
|
},
|
|
1120
1120
|
parameters: {
|
|
1121
|
-
username: zod_1.z.string()
|
|
1121
|
+
username: zod_1.z.string(),
|
|
1122
1122
|
},
|
|
1123
1123
|
response: Roblox_Authentication_Api_Models_UsernamesResponse,
|
|
1124
1124
|
errors: [],
|
|
@@ -288,6 +288,10 @@ export const getUniversesUniverseidBadges = endpoint({
|
|
|
288
288
|
response:
|
|
289
289
|
Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
|
|
290
290
|
errors: [
|
|
291
|
+
{
|
|
292
|
+
status: 400,
|
|
293
|
+
description: `26: The pagination cursor is invalid or incompatible with the current request.`,
|
|
294
|
+
},
|
|
291
295
|
{
|
|
292
296
|
status: 404,
|
|
293
297
|
description: `3: The game is invalid or does not exist.`,
|
|
@@ -284,6 +284,10 @@ exports.getUniversesUniverseidBadges = (0, __1.endpoint)({
|
|
|
284
284
|
},
|
|
285
285
|
response: Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Badges_Api_BadgeResponse_,
|
|
286
286
|
errors: [
|
|
287
|
+
{
|
|
288
|
+
status: 400,
|
|
289
|
+
description: `26: The pagination cursor is invalid or incompatible with the current request.`,
|
|
290
|
+
},
|
|
287
291
|
{
|
|
288
292
|
status: 404,
|
|
289
293
|
description: `3: The game is invalid or does not exist.`,
|
|
@@ -665,8 +665,9 @@ export const getBundlesDetails = endpoint({
|
|
|
665
665
|
});
|
|
666
666
|
/**
|
|
667
667
|
* @api POST https://catalog.roblox.com/v1/catalog/items/details
|
|
668
|
-
* @summary Returns
|
|
668
|
+
* @summary Returns details for one or more catalog items.
|
|
669
669
|
* @param body Roblox.Catalog.Api.MultigetItemDetailsRequestModel.
|
|
670
|
+
* @description There is an item count limit per request. Exceeding this returns 400 Bad Request.
|
|
670
671
|
*/
|
|
671
672
|
export const postCatalogItemsDetails = endpoint({
|
|
672
673
|
method: "POST",
|