rozod 6.2.0 → 6.3.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 (50) hide show
  1. package/lib/endpoints/authv1.d.ts +48 -0
  2. package/lib/endpoints/authv1.js +49 -2
  3. package/lib/endpoints/avatarv1.d.ts +1 -0
  4. package/lib/endpoints/avatarv1.js +1 -0
  5. package/lib/endpoints/avatarv2.d.ts +1 -0
  6. package/lib/endpoints/avatarv2.js +1 -0
  7. package/lib/endpoints/avatarv3.d.ts +1 -0
  8. package/lib/endpoints/avatarv3.js +1 -0
  9. package/lib/endpoints/badgesv1.d.ts +0 -20
  10. package/lib/endpoints/badgesv1.js +0 -20
  11. package/lib/endpoints/catalogv1.d.ts +2 -70
  12. package/lib/endpoints/catalogv1.js +2 -70
  13. package/lib/endpoints/clientsettingsv2.d.ts +1 -0
  14. package/lib/endpoints/clientsettingsv2.js +1 -0
  15. package/lib/endpoints/friendsv1.d.ts +0 -75
  16. package/lib/endpoints/friendsv1.js +1 -68
  17. package/lib/endpoints/gamesv1.d.ts +4 -0
  18. package/lib/endpoints/gamesv1.js +4 -0
  19. package/lib/endpoints/groupsv1.d.ts +10 -4
  20. package/lib/endpoints/groupsv1.js +3 -2
  21. package/lib/endpoints/thumbnailsv1.d.ts +1 -0
  22. package/lib/endpoints/thumbnailsv1.js +1 -0
  23. package/lib/endpoints/twostepverificationv1.d.ts +1 -0
  24. package/lib/endpoints/twostepverificationv1.js +1 -0
  25. package/lib/index.d.ts +1 -0
  26. package/lib/opencloud/v1/asset-permissions.d.ts +7 -2
  27. package/lib/opencloud/v1/asset-permissions.js +9 -3
  28. package/lib/opencloud/v1/assets.d.ts +59 -32
  29. package/lib/opencloud/v1/assets.js +77 -41
  30. package/lib/opencloud/v1/datastores-ordered.d.ts +50 -14
  31. package/lib/opencloud/v1/datastores-ordered.js +62 -20
  32. package/lib/opencloud/v1/datastores.d.ts +99 -42
  33. package/lib/opencloud/v1/datastores.js +123 -50
  34. package/lib/opencloud/v1/developer-products.d.ts +29 -11
  35. package/lib/opencloud/v1/developer-products.js +37 -15
  36. package/lib/opencloud/v1/game-passes.d.ts +29 -11
  37. package/lib/opencloud/v1/game-passes.js +37 -15
  38. package/lib/opencloud/v1/messaging.d.ts +6 -2
  39. package/lib/opencloud/v1/messaging.js +8 -3
  40. package/lib/opencloud/v1/open-eval.d.ts +14 -4
  41. package/lib/opencloud/v1/open-eval.js +18 -6
  42. package/lib/opencloud/v1/secrets-store.d.ts +46 -26
  43. package/lib/opencloud/v1/secrets-store.js +56 -31
  44. package/lib/opencloud/v1/toolbox.d.ts +14 -6
  45. package/lib/opencloud/v1/toolbox.js +18 -8
  46. package/lib/opencloud/v1/universes.d.ts +6 -2
  47. package/lib/opencloud/v1/universes.js +8 -3
  48. package/lib/opencloud/v2/cloud.d.ts +854 -395
  49. package/lib/opencloud/v2/cloud.js +967 -395
  50. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.getUsersUseridFriendsStatuses = exports.getUsersUseridFriendsSearch = exports.getUsersUseridFriendsOnline = exports.getUsersUseridFriendsInactive = exports.getUsersUseridFriendsFind = exports.getUsersUseridFriendsCount = exports.getUsersUseridFriends = exports.postUsersTargetuseridUnfriend = exports.postUsersTargetuseridUnfollow = exports.postUsersTargetuseridRequestFriendship = exports.getUsersTargetuseridFollowingsCount = exports.getUsersTargetuseridFollowings = exports.getUsersTargetuseridFollowersCount = exports.getUsersTargetuseridFollowers = exports.postUsersTargetuseridFollow = exports.postUsersSenderuseridAcceptFriendRequestWithToken = exports.postUsersRequesteruseridDeclineFriendRequest = exports.postUsersRequesteruseridAcceptFriendRequest = exports.postUserFriendRequestsDeclineAll = exports.getUserFriendRequestsCount = exports.postUserFollowingExists = exports.getUserUseridMultigetAreTrustedFriends = exports.postUserUseridMultigetAreFriends = exports.getMyTrustedFriendsUseridStatus = exports.getMyNewFriendRequestsCount = exports.deleteMyNewFriendRequests = exports.getMyFriendsRequests = exports.postMyFriendsRefreshQrSession = exports.getMyFriendsCount = exports.getMyFriendsUseridCheckQrSession = exports.getMetadata = exports.postContactsTargetcontactidRequestFriendship = void 0;
