rozod 6.7.0 → 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.
Files changed (70) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +75 -451
  3. package/lib/endpoints/accountinformationv1.d.ts +50 -87
  4. package/lib/endpoints/accountinformationv1.js +46 -90
  5. package/lib/endpoints/assetdeliveryv1.d.ts +39 -0
  6. package/lib/endpoints/assetdeliveryv1.js +39 -0
  7. package/lib/endpoints/assetdeliveryv2.d.ts +27 -0
  8. package/lib/endpoints/assetdeliveryv2.js +27 -0
  9. package/lib/endpoints/authv1.d.ts +71 -3
  10. package/lib/endpoints/authv1.js +70 -4
  11. package/lib/endpoints/authv2.d.ts +22 -1
  12. package/lib/endpoints/authv2.js +23 -2
  13. package/lib/endpoints/avatarv1.d.ts +9 -6
  14. package/lib/endpoints/avatarv1.js +9 -6
  15. package/lib/endpoints/avatarv2.d.ts +11 -5
  16. package/lib/endpoints/avatarv2.js +11 -5
  17. package/lib/endpoints/avatarv3.d.ts +16 -7
  18. package/lib/endpoints/avatarv3.js +16 -7
  19. package/lib/endpoints/badgesv1.d.ts +4 -0
  20. package/lib/endpoints/badgesv1.js +4 -0
  21. package/lib/endpoints/catalogv1.d.ts +25 -3
  22. package/lib/endpoints/catalogv1.js +21 -3
  23. package/lib/endpoints/catalogv2.d.ts +294 -50
  24. package/lib/endpoints/catalogv2.js +256 -24
  25. package/lib/endpoints/clientsettingsv2.d.ts +6 -0
  26. package/lib/endpoints/clientsettingsv2.js +6 -0
  27. package/lib/endpoints/contactsv1.d.ts +18 -22
  28. package/lib/endpoints/contactsv1.js +14 -22
  29. package/lib/endpoints/developv1.d.ts +36 -1
  30. package/lib/endpoints/developv1.js +12 -3
  31. package/lib/endpoints/developv2.d.ts +32 -3
  32. package/lib/endpoints/developv2.js +16 -5
  33. package/lib/endpoints/friendsv1.d.ts +222 -314
  34. package/lib/endpoints/friendsv1.js +213 -313
  35. package/lib/endpoints/gameinternationalizationv1.d.ts +59 -0
  36. package/lib/endpoints/gameinternationalizationv1.js +57 -1
  37. package/lib/endpoints/gamesv1.d.ts +79 -0
  38. package/lib/endpoints/gamesv1.js +70 -97
  39. package/lib/endpoints/gamesv2.d.ts +12 -0
  40. package/lib/endpoints/gamesv2.js +10 -0
  41. package/lib/endpoints/groupsv1.d.ts +49 -4
  42. package/lib/endpoints/groupsv1.js +55 -7
  43. package/lib/endpoints/groupsv2.d.ts +2 -0
  44. package/lib/endpoints/groupsv2.js +2 -0
  45. package/lib/endpoints/inventoryv1.d.ts +3 -1
  46. package/lib/endpoints/inventoryv1.js +3 -1
  47. package/lib/endpoints/inventoryv2.d.ts +70 -0
  48. package/lib/endpoints/inventoryv2.js +68 -1
  49. package/lib/endpoints/localev1.d.ts +27 -0
  50. package/lib/endpoints/localev1.js +28 -1
  51. package/lib/endpoints/publishv1.d.ts +3 -6
  52. package/lib/endpoints/publishv1.js +3 -6
  53. package/lib/endpoints/thumbnailsv1.d.ts +44 -87
  54. package/lib/endpoints/thumbnailsv1.js +25 -0
  55. package/lib/index.d.ts +96 -3
  56. package/lib/index.js +114 -1
  57. package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
  58. package/lib/opencloud/v1/assets.d.ts +9 -9
  59. package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
  60. package/lib/opencloud/v1/datastores.d.ts +8 -8
  61. package/lib/opencloud/v1/developer-products.d.ts +4 -4
  62. package/lib/opencloud/v1/game-passes.d.ts +4 -4
  63. package/lib/opencloud/v1/messaging.d.ts +1 -1
  64. package/lib/opencloud/v1/open-eval.d.ts +2 -2
  65. package/lib/opencloud/v1/secrets-store.d.ts +5 -5
  66. package/lib/opencloud/v1/toolbox.d.ts +2 -2
  67. package/lib/opencloud/v1/universes.d.ts +1 -1
  68. package/lib/opencloud/v2/cloud.d.ts +197 -87
  69. package/lib/opencloud/v2/cloud.js +68 -15
  70. package/package.json +108 -108
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getUsersUseridRobloxBadges = exports.getUsersUseridPromotionChannels = exports.deleteStarCodeAffiliates = exports.postStarCodeAffiliates = exports.getStarCodeAffiliates = exports.postPromotionChannels = exports.getPromotionChannels = exports.postPhoneVerify = exports.postPhoneResend = exports.postPhoneDelete = exports.postPhone = exports.getPhone = exports.getMetadata = exports.postGender = exports.getGender = exports.postEmailVerify = exports.postDescription = exports.getDescription = exports.getBirthdate = void 0;
3
+ exports.deleteStarCodeAffiliates = exports.postStarCodeAffiliates = exports.getStarCodeAffiliates = exports.getUsersUseridRobloxBadges = exports.getUsersUseridPromotionChannels = exports.postPromotionChannels = exports.getPromotionChannels = exports.postPhoneVerify = exports.postPhoneResend = exports.postPhoneDelete = exports.postPhone = exports.getPhone = exports.getMetadata = exports.postGender = exports.getGender = exports.postEmailVerify = exports.postDescription = exports.getDescription = exports.getBirthdate = void 0;
4
4
  const zod_1 = require("zod");
