rozod 6.2.0 → 6.4.0

package/lib/opencloud/v1/developer-products.js

@@ -83,16 +83,21 @@ const ListDeveloperProductConfigsV2Response = zod_1.z.object({
     nextPageToken: zod_1.z.string().nullable(),
 });
 /**
- * @api POST https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products
- * @summary Create developer product
+ * `BETA`
+ *
+ * Creates a new developer product with the provided configuration details.
+ *
+ * **Scopes:** `developer-product:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
- * @description Creates a new developer product with the provided configuration details.
  */
 exports.postDeveloperProductsV2UniversesUniverseIdDeveloperProducts = (0, __1.endpoint)({
     method: 'POST',
     path: '/developer-products/v2/universes/:universeId/developer-products',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['developer-product:write'],
     requestFormat: 'form-data',
     serializationMethod: {
         body: {},
@@ -123,18 +128,23 @@ exports.postDeveloperProductsV2UniversesUniverseIdDeveloperProducts = (0, __1.en
     ],
 });
 /**
- * @api PATCH https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId
- * @summary Update developer product
+ * `BETA`
+ *
+ * Updates a developer product with the provided configuration details.
+Note that only fields provided in the request will be updated.
+ *
+ * **Scopes:** `developer-product:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
  * @param productId The product ID of the developer product.
- * @description Updates a developer product with the provided configuration details.
-Note that only fields provided in the request will be updated.
  */
 exports.patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId = (0, __1.endpoint)({
     method: 'PATCH',
     path: '/developer-products/v2/universes/:universeId/developer-products/:productId',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['developer-product:write'],
     requestFormat: 'form-data',
     serializationMethod: {
         body: {},
@@ -171,15 +181,21 @@ exports.patchDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductId =
     ],
 });
 /**
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/:productId/creator
- * @summary Get developer product with configuration details
+ * `BETA`
+ *
+ * Get developer product with configuration details
+ *
+ * **Scopes:** `developer-product:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param productId The product ID of the developer product.
  */
 exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreator = (0, __1.endpoint)({
     method: 'GET',
     path: '/developer-products/v2/universes/:universeId/developer-products/:productId/creator',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['developer-product:read'],
     requestFormat: 'json',
     serializationMethod: {
         universeId: {},
@@ -206,8 +222,13 @@ exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreat
     ],
 });
 /**
- * @api GET https://apis.roblox.com/cloud/developer-products/v2/universes/:universeId/developer-products/creator
- * @summary List developer products by universe with configuration details
+ * `BETA`
+ *
+ * List developer products by universe with configuration details
+ *
+ * **Scopes:** `developer-product:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param pageSize The number of results to return. Defaults to 50.
  * @param pageToken The cursor token for pagination.
@@ -215,7 +236,8 @@ exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsProductIdCreat
 exports.getDeveloperProductsV2UniversesUniverseIdDeveloperProductsCreator = (0, __1.endpoint)({
     method: 'GET',
     path: '/developer-products/v2/universes/:universeId/developer-products/creator',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['developer-product:read'],
     requestFormat: 'json',
     serializationMethod: {
         universeId: {},

package/lib/opencloud/v1/game-passes.d.ts

@@ -1,9 +1,13 @@
 /**
- * @api POST https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes
- * @summary Create game pass
+ * `BETA`
+ *
+ * Creates a new game pass with the provided configuration details.
+ *
+ * **Scopes:** `game-pass:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
- * @description Creates a new game pass with the provided configuration details.
  */
 export declare const postGamePassesV1UniversesUniverseIdGamePasses: import("../..").EndpointGeneric<{
     universeId: number;
@@ -28,13 +32,17 @@ export declare const postGamePassesV1UniversesUniverseIdGamePasses: import("../.
     isRegionalPricingEnabled?: boolean | null | undefined;
 }>;
 /**
- * @api PATCH https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId
- * @summary Update game pass
+ * `BETA`
+ *
+ * Updates a game pass with the provided configuration details.
+Note that only fields provided in the request will be updated.
+ *
+ * **Scopes:** `game-pass:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
  * @param gamePassId The game pass ID.
- * @description Updates a game pass with the provided configuration details.
-Note that only fields provided in the request will be updated.
  */
 export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: import("../..").EndpointGeneric<{
     universeId: number;
@@ -48,8 +56,13 @@ export declare const patchGamePassesV1UniversesUniverseIdGamePassesGamePassId: i
     isRegionalPricingEnabled: boolean | null;
 }>;
 /**
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator
- * @summary Get game pass with configuration details
+ * `BETA`
+ *
+ * Get game pass with configuration details
+ *
+ * **Scopes:** `game-pass:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param gamePassId The game pass ID.
  */
@@ -70,8 +83,13 @@ export declare const getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreat
     } | null;
 }, undefined>;
 /**
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/creator
- * @summary List game passes by universe with configuration details
+ * `BETA`
+ *
+ * List game passes by universe with configuration details
+ *
+ * **Scopes:** `game-pass:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param pageSize The number of results to return. Defaults to 50 if not provided.
  * @param pageToken The cursor token for pagination.

package/lib/opencloud/v1/game-passes.js

@@ -70,16 +70,21 @@ const ListGamePassConfigsByUniverseResponse = zod_1.z.object({
     nextPageToken: zod_1.z.string().nullable(),
 });
 /**
- * @api POST https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes
- * @summary Create game pass
+ * `BETA`
+ *
+ * Creates a new game pass with the provided configuration details.
+ *
+ * **Scopes:** `game-pass:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
- * @description Creates a new game pass with the provided configuration details.
  */
 exports.postGamePassesV1UniversesUniverseIdGamePasses = (0, __1.endpoint)({
     method: 'POST',
     path: '/game-passes/v1/universes/:universeId/game-passes',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['game-pass:write'],
     requestFormat: 'form-data',
     serializationMethod: {
         body: {},
@@ -110,18 +115,23 @@ exports.postGamePassesV1UniversesUniverseIdGamePasses = (0, __1.endpoint)({
     ],
 });
 /**
- * @api PATCH https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId
- * @summary Update game pass
+ * `BETA`
+ *
+ * Updates a game pass with the provided configuration details.
+Note that only fields provided in the request will be updated.
+ *
+ * **Scopes:** `game-pass:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  * @param universeId The universe ID.
  * @param gamePassId The game pass ID.
- * @description Updates a game pass with the provided configuration details.
-Note that only fields provided in the request will be updated.
  */
 exports.patchGamePassesV1UniversesUniverseIdGamePassesGamePassId = (0, __1.endpoint)({
     method: 'PATCH',
     path: '/game-passes/v1/universes/:universeId/game-passes/:gamePassId',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['game-pass:write'],
     requestFormat: 'form-data',
     serializationMethod: {
         body: {},
@@ -158,15 +168,21 @@ exports.patchGamePassesV1UniversesUniverseIdGamePassesGamePassId = (0, __1.endpo
     ],
 });
 /**
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator
- * @summary Get game pass with configuration details
+ * `BETA`
+ *
+ * Get game pass with configuration details
+ *
+ * **Scopes:** `game-pass:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param gamePassId The game pass ID.
  */
 exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.endpoint)({
     method: 'GET',
     path: '/game-passes/v1/universes/:universeId/game-passes/:gamePassId/creator',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['game-pass:read'],
     requestFormat: 'json',
     serializationMethod: {
         universeId: {},
@@ -193,8 +209,13 @@ exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.
     ],
 });
 /**
- * @api GET https://apis.roblox.com/cloud/game-passes/v1/universes/:universeId/game-passes/creator
- * @summary List game passes by universe with configuration details
+ * `BETA`
+ *
+ * List game passes by universe with configuration details
+ *
+ * **Scopes:** `game-pass:read`
+ * **Engine:** Not available in-engine
+ *
  * @param universeId The universe ID.
  * @param pageSize The number of results to return. Defaults to 50 if not provided.
  * @param pageToken The cursor token for pagination.
@@ -202,7 +223,8 @@ exports.getGamePassesV1UniversesUniverseIdGamePassesGamePassIdCreator = (0, __1.
 exports.getGamePassesV1UniversesUniverseIdGamePassesCreator = (0, __1.endpoint)({
     method: 'GET',
     path: '/game-passes/v1/universes/:universeId/game-passes/creator',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['game-pass:read'],
     requestFormat: 'json',
     serializationMethod: {
         universeId: {},

package/lib/opencloud/v1/messaging.d.ts

@@ -1,9 +1,13 @@
 /**
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/topics/:topic
+ * **Publish a Message** · `BETA`
+ *
+ * Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-server messaging](/cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.
+ *
+ * **Scopes:** `universe-messaging-service:publish`
+ *
  * @param body
  * @param universeId The identifier of the experience in which you want to send your messages to. You can [copy your experience's Universe ID](/cloud/guides/usage-messaging.md#publishing-messages-to-live-servers) on **Creator Dashboard**.
  * @param topic The topic that you want to publish your message to, with up to 80 characters.
- * @description Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-server messaging](/cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.
  */
 export declare const postUniversesUniverseIdTopicsTopic: import("../..").EndpointGeneric<{
     universeId: number;

package/lib/opencloud/v1/messaging.js

@@ -5,16 +5,21 @@ const zod_1 = require("zod");
 const __1 = require("../..");
 const PublishRequest = zod_1.z.object({ message: zod_1.z.string().nullable() });
 /**
- * @api POST https://apis.roblox.com/cloud/v1/universes/:universeId/topics/:topic
+ * **Publish a Message** · `BETA`
+ *
+ * Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-server messaging](/cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.
+ *
+ * **Scopes:** `universe-messaging-service:publish`
+ *
  * @param body
  * @param universeId The identifier of the experience in which you want to send your messages to. You can [copy your experience's Universe ID](/cloud/guides/usage-messaging.md#publishing-messages-to-live-servers) on **Creator Dashboard**.
  * @param topic The topic that you want to publish your message to, with up to 80 characters.
- * @description Publish a message to a pre-defined topic of an experience, with the size of the message up to 1,024 characters (1 KB). Requires the **Publish** permission for API keys and the **universe-messaging-service:publish** scope for OAuth 2.0 apps. See [Cross-server messaging](/cloud-services/cross-server-messaging.md#subscribe-users-to-receive-messages) for defining and subscribing users to a topic.
  */
 exports.postUniversesUniverseIdTopicsTopic = (0, __1.endpoint)({
     method: 'POST',
     path: '/v1/universes/:universeId/topics/:topic',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com/messaging-service',
+    scopes: ['universe-messaging-service:publish'],
     requestFormat: 'json',
     serializationMethod: {
         body: {},

package/lib/opencloud/v1/open-eval.d.ts

@@ -1,6 +1,11 @@
 /**
- * @api POST https://apis.roblox.com/cloud/open-eval-api/v1/eval
- * @summary Performs the evaluation of the Lua script.
+ * `BETA`
+ *
+ * Performs the evaluation of the Lua script.
+ *
+ * **Scopes:** `studio-evaluations:create`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  */
 export declare const postOpenEvalApiV1Eval: import("../..").EndpointGeneric<{}, {
@@ -20,8 +25,13 @@ export declare const postOpenEvalApiV1Eval: import("../..").EndpointGeneric<{},
     } | undefined;
 }>;
 /**
- * @api GET https://apis.roblox.com/cloud/open-eval-api/v1/eval-records/:jobId
- * @summary Gets the evaluation record by job ID.
+ * `BETA`
+ *
+ * Gets the evaluation record by job ID.
+ *
+ * **Scopes:** `studio-evaluations:create`
+ * **Engine:** Not available in-engine
+ *
  * @param jobId The job ID of the evaluation record.
  */
 export declare const getOpenEvalApiV1EvalRecordsJobId: import("../..").EndpointGeneric<{

package/lib/opencloud/v1/open-eval.js

@@ -53,14 +53,20 @@ const EvalRecord = zod_1.z.object({
     createUtc: zod_1.z.string().nullish(),
 });
 /**
- * @api POST https://apis.roblox.com/cloud/open-eval-api/v1/eval
- * @summary Performs the evaluation of the Lua script.
+ * `BETA`
+ *
+ * Performs the evaluation of the Lua script.
+ *
+ * **Scopes:** `studio-evaluations:create`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  */
 exports.postOpenEvalApiV1Eval = (0, __1.endpoint)({
     method: 'POST',
     path: '/open-eval-api/v1/eval',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['studio-evaluations:create'],
     requestFormat: 'json',
     serializationMethod: {
         body: {},
@@ -71,14 +77,20 @@ exports.postOpenEvalApiV1Eval = (0, __1.endpoint)({
     errors: [],
 });
 /**
- * @api GET https://apis.roblox.com/cloud/open-eval-api/v1/eval-records/:jobId
- * @summary Gets the evaluation record by job ID.
+ * `BETA`
+ *
+ * Gets the evaluation record by job ID.
+ *
+ * **Scopes:** `studio-evaluations:create`
+ * **Engine:** Not available in-engine
+ *
  * @param jobId The job ID of the evaluation record.
  */
 exports.getOpenEvalApiV1EvalRecordsJobId = (0, __1.endpoint)({
     method: 'GET',
     path: '/open-eval-api/v1/eval-records/:jobId',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['studio-evaluations:create'],
     requestFormat: 'json',
     serializationMethod: {
         jobId: {},

package/lib/opencloud/v1/secrets-store.d.ts

@@ -1,9 +1,7 @@
 /**
- * @api POST https://apis.roblox.com/cloud/cloud/v2/universes/:universeId/secrets
- * @summary Create Secret
- * @param body The secret to create with encrypted content
- * @param universeId The universe ID
- * @description Creates a new secret. A maximum of 500 secrets per universe is allowed.
+ * `BETA`
+ *
+ * Creates a new secret. A maximum of 500 secrets per universe is allowed.
             
 Only the owner of the universe can create secrets. For group-owned universes, only the group owner or authorized
 members can create secrets.
@@ -16,6 +14,12 @@ To encrypt the secret:
 Include the key_id from the public key response in the request.
 
 For an example, see the [Secrets store guide](https://create.roblox.com/docs/cloud/guides/secrets-store).
+ *
+ * **Scopes:** `universe.secret:write`
+ * **Engine:** Not available in-engine
+ *
+ * @param body The secret to create with encrypted content
+ * @param universeId The universe ID
  */
 export declare const postCloudV2UniversesUniverseIdSecrets: import("../..").EndpointGeneric<{
     universeId: number;
@@ -35,16 +39,20 @@ export declare const postCloudV2UniversesUniverseIdSecrets: import("../..").Endp
     update_time: string | null;
 }>;
 /**
- * @api GET https://apis.roblox.com/cloud/cloud/v2/universes/:universeId/secrets
- * @summary List Secrets
- * @param universeId The universe ID
- * @param limit Number of secrets to return per page (1-500, default 10)
- * @param cursor Pagination cursor from previous response
- * @description Lists all secrets defined for a universe.
+ * `BETA`
+ *
+ * Lists all secrets defined for a universe.
 Secret content is not returned for security reasons - only metadata such as ID, domain, creation and update timestamps are included.
 
 Only the owner of the universe can list secrets. For group-owned universes, only the group owner or authorized
 members can list secrets.
+ *
+ * **Scopes:** `universe.secret:read`
+ * **Engine:** Not available in-engine
+ *
+ * @param universeId The universe ID
+ * @param limit Number of secrets to return per page (1-500, default 10)
+ * @param cursor Pagination cursor from previous response
  */
 export declare const getCloudV2UniversesUniverseIdSecrets: import("../..").EndpointGeneric<{
     universeId: number;
@@ -63,12 +71,9 @@ export declare const getCloudV2UniversesUniverseIdSecrets: import("../..").Endpo
     previousPageCursor: string | null;
 }, undefined>;
 /**
- * @api PATCH https://apis.roblox.com/cloud/cloud/v2/universes/:universeId/secrets/:secretId
- * @summary Update Secret
- * @param body The updated secret data with encrypted content
- * @param universeId The universe ID
- * @param secretId The ID of the secret to update
- * @description Updates an existing secret.
+ * `BETA`
+ *
+ * Updates an existing secret.
 
 Only the owner of the universe can update secrets. For group-owned universes, only the group owner or authorized
 members can update secrets.
@@ -83,6 +88,13 @@ To encrypt the updated secret:
 Include the key_id from the public key response in the request.
 
 For an example, see the [Secrets store guide](https://create.roblox.com/docs/cloud/guides/secrets-store).
+ *
+ * **Scopes:** `universe.secret:write`
+ * **Engine:** Not available in-engine
+ *
+ * @param body The updated secret data with encrypted content
+ * @param universeId The universe ID
+ * @param secretId The ID of the secret to update
  */
 export declare const patchCloudV2UniversesUniverseIdSecretsSecretId: import("../..").EndpointGeneric<{
     universeId: number;
@@ -103,26 +115,29 @@ export declare const patchCloudV2UniversesUniverseIdSecretsSecretId: import("../
     update_time: string | null;
 }>;
 /**
- * @api DELETE https://apis.roblox.com/cloud/cloud/v2/universes/:universeId/secrets/:secretId
- * @summary Delete Secret
- * @param universeId The universe ID
- * @param secretId The ID of the secret to delete
- * @description Permanently deletes a secret from a universe.
+ * `BETA`
+ *
+ * Permanently deletes a secret from a universe.
 
 Only the owner of the universe can delete secrets. For group-owned universes, only the group owner or authorized
 members can delete secrets.
 
 This operation is irreversible. Make sure you no longer need the secret before deleting it.
+ *
+ * **Scopes:** `universe.secret:write`
+ * **Engine:** Not available in-engine
+ *
+ * @param universeId The universe ID
+ * @param secretId The ID of the secret to delete
  */
 export declare const deleteCloudV2UniversesUniverseIdSecretsSecretId: import("../..").EndpointGeneric<{
     universeId: number;
     secretId: string;
 }, void, undefined>;
 /**
- * @api GET https://apis.roblox.com/cloud/cloud/v2/universes/:universeId/secrets/public-key
- * @summary Get Public Key
- * @param universeId The universe ID
- * @description Retrieves the public key for a universe. You need this key to encrypt secret content
+ * `BETA`
+ *
+ * Retrieves the public key for a universe. You need this key to encrypt secret content
 before sending it to Roblox.
 
 Only the owner of the universe can retrieve the public key. For group-owned universes, only the group owner or
@@ -135,6 +150,11 @@ Use this key with LibSodium sealed box encryption to encrypt your secret content
 creating or updating secrets.
 
 Include the key_id from the public key response in the request to create or update a secret.
+ *
+ * **Scopes:** `universe.secret:read`
+ * **Engine:** Not available in-engine
+ *
+ * @param universeId The universe ID
  */
 export declare const getCloudV2UniversesUniverseIdSecretsPublicKey: import("../..").EndpointGeneric<{
     universeId: number;