3
+ exports.getUsersUseridFriendsStatuses = exports.getUsersUseridFriendsSearch = exports.getUsersUseridFriendsOnline = exports.getUsersUseridFriendsInactive = exports.getUsersUseridFriendsFind = exports.getUsersUseridFriendsCount = exports.getUsersUseridFriends = exports.postUsersTargetuseridUnfriend = exports.postUsersTargetuseridUnfollow = exports.postUsersTargetuseridRequestFriendship = exports.getUsersTargetuseridFollowingsCount = exports.getUsersTargetuseridFollowings = exports.getUsersTargetuseridFollowersCount = exports.getUsersTargetuseridFollowers = exports.postUsersTargetuseridFollow = exports.postUsersSenderuseridAcceptFriendRequestWithToken = exports.postUsersRequesteruseridDeclineFriendRequest = exports.postUsersRequesteruseridAcceptFriendRequest = exports.postUserFriendRequestsDeclineAll = exports.getUserFriendRequestsCount = exports.postUserFollowingExists = exports.postUserUseridMultigetAreFriends = exports.getMyNewFriendRequestsCount = exports.deleteMyNewFriendRequests = exports.getMyFriendsRequests = exports.postMyFriendsRefreshQrSession = exports.getMyFriendsCount = exports.getMyFriendsUseridCheckQrSession = exports.getMetadata = exports.postContactsTargetcontactidRequestFriendship = void 0;
4
4
  const zod_1 = require("zod");
5
5
  const __1 = require("..");
6
6
  const Roblox_Friends_Api_Models_Response_FriendsPageMetadataResponse = zod_1.z.object({
@@ -51,12 +51,6 @@ const Roblox_Web_WebAPI_Models_ApiPageResponse_Roblox_Friends_Api_FriendRequestR
51
51
  data: zod_1.z.array(Roblox_Friends_Api_FriendRequestResponse),
52
52
  });
53
53
  const Roblox_Friends_Api_Models_Response_NewFriendRequestsCountResponse = zod_1.z.object({ count: zod_1.z.number().int() });
54
- const Roblox_Friends_Api_TrustedFriendStatusResponse = zod_1.z.object({
55
- status: zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(3), zod_1.z.literal(4), zod_1.z.literal(5), zod_1.z.literal(6)]),
56
- });
57
- const Roblox_Friends_Api_MultigetAreTrustedFriendsResponse = zod_1.z.object({
58
- trustedFriendsId: zod_1.z.array(zod_1.z.number()),
59
- });
60
54
  const Roblox_Friends_Api_PendingFriendRequestCountModel = zod_1.z.object({
61
55
  count: zod_1.z.number().int(),
62
56
  });
@@ -394,36 +388,6 @@ exports.getMyNewFriendRequestsCount = (0, __1.endpoint)({
394
388
  },
395
389
  ],
396
390
  });