5
5
  const __1 = require("..");
6
6
  const Roblox_AccountInformation_Api_Models_BirthdateResponse = zod_1.z.object({
@@ -65,14 +65,6 @@ const Roblox_AccountInformation_Api_Models_PromotionChannelsRequest = zod_1.z.ob
65
65
  twitch: zod_1.z.string(),
66
66
  promotionChannelsVisibilityPrivacy: zod_1.z.string(),
67
67
  });
68
- const Roblox_AccountInformation_Api_Models_StarCodeAffiliateResponse = zod_1.z.object({
69
- userId: zod_1.z.number().int(),
70
- name: zod_1.z.string(),
71
- code: zod_1.z.string(),
72
- });
73
- const Roblox_AccountInformation_Api_Models_StarCodeAffiliateRequest = zod_1.z.object({
74
- code: zod_1.z.string(),
75
- });
76
68
  const Roblox_AccountInformation_Api_Models_PromotionChannelsByUserIdResponse = zod_1.z.object({
77
69
  facebook: zod_1.z.string(),
78
70
  twitter: zod_1.z.string(),
@@ -539,87 +531,6 @@ exports.postPromotionChannels = (0, __1.endpoint)({
539
531
  },
540
532
  ],
541
533
  });
542
- /**
543
- * @api GET https://accountinformation.roblox.com/v1/star-code-affiliates
544
- * @summary Gets a star code affiliate supporter for the authenticated user
545
- */
546
- exports.getStarCodeAffiliates = (0, __1.endpoint)({
547
- method: 'GET',
548
- path: '/v1/star-code-affiliates',
549
- baseUrl: 'https://accountinformation.roblox.com',
550
- requestFormat: 'json',
551
- response: Roblox_AccountInformation_Api_Models_StarCodeAffiliateResponse,
552
- errors: [
553
- {
554
- status: 401,
555
- description: `0: Authorization has been denied for this request.`,
556
- },
557
- {
558
- status: 500,
559
- description: `0: An unknown error occured.`,
560
- },
561
- ],
562
- });
563
- /**
564
- * @api POST https://accountinformation.roblox.com/v1/star-code-affiliates
565
- * @summary Adds a star code affiliate supporter for the authenticated user
566
- * @param body Roblox.AccountInformation.Api.Models.StarCodeAffiliateRequest
567
- */
568
- exports.postStarCodeAffiliates = (0, __1.endpoint)({
569
- method: 'POST',
570
- path: '/v1/star-code-affiliates',
571
- baseUrl: 'https://accountinformation.roblox.com',
572
- requestFormat: 'json',
573
- serializationMethod: {
574
- body: {},
575
- },
576
- parameters: {},
577
- body: zod_1.z.object({ code: zod_1.z.string() }),
578
- response: Roblox_AccountInformation_Api_Models_StarCodeAffiliateResponse,
579
- errors: [
580
- {
581
- status: 400,
582
- description: `1: The code was invalid.`,
583
- },
584
- {
585
- status: 401,
586
- description: `0: Authorization has been denied for this request.`,
587
- },
588
- {
589
- status: 403,
590
- description: `0: Token Validation Failed`,
591
- },
592
- {
593
- status: 500,
594
- description: `0: An unknown error occured.`,
595
- },
596
- ],
597
- });
598
- /**
599
- * @api DELETE https://accountinformation.roblox.com/v1/star-code-affiliates
600
- * @summary Removes the star code affiliate supporter for the authenticated user
601
- */
602
- exports.deleteStarCodeAffiliates = (0, __1.endpoint)({
603
- method: 'DELETE',
604
- path: '/v1/star-code-affiliates',
605
- baseUrl: 'https://accountinformation.roblox.com',
606
- requestFormat: 'json',
607
- response: zod_1.z.object({}),
608
- errors: [
609
- {
610
- status: 401,
611
- description: `0: Authorization has been denied for this request.`,
612
- },
613
- {
614
- status: 403,
615
- description: `0: Token Validation Failed`,
616
- },
617
- {
618
- status: 500,
619
- description: `0: An unknown error occured.`,
620
- },
621
- ],
622
- });
623
534
  /**
624
535
  * @api GET https://accountinformation.roblox.com/v1/users/:userId/promotion-channels
625
536
  * @summary Get promotion channels for a given user ID
@@ -679,3 +590,48 @@ exports.getUsersUseridRobloxBadges = (0, __1.endpoint)({
679
590
  response: zod_1.z.array(Roblox_AccountInformation_Api_RobloxBadgeResponse),
680
591
  errors: [],
681
592
  });
593
+ // Patched endpoints removed from Roblox API docs
594
+ const Patch_StarCodeAffiliateResponse = zod_1.z.object({
595
+ userId: zod_1.z.number().int(),
596
+ name: zod_1.z.string(),
597
+ code: zod_1.z.string(),
598
+ });
599
+ exports.getStarCodeAffiliates = (0, __1.endpoint)({
600
+ method: 'GET',
601
+ path: '/v1/star-code-affiliates',
602
+ baseUrl: 'https://accountinformation.roblox.com',
603
+ requestFormat: 'json',
604
+ response: Patch_StarCodeAffiliateResponse,
605
+ errors: [
606
+ { status: 401, description: `0: Authorization has been denied for this request.` },
607
+ { status: 500, description: `0: An unknown error occured.` },
608
+ ],
609
+ });
610
+ exports.postStarCodeAffiliates = (0, __1.endpoint)({
611
+ method: 'POST',
612
+ path: '/v1/star-code-affiliates',
613
+ baseUrl: 'https://accountinformation.roblox.com',
614
+ requestFormat: 'json',
615
+ serializationMethod: { body: {} },
616
+ parameters: {},
617
+ body: zod_1.z.object({ code: zod_1.z.string() }),
618
+ response: Patch_StarCodeAffiliateResponse,
619
+ errors: [
620
+ { status: 400, description: `1: The code was invalid.` },
621
+ { status: 401, description: `0: Authorization has been denied for this request.` },
622
+ { status: 403, description: `0: Token Validation Failed` },
623
+ { status: 500, description: `0: An unknown error occured.` },
624
+ ],
625
+ });
626
+ exports.deleteStarCodeAffiliates = (0, __1.endpoint)({
627
+ method: 'DELETE',
628
+ path: '/v1/star-code-affiliates',
629
+ baseUrl: 'https://accountinformation.roblox.com',
630
+ requestFormat: 'json',
631
+ response: zod_1.z.object({}),
632
+ errors: [
633
+ { status: 401, description: `0: Authorization has been denied for this request.` },
634
+ { status: 403, description: `0: Token Validation Failed` },
635
+ { status: 500, description: `0: An unknown error occured.` },
636
+ ],
637
+ });
@@ -27,6 +27,8 @@ const Roblox_Web_Assets_IAssetItemError = z.object({
27
27
  "NotApprovedForRequestor",
28
28
  "NotApprovedByContentCompliance",
29
29
  "AssetContentRepresentationGenerating",
30
+ "AssetArchived",
31
+ "AssetUsageNotAllowed",
30
32
  ]),
31
33
  });
32
34
  const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
@@ -71,6 +73,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
71
73
  "roblox-assetFormat": z.string(),
72
74
  assetResolutionMode: z.string(),
73
75
  accessContext: z.string(),
76
+ usageContext: z.number().int(),
74
77
  contentRepresentationPriorityList: z.string(),
75
78
  doNotFallbackToBaselineRepresentation: z.boolean(),
76
79
  });
@@ -92,6 +95,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
92
95
  * @param serverplaceid
93
96
  * @param expectedAssetType
94
97
  * @param accessContext
98
+ * @param usageContext
95
99
  */
