rozod 6.2.0 → 6.4.0

package/lib/endpoints/twostepverificationv1.js

@@ -36,15 +36,15 @@ const Roblox_TwoStepVerification_Api_MetadataResponse = zod_1.z.object({
     isDelayedUiEnabled: zod_1.z.boolean(),
 });
 const Roblox_TwoStepVerification_Api_UserConfigurationMethod = zod_1.z.object({
-    mediaType: 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),
-        zod_1.z.literal(7),
+    mediaType: zod_1.z.enum([
+        'Email',
+        'SMS',
+        'Authenticator',
+        'RecoveryCode',
+        'SecurityKey',
+        'CrossDevice',
+        'Password',
+        'Passkey',
     ]),
     enabled: zod_1.z.boolean(),
     updated: zod_1.z.string().datetime({ offset: true }),
@@ -68,16 +68,16 @@ const Roblox_TwoStepVerification_Api_RecoveryCodesStatusResponse = zod_1.z.objec
 });
 const Roblox_TwoStepVerification_Api_VerifyCodeRequest = zod_1.z.object({
     challengeId: zod_1.z.string(),
-    actionType: 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),
-        zod_1.z.literal(7),
-        zod_1.z.literal(8),
+    actionType: zod_1.z.enum([
+        'Unknown',
+        'Login',
+        'RobuxSpend',
+        'ItemTrade',
+        'Resale',
+        'PasswordReset',
+        'RevertAccount',
+        'Generic',
+        'GenericWithRecoveryCodes',
     ]),
     code: zod_1.z.string(),
 });