397
- /**
398
- * @api GET https://friends.roblox.com/v1/my/trusted-friends/:userId/status
399
- * @summary Gets trusted friend status of a specified user against the requesting user.
400
- * @param userId The user to check the trusted friend status for.
401
- */
402
- exports.getMyTrustedFriendsUseridStatus = (0, __1.endpoint)({
403
- method: 'GET',
404
- path: '/v1/my/trusted-friends/:userId/status',
405
- baseUrl: 'https://friends.roblox.com',
406
- requestFormat: 'json',
407
- serializationMethod: {
408
- userId: {
409
- style: 'simple',
410
- },
411
- },
412
- parameters: {
413
- userId: zod_1.z.number().int(),
414
- },
415
- response: Roblox_Friends_Api_TrustedFriendStatusResponse,
416
- errors: [
417
- {
418
- status: 400,
419
- description: `1: The target user is invalid or does not exist.`,
420
- },
421
- {
422
- status: 401,
423
- description: `0: Authorization has been denied for this request.`,
424
- },
425
- ],
426
- });
427
391
  /**
428
392
  * @api POST https://friends.roblox.com/v1/user/:userId/multiget-are-friends
429
393
  * @summary Check if the requesting user is friends with the specified users.
@@ -457,37 +421,6 @@ exports.postUserUseridMultigetAreFriends = (0, __1.endpoint)({
457
421
  },
458
422
  ],
459
423
  });
460
- /**
461
- * @api GET https://friends.roblox.com/v1/user/:userId/multiget-are-trusted-friends
462
- * @summary Check if the requesting user is trusted friends with the specified users.
463
- * @param userId The requesting userId.
464
- * @param userIds The user ids to check against with the requesting user.
465
- */
466
- exports.getUserUseridMultigetAreTrustedFriends = (0, __1.endpoint)({
467
- method: 'GET',
468
- path: '/v1/user/:userId/multiget-are-trusted-friends',
469
- baseUrl: 'https://friends.roblox.com',
470
- requestFormat: 'json',
471
- serializationMethod: {
472
- userId: {
473
- style: 'simple',
474
- },
475
- userIds: {
476
- style: 'form',
477
- },
478
- },
479
- parameters: {
480
- userId: zod_1.z.number().int(),
481
- userIds: zod_1.z.array(zod_1.z.number()),
482
- },
483
- response: Roblox_Friends_Api_MultigetAreTrustedFriendsResponse,
484
- errors: [
485
- {
486
- status: 400,
487
- description: `1: The target user is invalid or does not exist.`,
488
- },
489
- ],
490
- });
491
424
  /**
492
425
  * @api POST https://friends.roblox.com/v1/user/following-exists
493
426
  * @summary Returns whether or not the current user is following each userId in a list of userIds
@@ -349,6 +349,10 @@ export const getGames = endpoint({
349
349
  description: `8: The universe IDs specified are invalid.
350
350
  9: Too many universe IDs were requested.`,
351
351
  },
352
+ {
353
+ status: 429,
354
+ description: `4: Too many requests have been made.`,
355
+ },
352
356
  ],
353
357
  });
354
358
  /**
@@ -341,6 +341,10 @@ exports.getGames = (0, __1.endpoint)({
341
341
  description: `8: The universe IDs specified are invalid.
342
342
  9: Too many universe IDs were requested.`,
343
343
  },
344
+ {
345
+ status: 429,
346
+ description: `4: Too many requests have been made.`,
347
+ },
344
348
  ],
345
349
  });
346
350
  /**
@@ -341,8 +341,15 @@ const Roblox_Groups_Api_SocialLinkResponse = z.object({
341
341
  url: z.string(),
342
342
  title: z.string(),
343
343
  });
344
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_SocialLinkResponse_ =
345
- z.object({ data: z.array(Roblox_Groups_Api_SocialLinkResponse) });
344
+ const Roblox_Groups_Api_GetSocialLinkResponse = z.object({
345
+ data: z.array(Roblox_Groups_Api_SocialLinkResponse),
346
+ socialLinksVerificationStatus: z.union([
347
+ z.literal(0),
348
+ z.literal(1),
349
+ z.literal(2),
350
+ z.literal(3),
351
+ ]),
352
+ });
346
353
  const Roblox_Groups_Api_SocialLinkRequest = z.object({
347
354
  type: z.union([
348
355
  z.literal(0),
@@ -2894,8 +2901,7 @@ export const getGroupsGroupidSocialLinks = endpoint({
2894
2901
  parameters: {
2895
2902
  groupId: z.number().int(),
2896
2903
  },
2897
- response:
2898
- Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_SocialLinkResponse_,
2904
+ response: Roblox_Groups_Api_GetSocialLinkResponse,
2899
2905
  errors: [
2900
2906
  {
2901
2907
  status: 400,
@@ -314,8 +314,9 @@ const Roblox_Groups_Api_SocialLinkResponse = zod_1.z.object({
314
314
  url: zod_1.z.string(),
315
315
  title: zod_1.z.string(),
316
316
  });
317
- const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_SocialLinkResponse_ = zod_1.z.object({
317
+ const Roblox_Groups_Api_GetSocialLinkResponse = zod_1.z.object({
318
318
  data: zod_1.z.array(Roblox_Groups_Api_SocialLinkResponse),
319
+ socialLinksVerificationStatus: zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(3)]),
319
320
  });
320
321
  const Roblox_Groups_Api_SocialLinkRequest = zod_1.z.object({
321
322
  type: zod_1.z.union([
@@ -2847,7 +2848,7 @@ exports.getGroupsGroupidSocialLinks = (0, __1.endpoint)({
2847
2848
  parameters: {
2848
2849
  groupId: zod_1.z.number().int(),
2849
2850
  },
2850
- response: Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Groups_Api_SocialLinkResponse_,
2851
+ response: Roblox_Groups_Api_GetSocialLinkResponse,
2851
2852
  errors: [
2852
2853
  {
2853
2854
  status: 400,
@@ -64,6 +64,7 @@ const Roblox_Thumbnails_Apis_Models_ThumbnailBatchRequest = z.object({
64
64
  format: z.string(),
65
65
  isCircular: z.boolean(),
66
66
  accessContext: z.string(),
67
+ headShape: z.string(),
67
68
  });
68
69
  const Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse = z.object({
69
70
  requestId: z.string(),
@@ -57,6 +57,7 @@ const Roblox_Thumbnails_Apis_Models_ThumbnailBatchRequest = zod_1.z.object({
57
57
  format: zod_1.z.string(),
58
58
  isCircular: zod_1.z.boolean(),
59
59
  accessContext: zod_1.z.string(),
60
+ headShape: zod_1.z.string(),
60
61
  });
61
62
  const Roblox_Web_Responses_Thumbnails_ThumbnailBatchResponse = zod_1.z.object({
62
63
  requestId: zod_1.z.string(),
@@ -32,6 +32,7 @@ const Roblox_TwoStepVerification_Api_MetadataResponse = z.object({
32
32
  maskedUserEmail: z.string(),
33
33
  isUserU13: z.boolean(),
34
34
  isDelayedUiEnabled: z.boolean(),
35
+ is2svRecoveryEnabled: z.boolean(),
35
36
  });
36
37
  const Roblox_TwoStepVerification_Api_UserConfigurationMethod = z.object({
37
38
  mediaType: z.union([
@@ -34,6 +34,7 @@ const Roblox_TwoStepVerification_Api_MetadataResponse = zod_1.z.object({
34
34
  maskedUserEmail: zod_1.z.string(),
35
35
  isUserU13: zod_1.z.boolean(),
36
36
  isDelayedUiEnabled: zod_1.z.boolean(),
37
+ is2svRecoveryEnabled: zod_1.z.boolean(),
37
38
  });
38
39
  const Roblox_TwoStepVerification_Api_UserConfigurationMethod = zod_1.z.object({
39
40
  mediaType: zod_1.z.union([
package/lib/index.d.ts CHANGED
@@ -18,6 +18,7 @@ type EndpointBase = {
18
18
  status: number;
19
19
  description?: string;
20
20
  }[];
21
+ scopes?: string[];
21
22
  };
22
23
  export type EndpointSchema = EndpointBase & {
23
24
  parameters?: any;
@@ -1,8 +1,13 @@
1
1
  /**
2
- * @api PATCH https://apis.roblox.com/cloud/asset-permissions-api/v1/assets/permissions
3
- * @summary Grant a subject permission to multiple assets.
2
+ * `BETA`
3
+ *
4
+ * Grant a subject permission to multiple assets.
4
5
 
5
6
  Authorization is required to grant permissions to the subject and asset IDs in the request.
7
+ *
8
+ * **Scopes:** `asset-permissions:write`
9
+ * **Engine:** Not available in-engine
10
+ *
6
11
  * @param body
7
12
  */