96
100
  export const getAliasAlias = endpoint({
97
101
  method: "GET",
@@ -148,6 +152,10 @@ export const getAliasAlias = endpoint({
148
152
  style: "form",
149
153
  explode: true,
150
154
  },
155
+ usageContext: {
156
+ style: "form",
157
+ explode: true,
158
+ },
151
159
  },
152
160
  parameters: {
153
161
  alias: z.string().regex(/^[0-9]+\/.+/),
@@ -164,6 +172,7 @@ export const getAliasAlias = endpoint({
164
172
  serverplaceid: z.number().int().optional(),
165
173
  expectedAssetType: z.string().optional(),
166
174
  accessContext: z.string().optional(),
175
+ usageContext: z.number().int().optional(),
167
176
  },
168
177
  response: Roblox_Web_Assets_AssetResponseItemV1,
169
178
  errors: [],
@@ -196,6 +205,7 @@ export const getAliasAlias = endpoint({
196
205
  * @param contentRepresentationPriorityList
197
206
  * @param assetResolutionMode
198
207
  * @param accessContext
208
+ * @param usageContext
199
209
  */
200
210
  export const getAsset = endpoint({
201
211
  method: "GET",
@@ -301,6 +311,10 @@ export const getAsset = endpoint({
301
311
  style: "form",
302
312
  explode: true,
303
313
  },
314
+ usageContext: {
315
+ style: "form",
316
+ explode: true,
317
+ },
304
318
  },
305
319
  parameters: {
306
320
  "Accept-Encoding": z.string(),
@@ -329,6 +343,7 @@ export const getAsset = endpoint({
329
343
  contentRepresentationPriorityList: z.string().optional(),
330
344
  assetResolutionMode: z.string().optional(),
331
345
  accessContext: z.string().optional(),
346
+ usageContext: z.number().int().optional(),
332
347
  },
333
348
  response: z.void(),
334
349
  errors: [],
@@ -352,6 +367,7 @@ export const getAsset = endpoint({
352
367
  * @param doNotFallbackToBaselineRepresentation
353
368
  * @param contentRepresentationPriorityList
354
369
  * @param accessContext
370
+ * @param usageContext
355
371
  */
356
372
  export const getAssetidAssetid = endpoint({
357
373
  method: "GET",
@@ -416,6 +432,10 @@ export const getAssetidAssetid = endpoint({
416
432
  style: "form",
417
433
  explode: true,
418
434
  },
435
+ usageContext: {
436
+ style: "form",
437
+ explode: true,
438
+ },
419
439
  },
420
440
  parameters: {
421
441
  assetId: z.number().int(),
@@ -434,6 +454,7 @@ export const getAssetidAssetid = endpoint({
434
454
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
435
455
  contentRepresentationPriorityList: z.string().optional(),
436
456
  accessContext: z.string().optional(),
457
+ usageContext: z.number().int().optional(),
437
458
  },
438
459
  response: Roblox_Web_Assets_AssetResponseItemV1,
439
460
  errors: [],
@@ -458,6 +479,7 @@ export const getAssetidAssetid = endpoint({
458
479
  * @param doNotFallbackToBaselineRepresentation
459
480
  * @param contentRepresentationPriorityList
460
481
  * @param accessContext
482
+ * @param usageContext
461
483
  */
462
484
  export const getAssetidAssetidVersionVersionnumber = endpoint({
463
485
  method: "GET",
@@ -525,6 +547,10 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
525
547
  style: "form",
526
548
  explode: true,
527
549
  },
550
+ usageContext: {
551
+ style: "form",
552
+ explode: true,
553
+ },
528
554
  },
529
555
  parameters: {
530
556
  assetId: z.number().int(),
@@ -544,6 +570,7 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
544
570
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
545
571
  contentRepresentationPriorityList: z.string().optional(),
546
572
  accessContext: z.string().optional(),
573
+ usageContext: z.number().int().optional(),
547
574
  },
548
575
  response: Roblox_Web_Assets_AssetResponseItemV1,
549
576
  errors: [],
@@ -702,6 +729,7 @@ export const getMarassethashMarassethashMarchecksumMarchecksum = endpoint({
702
729
  * @param doNotFallbackToBaselineRepresentation Whether to prevent fallback to baseline representation when specific content representations are not available.
703
730
  * @param contentRepresentationPriorityList Base64URL-encoded JSON string specifying the priority list of desired content representations (format, version, fidelity).
704
731
  * @param accessContext
732
+ * @param usageContext
705
733
  * @description Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported.
706
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.
707
735
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`.
@@ -771,6 +799,10 @@ export const getOpencloudAssetidAssetid = endpoint({
771
799
  style: "form",
772
800
  explode: true,
773
801
  },
802
+ usageContext: {
803
+ style: "form",
804
+ explode: true,
805
+ },
774
806
  },
775
807
  parameters: {
776
808
  assetId: z.number().int(),
@@ -789,6 +821,7 @@ export const getOpencloudAssetidAssetid = endpoint({
789
821
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
790
822
  contentRepresentationPriorityList: z.string().optional(),
791
823
  accessContext: z.string().optional(),
824
+ usageContext: z.number().int().optional(),
792
825
  },
793
826
  response: Roblox_Web_Assets_AssetResponseItemV1,
794
827
  errors: [
@@ -818,6 +851,7 @@ export const getOpencloudAssetidAssetid = endpoint({
818
851
  * @param doNotFallbackToBaselineRepresentation
819
852
  * @param contentRepresentationPriorityList
820
853
  * @param accessContext
854
+ * @param usageContext
821
855
  * @description Refer to the assetId endpoint for details on usage.
822
856
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`.
823
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.
@@ -889,6 +923,10 @@ export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
889
923
  style: "form",
890
924
  explode: true,
891
925
  },
926
+ usageContext: {
927
+ style: "form",
928
+ explode: true,
929
+ },
892
930
  },
893
931
  parameters: {
894
932
  assetId: z.number().int(),
@@ -908,6 +946,7 @@ export const getOpencloudAssetidAssetidVersionVersionnumber = endpoint({
908
946
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
909
947
  contentRepresentationPriorityList: z.string().optional(),
910
948
  accessContext: z.string().optional(),
949
+ usageContext: z.number().int().optional(),
911
950
  },
912
951
  response: Roblox_Web_Assets_AssetResponseItemV1,
913
952
  errors: [
@@ -29,6 +29,8 @@ const Roblox_Web_Assets_IAssetItemError = zod_1.z.object({
29
29
  'NotApprovedForRequestor',
30
30
  'NotApprovedByContentCompliance',
31
31
  'AssetContentRepresentationGenerating',
32
+ 'AssetArchived',
33
+ 'AssetUsageNotAllowed',
32
34
  ]),
33
35
  });
34
36
  const Roblox_Web_Assets_AssetContentRepresentationSpecifier = zod_1.z.object({
@@ -72,6 +74,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
72
74
  'roblox-assetFormat': zod_1.z.string(),
73
75
  assetResolutionMode: zod_1.z.string(),
74
76
  accessContext: zod_1.z.string(),
77
+ usageContext: zod_1.z.number().int(),
75
78
  contentRepresentationPriorityList: zod_1.z.string(),
76
79
  doNotFallbackToBaselineRepresentation: zod_1.z.boolean(),
77
80
  });
@@ -92,6 +95,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = zod_1.z.object({
92
95
  * @param serverplaceid
93
96
  * @param expectedAssetType
94
97
  * @param accessContext
98
+ * @param usageContext
95
99
  */
96
100
  exports.getAliasAlias = (0, __1.endpoint)({
97
101
  method: 'GET',
@@ -148,6 +152,10 @@ exports.getAliasAlias = (0, __1.endpoint)({
148
152
  style: 'form',
149
153
  explode: true,
150
154
  },
155
+ usageContext: {
156
+ style: 'form',
157
+ explode: true,
158
+ },
151
159
  },
152
160
  parameters: {
153
161
  alias: zod_1.z.string().regex(/^[0-9]+\/.+/),
@@ -164,6 +172,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
164
172
  serverplaceid: zod_1.z.number().int().optional(),
165
173
  expectedAssetType: zod_1.z.string().optional(),
166
174
  accessContext: zod_1.z.string().optional(),
175
+ usageContext: zod_1.z.number().int().optional(),
167
176
  },
168
177
  response: Roblox_Web_Assets_AssetResponseItemV1,
169
178
  errors: [],
@@ -196,6 +205,7 @@ exports.getAliasAlias = (0, __1.endpoint)({
196
205
  * @param contentRepresentationPriorityList
197
206
  * @param assetResolutionMode
198
207
  * @param accessContext
208
+ * @param usageContext
199
209
  */
200
210
  exports.getAsset = (0, __1.endpoint)({
201
211
  method: 'GET',
@@ -301,6 +311,10 @@ exports.getAsset = (0, __1.endpoint)({
301
311
  style: 'form',
302
312
  explode: true,
303
313
  },
314
+ usageContext: {
315
+ style: 'form',
316
+ explode: true,
317
+ },
304
318
  },
305
319
  parameters: {
306
320
  'Accept-Encoding': zod_1.z.string(),
@@ -329,6 +343,7 @@ exports.getAsset = (0, __1.endpoint)({
329
343
  contentRepresentationPriorityList: zod_1.z.string().optional(),
330
344
  assetResolutionMode: zod_1.z.string().optional(),
331
345
  accessContext: zod_1.z.string().optional(),
346
+ usageContext: zod_1.z.number().int().optional(),
332
347
  },
333
348
  response: zod_1.z.void(),
334
349
  errors: [],
@@ -352,6 +367,7 @@ exports.getAsset = (0, __1.endpoint)({
352
367
  * @param doNotFallbackToBaselineRepresentation
353
368
  * @param contentRepresentationPriorityList
354
369
  * @param accessContext
370
+ * @param usageContext
355
371
  */
356
372
  exports.getAssetidAssetid = (0, __1.endpoint)({
357
373
  method: 'GET',
@@ -416,6 +432,10 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
416
432
  style: 'form',
417
433
  explode: true,
418
434
  },
435
+ usageContext: {
436
+ style: 'form',
437
+ explode: true,
438
+ },
419
439
  },
420
440
  parameters: {
421
441
  assetId: zod_1.z.number().int(),
@@ -434,6 +454,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
434
454
  doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
435
455
  contentRepresentationPriorityList: zod_1.z.string().optional(),
436
456
  accessContext: zod_1.z.string().optional(),
457
+ usageContext: zod_1.z.number().int().optional(),
437
458
  },
438
459
  response: Roblox_Web_Assets_AssetResponseItemV1,
439
460
  errors: [],
@@ -458,6 +479,7 @@ exports.getAssetidAssetid = (0, __1.endpoint)({
458
479
  * @param doNotFallbackToBaselineRepresentation
459
480
  * @param contentRepresentationPriorityList
460
481
  * @param accessContext
482
+ * @param usageContext
461
483
  */
462
484
  exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
463
485
  method: 'GET',
@@ -525,6 +547,10 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
525
547
  style: 'form',
526
548
  explode: true,
527
549
  },
550
+ usageContext: {
551
+ style: 'form',
552
+ explode: true,
553
+ },
528
554
  },
529
555
  parameters: {
530
556
  assetId: zod_1.z.number().int(),
@@ -544,6 +570,7 @@ exports.getAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
544
570
  doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
545
571
  contentRepresentationPriorityList: zod_1.z.string().optional(),
546
572
  accessContext: zod_1.z.string().optional(),
573
+ usageContext: zod_1.z.number().int().optional(),
547
574
  },
548
575
  response: Roblox_Web_Assets_AssetResponseItemV1,
549
576
  errors: [],
@@ -702,6 +729,7 @@ exports.getMarassethashMarassethashMarchecksumMarchecksum = (0, __1.endpoint)({
702
729
  * @param doNotFallbackToBaselineRepresentation Whether to prevent fallback to baseline representation when specific content representations are not available.
703
730
  * @param contentRepresentationPriorityList Base64URL-encoded JSON string specifying the priority list of desired content representations (format, version, fidelity).
704
731
  * @param accessContext
732
+ * @param usageContext
705
733
  * @description Returns an object containing a `location` property which is a temporary CDN URL for the asset content. All asset types are supported.
706
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.
707
735
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}`.
@@ -771,6 +799,10 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
771
799
  style: 'form',
772
800
  explode: true,
773
801
  },
802
+ usageContext: {
803
+ style: 'form',
804
+ explode: true,
805
+ },
774
806
  },
775
807
  parameters: {
776
808
  assetId: zod_1.z.number().int(),
@@ -789,6 +821,7 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
789
821
  doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
790
822
  contentRepresentationPriorityList: zod_1.z.string().optional(),
791
823
  accessContext: zod_1.z.string().optional(),
824
+ usageContext: zod_1.z.number().int().optional(),
792
825
  },
793
826
  response: Roblox_Web_Assets_AssetResponseItemV1,
794
827
  errors: [
@@ -818,6 +851,7 @@ exports.getOpencloudAssetidAssetid = (0, __1.endpoint)({
818
851
  * @param doNotFallbackToBaselineRepresentation
819
852
  * @param contentRepresentationPriorityList
820
853
  * @param accessContext
854
+ * @param usageContext
821
855
  * @description Refer to the assetId endpoint for details on usage.
822
856
  This endpoint is expected to be called with API key authentication through `apis.roblox.com/asset-delivery-api/v1/assetId/{assetId}/version/{versionNumber}`.
823
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.
@@ -889,6 +923,10 @@ exports.getOpencloudAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
889
923
  style: 'form',
890
924
  explode: true,
891
925
  },
926
+ usageContext: {
927
+ style: 'form',
928
+ explode: true,
929
+ },
892
930
  },
893
931
  parameters: {
894
932
  assetId: zod_1.z.number().int(),
@@ -908,6 +946,7 @@ exports.getOpencloudAssetidAssetidVersionVersionnumber = (0, __1.endpoint)({
908
946
  doNotFallbackToBaselineRepresentation: zod_1.z.boolean().optional(),
909
947
  contentRepresentationPriorityList: zod_1.z.string().optional(),
910
948
  accessContext: zod_1.z.string().optional(),
949
+ usageContext: zod_1.z.number().int().optional(),
911
950
  },
912
951
  response: Roblox_Web_Assets_AssetResponseItemV1,
913
952
  errors: [
@@ -36,6 +36,8 @@ const Roblox_Web_Assets_IAssetItemError = z.object({
36
36
  "NotApprovedForRequestor",
37
37
  "NotApprovedByContentCompliance",
38
38
  "AssetContentRepresentationGenerating",
39
+ "AssetArchived",
40
+ "AssetUsageNotAllowed",
39
41
  ]),
40
42
  });
41
43
  const Roblox_Web_Assets_AssetContentRepresentationSpecifier = z.object({
@@ -75,6 +77,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
75
77
  "roblox-assetFormat": z.string(),
76
78
  assetResolutionMode: z.string(),
77
79
  accessContext: z.string(),
80
+ usageContext: z.number().int(),
78
81
  contentRepresentationPriorityList: z.string(),
79
82
  doNotFallbackToBaselineRepresentation: z.boolean(),
80
83
  });
@@ -95,6 +98,7 @@ const Roblox_Web_Assets_BatchAssetRequestItem = z.object({
95
98
  * @param serverplaceid
96
99
  * @param expectedAssetType
97
100
  * @param accessContext
101
+ * @param usageContext
98
102
  */
99
103
  export const getAliasAlias = endpoint({
100
104
  method: "GET",
@@ -151,6 +155,10 @@ export const getAliasAlias = endpoint({
151
155
  style: "form",
152
156
  explode: true,
153
157
  },
158
+ usageContext: {
159
+ style: "form",
160
+ explode: true,
161
+ },
154
162
  },
155
163
  parameters: {
156
164
  alias: z.string().regex(/^[0-9]+\/.+/),
@@ -167,6 +175,7 @@ export const getAliasAlias = endpoint({
167
175
  serverplaceid: z.number().int().optional(),
168
176
  expectedAssetType: z.string().optional(),
169
177
  accessContext: z.string().optional(),
178
+ usageContext: z.number().int().optional(),
170
179
  },
171
180
  response: Roblox_Web_Assets_AssetResponseItemV2,
172
181
  errors: [],
@@ -198,6 +207,7 @@ export const getAliasAlias = endpoint({
198
207
  * @param doNotFallbackToBaselineRepresentation
199
208
  * @param contentRepresentationPriorityList
200
209
  * @param accessContext
210
+ * @param usageContext
201
211
  */
202
212
  export const getAsset = endpoint({
203
213
  method: "GET",
@@ -299,6 +309,10 @@ export const getAsset = endpoint({
299
309
  style: "form",
300
310
  explode: true,
301
311
  },
312
+ usageContext: {
313
+ style: "form",
314
+ explode: true,
315
+ },
302
316
  },
303
317
  parameters: {
304
318
  "Accept-Encoding": z.string(),
@@ -326,6 +340,7 @@ export const getAsset = endpoint({
326
340
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
327
341
  contentRepresentationPriorityList: z.string().optional(),
328
342
  accessContext: z.string().optional(),
343
+ usageContext: z.number().int().optional(),
329
344
  },
330
345
  response: Roblox_Web_Assets_AssetResponseItemV2,
331
346
  errors: [],
@@ -348,6 +363,7 @@ export const getAsset = endpoint({
348
363
  * @param doNotFallbackToBaselineRepresentation
349
364
  * @param contentRepresentationPriorityList
350
365
  * @param accessContext
366
+ * @param usageContext
351
367
  */
352
368
  export const getAssetidAssetid = endpoint({
353
369
  method: "GET",
@@ -412,6 +428,10 @@ export const getAssetidAssetid = endpoint({
412
428
  style: "form",
413
429
  explode: true,
414
430
  },
431
+ usageContext: {
432
+ style: "form",
433
+ explode: true,
434
+ },
415
435
  },
416
436
  parameters: {
417
437
  assetId: z.number().int(),
@@ -430,6 +450,7 @@ export const getAssetidAssetid = endpoint({
430
450
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
431
451
  contentRepresentationPriorityList: z.string().optional(),
432
452
  accessContext: z.string().optional(),
453
+ usageContext: z.number().int().optional(),
433
454
  },
434
455
  response: Roblox_Web_Assets_AssetResponseItemV2,
435
456
  errors: [],
@@ -453,6 +474,7 @@ export const getAssetidAssetid = endpoint({
453
474
  * @param doNotFallbackToBaselineRepresentation
454
475
  * @param contentRepresentationPriorityList
455
476
  * @param accessContext
477
+ * @param usageContext
456
478
  */
457
479
  export const getAssetidAssetidVersionVersionnumber = endpoint({
458
480
  method: "GET",
@@ -520,6 +542,10 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
520
542
  style: "form",
521
543
  explode: true,
522
544
  },
545
+ usageContext: {
546
+ style: "form",
547
+ explode: true,
548
+ },
523
549
  },
524
550
  parameters: {
525
551
  assetId: z.number().int(),
@@ -539,6 +565,7 @@ export const getAssetidAssetidVersionVersionnumber = endpoint({
539
565
  doNotFallbackToBaselineRepresentation: z.boolean().optional(),
540
566
  contentRepresentationPriorityList: z.string().optional(),
541
567
  accessContext: z.string().optional(),
568
+ usageContext: z.number().int().optional(),
542
569
  },
543
570
  response: Roblox_Web_Assets_AssetResponseItemV2,
544
571
  errors: [],