@@ -86,46 +86,46 @@ const Roblox_TwoStepVerification_Api_VerifyCodeResponse = zod_1.z.object({
 });
 const Roblox_TwoStepVerification_Api_RetractDialogRequest = zod_1.z.object({
     challengeId: zod_1.z.string(),
-    actionType: 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),
-        zod_1.z.literal(7),
-        zod_1.z.literal(8),
+    actionType: zod_1.z.enum([
+        'Unknown',
+        'Login',
+        'RobuxSpend',
+        'ItemTrade',
+        'Resale',
+        'PasswordReset',
+        'RevertAccount',
+        'Generic',
+        'GenericWithRecoveryCodes',
     ]),
 });
 const Roblox_TwoStepVerification_Api_RetractDialogResponse = zod_1.z.object({});
 const Roblox_TwoStepVerification_Api_RetryApprovalRequest = zod_1.z.object({
     challengeId: zod_1.z.string(),
-    actionType: 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),
-        zod_1.z.literal(7),
-        zod_1.z.literal(8),
+    actionType: zod_1.z.enum([
+        'Unknown',
+        'Login',
+        'RobuxSpend',
+        'ItemTrade',
+        'Resale',
+        'PasswordReset',
+        'RevertAccount',
+        'Generic',
+        'GenericWithRecoveryCodes',
     ]),
 });
 const Roblox_TwoStepVerification_Api_RetryApprovalResponse = zod_1.z.object({});
 const Roblox_TwoStepVerification_Api_VerifyApprovalRequest = zod_1.z.object({
     challengeId: zod_1.z.string(),
-    actionType: 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),
-        zod_1.z.literal(7),
-        zod_1.z.literal(8),
+    actionType: zod_1.z.enum([
+        'Unknown',
+        'Login',
+        'RobuxSpend',
+        'ItemTrade',
+        'Resale',
+        'PasswordReset',
+        'RevertAccount',
+        'Generic',
+        'GenericWithRecoveryCodes',
     ]),
 });
 const Roblox_TwoStepVerification_Api_VerifyApprovalResponse = zod_1.z.object({
@@ -133,16 +133,16 @@ const Roblox_TwoStepVerification_Api_VerifyApprovalResponse = zod_1.z.object({
 });
 const Roblox_TwoStepVerification_Api_SendCodeRequest = zod_1.z.object({
     challengeId: zod_1.z.string(),
-    actionType: 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),
-        zod_1.z.literal(7),
-        zod_1.z.literal(8),
+    actionType: zod_1.z.enum([
+        'Unknown',
+        'Login',
+        'RobuxSpend',
+        'ItemTrade',
+        'Resale',
+        'PasswordReset',
+        'RevertAccount',
+        'Generic',
+        'GenericWithRecoveryCodes',
     ]),
 });
 const Roblox_Web_WebAPI_ApiEmptyResponseModel = zod_1.z.object({});

package/lib/endpoints/usersv1.d.ts

@@ -21,7 +21,7 @@ const Roblox_Users_Api_DescriptionRequest = z.object({
 });
 const Roblox_Users_Api_GenderResponse = z.object({ gender: z.number().int() });
 const Roblox_Users_Api_GenderRequest = z.object({
-  gender: z.union([z.literal(1), z.literal(2), z.literal(3)]),
+  gender: z.enum(["Unknown", "Male", "Female"]),
 });
 const Roblox_Users_Api_GetUserResponse = z.object({
   description: z.string(),

package/lib/endpoints/usersv1.js

@@ -23,7 +23,7 @@ const Roblox_Users_Api_DescriptionRequest = zod_1.z.object({
 });
 const Roblox_Users_Api_GenderResponse = zod_1.z.object({ gender: zod_1.z.number().int() });
 const Roblox_Users_Api_GenderRequest = zod_1.z.object({
-    gender: zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(2), zod_1.z.literal(3)]),
+    gender: zod_1.z.enum(['Unknown', 'Male', 'Female']),
 });
 const Roblox_Users_Api_GetUserResponse = zod_1.z.object({
     description: zod_1.z.string(),

package/lib/index.d.ts

@@ -18,6 +18,7 @@ type EndpointBase = {
         status: number;
         description?: string;
     }[];
+    scopes?: string[];
 };
 export type EndpointSchema = EndpointBase & {
     parameters?: any;

package/lib/index.js

@@ -95,9 +95,35 @@ function prepareRequestUrl(endpoint, extendedParams) {
     return endpoint.baseUrl + processedPath + query;
 }
 function prepareRequestBody(method, requestFormat, body, headers) {
-    if (method !== 'GET' && requestFormat === 'json') {
-        body = JSON.stringify(body);
-        headers.set('content-type', 'application/json');
+    if (method !== 'GET') {
+        switch (requestFormat) {
+            case 'json':
+                body = JSON.stringify(body);
+                headers.set('content-type', 'application/json');
+                break;
+            case 'form-data': {
+                const formData = new FormData();
+                for (const [key, value] of Object.entries(body)) {
+                    if (value instanceof Blob) {
+                        formData.append(key, value);
+                    }
+                    else if (typeof value === 'string') {
+                        formData.append(key, value);
+                    }
+                    else {
+                        formData.append(key, JSON.stringify(value));
+                    }
+                }
+                body = formData;
+                break;
+            }
+            case 'text':
+                headers.set('content-type', 'text/plain');
+                break;
+            default:
+                requestFormat;
+                throw new Error(`Unsupported request format: ${requestFormat}`);
+        }
     }
     return body;
 }

package/lib/opencloud/v1/asset-permissions.d.ts

@@ -1,8 +1,13 @@
 /**
- * @api PATCH https://apis.roblox.com/cloud/asset-permissions-api/v1/assets/permissions
- * @summary Grant a subject permission to multiple assets.
+ * `BETA`
+ *
+ * Grant a subject permission to multiple assets.
             
 Authorization is required to grant permissions to the subject and asset IDs in the request.
+ *
+ * **Scopes:** `asset-permissions:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  */
 export declare const patchAssetPermissionsApiV1AssetsPermissions: import("../..").EndpointGeneric<{}, {

package/lib/opencloud/v1/asset-permissions.js

@@ -41,16 +41,22 @@ const BatchGrantPermissionsResponse = zod_1.z.object({
 const Error = zod_1.z.object({ code: ErrorCode, message: zod_1.z.string().nullable() });
 const ErrorResponse = zod_1.z.object({ error: Error });
 /**
- * @api PATCH https://apis.roblox.com/cloud/asset-permissions-api/v1/assets/permissions
- * @summary Grant a subject permission to multiple assets.
+ * `BETA`
+ *
+ * Grant a subject permission to multiple assets.
             
 Authorization is required to grant permissions to the subject and asset IDs in the request.
+ *
+ * **Scopes:** `asset-permissions:write`
+ * **Engine:** Not available in-engine
+ *
  * @param body
  */
 exports.patchAssetPermissionsApiV1AssetsPermissions = (0, __1.endpoint)({
     method: 'PATCH',
     path: '/asset-permissions-api/v1/assets/permissions',
-    baseUrl: 'https://apis.roblox.com/cloud',
+    baseUrl: 'https://apis.roblox.com',
+    scopes: ['asset-permissions:write'],
     requestFormat: 'json',
     serializationMethod: {
         body: {},

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

@@ -1,12 +1,15 @@
 /**
- * @api POST https://apis.roblox.com/cloud/v1/assets
- * @summary Creates an asset with provided content and metadata.
- * @param body
- * @description Creates an asset with provided content and metadata.
+ * **Create Asset** · `BETA`
+ *
+ * Creates an asset with provided content and metadata.
 
 You can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).
 
 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.
+ *
+ * **Scopes:** `asset:read`, `asset:write`
+ *
+ * @param body
  */
 export declare const postAssets: import("../..").EndpointGeneric<{}, {
     path: string;
@@ -79,11 +82,14 @@ export declare const postAssets: import("../..").EndpointGeneric<{}, {
     fileContent: File;
 }>;
 /**
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId
- * @summary Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.
+ * **Get Asset** · `BETA`
+ *
+ * Retrieve specific asset metadata.
+ *
+ * **Scopes:** `asset:read`
+ *
  * @param assetId The unique identifier of the asset.
  * @param readMask Asset metadata fields to retrieve, including the description, display name, icon, social links, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
- * @description Retrieve specific asset metadata.
  */
 export declare const getAssetsAssetId: import("../..").EndpointGeneric<{
     assetId: string;
@@ -119,14 +125,17 @@ export declare const getAssetsAssetId: import("../..").EndpointGeneric<{
     };
 }, undefined>;
 /**
- * @api PATCH https://apis.roblox.com/cloud/v1/assets/:assetId
- * @summary Updates an asset with provided content and metadata.
+ * **Update Asset** · `BETA`
+ *
+ * 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.
+
+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.
+ *
+ * **Scopes:** `asset:read`, `asset:write`
+ *
  * @param body
  * @param assetId The unique identifier of the asset.
  * @param updateMask Asset metadata fields to update, including the description, display name, icon, and previews. Examples: `description%2CdisplayName`, `previews%2CtwitchSocialLink`.
- * @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.
-
-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.
  */
 export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
     assetId: string;
@@ -202,10 +211,13 @@ export declare const patchAssetsAssetId: import("../..").EndpointGeneric<{
     fileContent: File;
 }>;
 /**
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:archive
- * @summary Archives the asset.
+ * **Archive Asset** · `BETA`
+ *
+ * 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.
+ *
+ * **Scopes:** `asset:read`, `asset:write`
+ *
  * @param assetId The unique identifier of the asset.
- * @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.
  */
 export declare const postAssetsAssetIdArchive: import("../..").EndpointGeneric<{
     assetId: string;
@@ -240,10 +252,13 @@ export declare const postAssetsAssetIdArchive: import("../..").EndpointGeneric<{
     };
 }, undefined>;
 /**
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId:restore
- * @summary Restores an archived asset.
+ * **Restore Asset** · `BETA`
+ *
+ * Restores an archived asset.
+ *
+ * **Scopes:** `asset:read`, `asset:write`
+ *
  * @param assetId The unique identifier of the asset.
- * @description Restores an archived asset.
  */
 export declare const postAssetsAssetIdRestore: import("../..").EndpointGeneric<{
     assetId: string;
@@ -278,12 +293,15 @@ export declare const postAssetsAssetIdRestore: import("../..").EndpointGeneric<{
     };
 }, undefined>;
 /**
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions
- * @summary List Asset Versions of an Asset
+ * **List Asset Versions** · `BETA`
+ *
+ * List all versions of a specific asset, with optional pagination.
+ *
+ * **Scopes:** `asset:read`
+ *
  * @param assetId The unique identifier of the asset.
  * @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.
  * @param pageToken A token for pagination. The value is obtained from a previous request and allows for retrieving the next page of asset versions.
- * @description List all versions of a specific asset, with optional pagination.
  */
 export declare const getAssetsAssetIdVersions: import("../..").EndpointGeneric<{
     assetId: string;
@@ -305,13 +323,16 @@ export declare const getAssetsAssetIdVersions: import("../..").EndpointGeneric<{
     published: boolean;
 }[], undefined>;
 /**
- * @api POST https://apis.roblox.com/cloud/v1/assets/:assetId/versions:rollback
- * @summary Rollback an asset to a previous version.
- * @param body
- * @param assetId The unique identifier of the asset.
- * @description Rollback an asset to a specific previous version.
+ * **Rollback Asset Version** · `BETA`
+ *
+ * Rollback an asset to a specific previous version.
 
  Provide the asset version path in the form data.
+ *
+ * **Scopes:** `asset:read`, `asset:write`
+ *
+ * @param body
+ * @param assetId The unique identifier of the asset.
  */
 export declare const postAssetsAssetIdVersionsRollback: import("../..").EndpointGeneric<{
     assetId: string;
@@ -333,11 +354,14 @@ export declare const postAssetsAssetIdVersionsRollback: import("../..").Endpoint
     assetVersion: string;
 }>;
 /**
- * @api GET https://apis.roblox.com/cloud/v1/assets/:assetId/versions/:versionNumber
- * @summary Get Asset Version
+ * **Get Asset Version** · `BETA`
+ *
+ * Retrieve a specific asset version by the asset ID and the version number.
+ *
+ * **Scopes:** `asset:read`
+ *
  * @param assetId The unique identifier of the asset.
  * @param versionNumber The version number.
- * @description Retrieve a specific asset version by the asset ID and the version number.
  */
 export declare const getAssetsAssetIdVersionsVersionNumber: import("../..").EndpointGeneric<{
     assetId: string;
@@ -358,10 +382,13 @@ export declare const getAssetsAssetIdVersionsVersionNumber: import("../..").Endp
     published: boolean;
 }, undefined>;
 /**
- * @api GET https://apis.roblox.com/cloud/v1/operations/:operationId
- * @summary Get the result of an asset creation or update.
+ * **Get Operation** · `BETA`
+ *
+ * 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.
+ *
+ * **Scopes:** `asset:read`
+ *
  * @param operationId The unique identifier of the operation.
- * @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.
  */
 export declare const getOperationsOperationId: import("../..").EndpointGeneric<{
     operationId: string;