8
13
  export declare const patchAssetPermissionsApiV1AssetsPermissions: import("../..").EndpointGeneric<{}, {
@@ -41,16 +41,22 @@ const BatchGrantPermissionsResponse = zod_1.z.object({
41
41
  const Error = zod_1.z.object({ code: ErrorCode, message: zod_1.z.string().nullable() });
42
42
  const ErrorResponse = zod_1.z.object({ error: Error });
43
43
  /**
44
- * @api PATCH https://apis.roblox.com/cloud/asset-permissions-api/v1/assets/permissions
45
- * @summary Grant a subject permission to multiple assets.
44
+ * `BETA`
45
+ *
46
+ * Grant a subject permission to multiple assets.
46
47
 
47
48
  Authorization is required to grant permissions to the subject and asset IDs in the request.
49
+ *
50
+ * **Scopes:** `asset-permissions:write`
51
+ * **Engine:** Not available in-engine
52
+ *
48
53
  * @param body
49
54
  */
50
55
  exports.patchAssetPermissionsApiV1AssetsPermissions = (0, __1.endpoint)({
51
56
  method: 'PATCH',
52
57
  path: '/asset-permissions-api/v1/assets/permissions',
53
- baseUrl: 'https://apis.roblox.com/cloud',
58
+ baseUrl: 'https://apis.roblox.com',
59
+ scopes: ['asset-permissions:write'],
54
60
  requestFormat: 'json',
55
61
  serializationMethod: {
56
62
  body: {},
@@ -1,12 +1,15 @@
1
1
  /**
2
- * @api POST https://apis.roblox.com/cloud/v1/assets
3
- * @summary Creates an asset with provided content and metadata.
4
- * @param body
5
- * @description Creates an asset with provided content and metadata.
2
+ * **Create Asset** · `BETA`
3
+ *
4
+ * Creates an asset with provided content and metadata.
6
5
 
7
6
  You can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).
8
7
 
9
8
  Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
9
+ *
10
+ * **Scopes:** `asset:read`, `asset:write`
11
+ *
12
+ * @param body
10
13
  */
11
14
  export declare const postAssets: import("../..").EndpointGeneric<{}, {
12
15
  path: string;
@@ -79,11 +82,14 @@ export declare const postAssets: import("../..").EndpointGeneric<{}, {
79
82
  fileContent: File;
80
83
  }>;
81
84
  /**
82
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId
83
- * @summary Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.
85
+ * **Get Asset** · `BETA`
86
+ *
87
+ * Retrieve specific asset metadata.
88
+ *
89
+ * **Scopes:** `asset:read`
90
+ *
84
91
  * @param assetId The unique identifier of the asset.
85
92
  * @param readMask Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
86
- * @description Retrieve specific asset metadata.
87
93
  */
88
94
  export declare const getAssetsAssetId: import("../..").EndpointGeneric<{
89
95
  assetId: string;
@@ -119,14 +125,17 @@ export declare const getAssetsAssetId: import("../..").EndpointGeneric<{
119
125
  };
120
126
  }, undefined>;
121
127
  /**
122
- * @api PATCH https://apis.roblox.com/cloud/v1/assets/:assetId
123
- * @summary Updates an asset with provided content and metadata.
128
+ * **Update Asset** · `BETA`
129
+ *
130
+ * Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
131
+
132
+ Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
133
+ *
134
+ * **Scopes:** `asset:read`, `asset:write`
135
+ *
124
136
  * @param body
125
137
  * @param assetId The unique identifier of the asset.
126
138
  * @param updateMask Asset metadata fields to update, including the description, display name, icon, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
127
- * @description Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
128
-
129
- Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
130
139
  */
131
140
  export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
132
141
  assetId: string;
@@ -202,10 +211,13 @@ export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
202
211
  fileContent: File;
203
212
  }>;
204
213
  /**
205
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:archive
206
- * @summary Archives the asset.
214
+ * **Archive Asset** · `BETA`
215
+ *
216
+ * Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
217
+ *
218
+ * **Scopes:** `asset:read`, `asset:write`
219
+ *
207
220
  * @param assetId The unique identifier of the asset.
208
- * @description Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
209
221
  */
210
222
  export declare const postAssetsAssetIdArchive: import("../..").EndpointGeneric<{
211
223
  assetId: string;
@@ -240,10 +252,13 @@ export declare const postAssetsAssetIdArchive: import("../..").EndpointGeneric<{
240
252
  };
241
253
  }, undefined>;
242
254
  /**
243
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:restore
244
- * @summary Restores an archived asset.
255
+ * **Restore Asset** · `BETA`
256
+ *
257
+ * Restores an archived asset.
258
+ *
259
+ * **Scopes:** `asset:read`, `asset:write`
260
+ *
245
261
  * @param assetId The unique identifier of the asset.
246
- * @description Restores an archived asset.
247
262
  */
248
263
  export declare const postAssetsAssetIdRestore: import("../..").EndpointGeneric<{
249
264
  assetId: string;
@@ -278,12 +293,15 @@ export declare const postAssetsAssetIdRestore: import("../..").EndpointGeneric<{
278
293
  };
279
294
  }, undefined>;
280
295
  /**
281
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions
282
- * @summary List Asset Versions of an Asset
296
+ * **List Asset Versions** · `BETA`
297
+ *
298
+ * List all versions of a specific asset, with optional pagination.
299
+ *
300
+ * **Scopes:** `asset:read`
301
+ *
283
302
  * @param assetId The unique identifier of the asset.
284
303
  * @param maxPageSize Specifies the number of asset versions to include in the response. Valid values range from 1 to 50 (inclusive). Defaults to 8 when not provided.
285
304
  * @param pageToken A token for pagination. The value is obtained from a previous request and allows for retrieving the next page of asset versions.
286
- * @description List all versions of a specific asset, with optional pagination.
287
305
  */
288
306
  export declare const getAssetsAssetIdVersions: import("../..").EndpointGeneric<{
289
307
  assetId: string;
@@ -305,13 +323,16 @@ export declare const getAssetsAssetIdVersions: import("../..").EndpointGeneric<{
305
323
  published: boolean;
306
324
  }[], undefined>;
307
325
  /**
308
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId/versions:rollback
309
- * @summary Rollback an asset to a previous version.
310
- * @param body
311
- * @param assetId The unique identifier of the asset.
312
- * @description Rollback an asset to a specific previous version.
326
+ * **Rollback Asset Version** · `BETA`
327
+ *
328
+ * Rollback an asset to a specific previous version.
313
329
 
314
330
  Provide the asset version path in the form data.
331
+ *
332
+ * **Scopes:** `asset:read`, `asset:write`
333
+ *
334
+ * @param body
335
+ * @param assetId The unique identifier of the asset.
315
336
  */
316
337
  export declare const postAssetsAssetIdVersionsRollback: import("../..").EndpointGeneric<{
317
338
  assetId: string;
@@ -333,11 +354,14 @@ export declare const postAssetsAssetIdVersionsRollback: import("../..").Endpoint
333
354
  assetVersion: string;
334
355
  }>;
335
356
  /**
336
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions/:versionNumber
337
- * @summary Get Asset Version
357
+ * **Get Asset Version** · `BETA`
358
+ *
359
+ * Retrieve a specific asset version by the asset ID and the version number.
360
+ *
361
+ * **Scopes:** `asset:read`
362
+ *
338
363
  * @param assetId The unique identifier of the asset.
339
364
  * @param versionNumber The version number.
340
- * @description Retrieve a specific asset version by the asset ID and the version number.
341
365
  */
342
366
  export declare const getAssetsAssetIdVersionsVersionNumber: import("../..").EndpointGeneric<{
343
367
  assetId: string;
@@ -358,10 +382,13 @@ export declare const getAssetsAssetIdVersionsVersionNumber: import("../..").Endp
358
382
  published: boolean;
359
383
  }, undefined>;
360
384
  /**
361
- * @api GET https://apis.roblox.com/cloud/v1/operations/:operationId
362
- * @summary Get the result of an asset creation or update.
385
+ * **Get Operation** · `BETA`
386
+ *
387
+ * Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
388
+ *
389
+ * **Scopes:** `asset:read`
390
+ *
363
391
  * @param operationId The unique identifier of the operation.
364
- * @description Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
365
392
  */
366
393
  export declare const getOperationsOperationId: import("../..").EndpointGeneric<{
367
394
  operationId: string;
@@ -50,19 +50,23 @@ const AssetVersion = zod_1.z.object({
50
50
  published: zod_1.z.boolean(),
51
51
  });
52
52
  /**
53
- * @api POST https://apis.roblox.com/cloud/v1/assets
54
- * @summary Creates an asset with provided content and metadata.
55
- * @param body
56
- * @description Creates an asset with provided content and metadata.
53
+ * **Create Asset** · `BETA`
54
+ *
55
+ * Creates an asset with provided content and metadata.
57
56
 
58
57
  You can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).
59
58
 
60
59
  Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
60
+ *
61
+ * **Scopes:** `asset:read`, `asset:write`
62
+ *
63
+ * @param body
61
64
  */
62
65
  exports.postAssets = (0, __1.endpoint)({
63
66
  method: 'POST',
64
67
  path: '/v1/assets',
65
- baseUrl: 'https://apis.roblox.com/cloud',
68
+ baseUrl: 'https://apis.roblox.com/assets',
69
+ scopes: ['asset:read', 'asset:write'],
66
70
  requestFormat: 'form-data',
67
71
  serializationMethod: {
68
72
  body: {},
@@ -86,16 +90,20 @@ exports.postAssets = (0, __1.endpoint)({
86
90
  ],
87
91
  });
88
92
  /**
89
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId
90
- * @summary Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.
93
+ * **Get Asset** · `BETA`
94
+ *
95
+ * Retrieve specific asset metadata.
96
+ *
97
+ * **Scopes:** `asset:read`
98
+ *
91
99
  * @param assetId The unique identifier of the asset.
92
100
  * @param readMask Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
93
- * @description Retrieve specific asset metadata.
94
101
  */
95
102
  exports.getAssetsAssetId = (0, __1.endpoint)({
96
103
  method: 'GET',
97
104
  path: '/v1/assets/:assetId',
98
- baseUrl: 'https://apis.roblox.com/cloud',
105
+ baseUrl: 'https://apis.roblox.com/assets',
106
+ scopes: ['asset:read'],
99
107
  requestFormat: 'json',
100
108
  serializationMethod: {
101
109
  assetId: {},
@@ -130,19 +138,23 @@ exports.getAssetsAssetId = (0, __1.endpoint)({
130
138
  ],
131
139
  });
132
140
  /**
133
- * @api PATCH https://apis.roblox.com/cloud/v1/assets/:assetId
134
- * @summary Updates an asset with provided content and metadata.
141
+ * **Update Asset** · `BETA`
142
+ *
143
+ * Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
144
+
145
+ Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
146
+ *
147
+ * **Scopes:** `asset:read`, `asset:write`
148
+ *
135
149
  * @param body
136
150
  * @param assetId The unique identifier of the asset.
137
151
  * @param updateMask Asset metadata fields to update, including the description, display name, icon, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
138
- * @description Updates an asset with provided content and metadata, including the description, display name, icon, social links, and previews. Currently can only update the content body for **Models**. Icons and Previews must be **Image** assets. Icons must have square dimensions.
139
-
140
- Provide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.
141
152
  */
142
153
  exports.patchAssetsAssetId = (0, __1.endpoint)({
143
154
  method: 'PATCH',
144
155
  path: '/v1/assets/:assetId',
145
- baseUrl: 'https://apis.roblox.com/cloud',
156
+ baseUrl: 'https://apis.roblox.com/assets',
157
+ scopes: ['asset:read', 'asset:write'],
146
158
  requestFormat: 'form-data',
147
159
  serializationMethod: {
148
160
  body: {},
@@ -171,15 +183,19 @@ exports.patchAssetsAssetId = (0, __1.endpoint)({
171
183
  ],
172
184
  });
173
185
  /**
174
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:archive
175
- * @summary Archives the asset.
186
+ * **Archive Asset** · `BETA`
187
+ *
188
+ * Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
189
+ *
190
+ * **Scopes:** `asset:read`, `asset:write`
191
+ *
176
192
  * @param assetId The unique identifier of the asset.
177
- * @description Archives the asset. Archived assets disappear from the website and are no longer usable or visible in Roblox experiences, but you can [restore](#POST-v1-assets-{assetId}:restore) them.
178
193
  */
179
194
  exports.postAssetsAssetIdArchive = (0, __1.endpoint)({
180
195
  method: 'POST',
181
196
  path: '/v1/assets/:assetId:archive',
182
- baseUrl: 'https://apis.roblox.com/cloud',
197
+ baseUrl: 'https://apis.roblox.com/assets',
198
+ scopes: ['asset:read', 'asset:write'],
183
199
  requestFormat: 'json',
184
200
  serializationMethod: {
185
201
  assetId: {},
@@ -204,15 +220,19 @@ exports.postAssetsAssetIdArchive = (0, __1.endpoint)({
204
220
  ],
205
221
  });
206
222
  /**
207
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:restore
208
- * @summary Restores an archived asset.
223
+ * **Restore Asset** · `BETA`
224
+ *
225
+ * Restores an archived asset.
226
+ *
227
+ * **Scopes:** `asset:read`, `asset:write`
228
+ *
209
229
  * @param assetId The unique identifier of the asset.
210
- * @description Restores an archived asset.
211
230
  */
212
231
  exports.postAssetsAssetIdRestore = (0, __1.endpoint)({
213
232
  method: 'POST',
214
233
  path: '/v1/assets/:assetId:restore',
215
- baseUrl: 'https://apis.roblox.com/cloud',
234
+ baseUrl: 'https://apis.roblox.com/assets',
235
+ scopes: ['asset:read', 'asset:write'],
216
236
  requestFormat: 'json',
217
237
  serializationMethod: {
218
238
  assetId: {},
@@ -237,17 +257,21 @@ exports.postAssetsAssetIdRestore = (0, __1.endpoint)({
237
257
  ],
238
258
  });
239
259
  /**
240
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions
241
- * @summary List Asset Versions of an Asset
260
+ * **List Asset Versions** · `BETA`
261
+ *
262
+ * List all versions of a specific asset, with optional pagination.
263
+ *
264
+ * **Scopes:** `asset:read`
265
+ *
242
266
  * @param assetId The unique identifier of the asset.
243
267
  * @param maxPageSize Specifies the number of asset versions to include in the response. Valid values range from 1 to 50 (inclusive). Defaults to 8 when not provided.
244
268
  * @param pageToken A token for pagination. The value is obtained from a previous request and allows for retrieving the next page of asset versions.
245
- * @description List all versions of a specific asset, with optional pagination.
246
269
  */
247
270
  exports.getAssetsAssetIdVersions = (0, __1.endpoint)({
248
271
  method: 'GET',
249
272
  path: '/v1/assets/:assetId/versions',
250
- baseUrl: 'https://apis.roblox.com/cloud',
273
+ baseUrl: 'https://apis.roblox.com/assets',
274
+ scopes: ['asset:read'],
251
275
  requestFormat: 'json',
252
276
  serializationMethod: {
253
277
  assetId: {},
@@ -276,18 +300,22 @@ exports.getAssetsAssetIdVersions = (0, __1.endpoint)({
276
300
  ],
277
301
  });
278
302
  /**
279
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId/versions:rollback
280
- * @summary Rollback an asset to a previous version.
281
- * @param body
282
- * @param assetId The unique identifier of the asset.
283
- * @description Rollback an asset to a specific previous version.
303
+ * **Rollback Asset Version** · `BETA`
304
+ *
305
+ * Rollback an asset to a specific previous version.
284
306
 
285
307
  Provide the asset version path in the form data.
308
+ *
309
+ * **Scopes:** `asset:read`, `asset:write`
310
+ *
311
+ * @param body
312
+ * @param assetId The unique identifier of the asset.
286
313
  */
287
314
  exports.postAssetsAssetIdVersionsRollback = (0, __1.endpoint)({
288
315
  method: 'POST',
289
316
  path: '/v1/assets/:assetId/versions:rollback',
290
- baseUrl: 'https://apis.roblox.com/cloud',
317
+ baseUrl: 'https://apis.roblox.com/assets',
318
+ scopes: ['asset:read', 'asset:write'],
291
319
  requestFormat: 'form-data',
292
320
  serializationMethod: {
293
321
  body: {},
@@ -314,16 +342,20 @@ exports.postAssetsAssetIdVersionsRollback = (0, __1.endpoint)({
314
342
  ],
315
343
  });
316
344
  /**
317
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions/:versionNumber
318
- * @summary Get Asset Version
345
+ * **Get Asset Version** · `BETA`
346
+ *
347
+ * Retrieve a specific asset version by the asset ID and the version number.
348
+ *
349
+ * **Scopes:** `asset:read`
350
+ *
319
351
  * @param assetId The unique identifier of the asset.
320
352
  * @param versionNumber The version number.
321
- * @description Retrieve a specific asset version by the asset ID and the version number.
322
353
  */
323
354
  exports.getAssetsAssetIdVersionsVersionNumber = (0, __1.endpoint)({
324
355
  method: 'GET',
325
356
  path: '/v1/assets/:assetId/versions/:versionNumber',
326
- baseUrl: 'https://apis.roblox.com/cloud',
357
+ baseUrl: 'https://apis.roblox.com/assets',
358
+ scopes: ['asset:read'],
327
359
  requestFormat: 'json',
328
360
  serializationMethod: {
329
361
  assetId: {},
@@ -346,15 +378,19 @@ exports.getAssetsAssetIdVersionsVersionNumber = (0, __1.endpoint)({
346
378
  ],
347
379
  });
348
380
  /**
349
- * @api GET https://apis.roblox.com/cloud/v1/operations/:operationId
350
- * @summary Get the result of an asset creation or update.
381
+ * **Get Operation** · `BETA`
382
+ *
383
+ * Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
384
+ *
385
+ * **Scopes:** `asset:read`
386
+ *
351
387
  * @param operationId The unique identifier of the operation.
352
- * @description Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.
353
388
  */
354
389
  exports.getOperationsOperationId = (0, __1.endpoint)({
355
390
  method: 'GET',
356
391
  path: '/v1/operations/:operationId',
357
- baseUrl: 'https://apis.roblox.com/cloud',
392
+ baseUrl: 'https://apis.roblox.com/assets',
393
+ scopes: ['asset:read'],
358
394
  requestFormat: 'json',
359
395
  serializationMethod: {
360
396
  operationId: {},