rozod 6.7.1 → 6.9.0

package/lib/endpoints/friendsv1.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserUseridMultigetAreTrustedFriends = exports.getMyTrustedFriendsUseridStatus = exports.getUsersUseridTrustedFriendsCount = 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.getMyTrustedFriendsCount = exports.getMyNewFriendRequestsCount = exports.deleteMyNewFriendRequests = exports.getMyFriendsRequests = exports.postMyFriendsRefreshQrSession = exports.getMyFriendsCount = exports.getMyFriendsUseridCheckQrSession = exports.getMetadata = exports.postContactsTargetcontactidRequestFriendship = void 0;
+exports.postUsersTargetuseridUnfriend = exports.postUsersTargetuseridRequestFriendship = exports.postUsersSenderuseridAcceptFriendRequestWithToken = exports.postUsersRequesteruseridDeclineFriendRequest = exports.postUsersRequesteruseridAcceptFriendRequest = exports.postUserFriendRequestsDeclineAll = exports.deleteMyNewFriendRequests = exports.postContactsTargetcontactidRequestFriendship = exports.getUserUseridMultigetAreTrustedFriends = exports.getMyTrustedFriendsUseridStatus = exports.getUsersUseridTrustedFriendsCount = exports.getUsersUseridFriendsStatuses = exports.getUsersUseridFriendsSearch = exports.getUsersUseridFriendsOnline = exports.getUsersUseridFriendsInactive = exports.getUsersUseridFriendsFind = exports.getUsersUseridFriendsCount = exports.getUsersUseridFriends = exports.postUsersTargetuseridUnfollow = exports.getUsersTargetuseridFollowingsCount = exports.getUsersTargetuseridFollowings = exports.getUsersTargetuseridFollowersCount = exports.getUsersTargetuseridFollowers = exports.postUsersTargetuseridFollow = exports.getUserFriendRequestsCount = exports.postUserFollowingExists = exports.postUserUseridMultigetAreFriends = exports.getMyTrustedFriendsCount = exports.getMyNewFriendRequestsCount = exports.getMyFriendsRequests = exports.postMyFriendsRefreshQrSession = exports.getMyFriendsCount = exports.getMyFriendsUseridCheckQrSession = exports.getMetadata = void 0;
 const zod_1 = require("zod");
 const __1 = require("..");
 const Roblox_Friends_Api_Models_Response_FriendsPageMetadataResponse = zod_1.z.object({
@@ -30,6 +30,7 @@ const Roblox_Friends_Api_FriendRequest = zod_1.z.object({
         'PhoneContactImporter',
         'FriendRecommendations',
         'UserCommunities',
+        'TrustedFriend',
     ]),
     contactName: zod_1.z.string(),
     senderNickname: zod_1.z.string(),
@@ -118,10 +119,6 @@ const Roblox_Friends_Api_FriendStatusResponse = zod_1.z.object({
 const Roblox_Web_WebAPI_Models_ApiArrayResponse_Roblox_Friends_Api_FriendStatusResponse_ = zod_1.z.object({
     data: zod_1.z.array(Roblox_Friends_Api_FriendStatusResponse),
 });
-const Roblox_Friends_Api_CaptchaStatusResponseModel = zod_1.z.object({
-    success: zod_1.z.boolean(),
-    isCaptchaRequired: zod_1.z.boolean(),
-});
 const Roblox_Friends_Api_Models_Response_RefreshQrSessionResponse = zod_1.z.object({
     Success: zod_1.z.boolean(),
 });
@@ -142,79 +139,17 @@ const Roblox_Friends_Api_Models_Response_FollowingExistsResponse = zod_1.z.objec
 const Roblox_Friends_Api_Models_Response_FollowingExistsResponseModel = zod_1.z.object({
     followings: zod_1.z.array(Roblox_Friends_Api_Models_Response_FollowingExistsResponse),
 });
-const Roblox_Friends_Api_Models_Response_DeclineAllFriendRequestsResponse = zod_1.z.object({ backgrounded: zod_1.z.boolean() });
-const Roblox_Web_WebAPI_ApiEmptyResponseModel = zod_1.z.object({});
-const Roblox_Friends_Api_Models_Request_FriendingTokenRequestModel = zod_1.z.object({
-    friendingToken: zod_1.z.string(),
-});
 const Roblox_Web_Captcha_Models_Request_CaptchaTokenRequest = zod_1.z.object({
     captchaId: zod_1.z.string(),
     captchaToken: zod_1.z.string(),
     captchaProvider: zod_1.z.string(),
     challengeId: zod_1.z.string(),
 });
-const Roblox_Friends_Api_FriendshipRequestModel = zod_1.z.object({
-    friendshipOriginSourceType: zod_1.z.enum([
-        'Unknown',
-        'PlayerSearch',
-        'QrCode',
-        'InGame',
-        'UserProfile',
-        'QqContactImporter',
-        'WeChatContactImporter',
-        'ProfileShare',
-        'PhoneContactImporter',
-        'FriendRecommendations',
-        'UserCommunities',
-    ]),
-    senderNickname: zod_1.z.string(),
-});
-const Roblox_Friends_Api_Models_Response_ClearNewFriendRequestResponse = zod_1.z.object({ status: zod_1.z.boolean() });
-/**
- * @api POST https://friends.roblox.com/v1/contacts/:targetContactId/request-friendship
- * @summary Send a contact friend request to target user
- * @param targetContactId The target contact Id for friend request
- */
-exports.postContactsTargetcontactidRequestFriendship = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/contacts/:targetContactId/request-friendship',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        targetContactId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        targetContactId: zod_1.z.string(),
-    },
-    response: Roblox_Friends_Api_CaptchaStatusResponseModel,
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.
-5: The target user is already a friend.
-6: Invalid parameters.
-7: The user cannot be friends with itself.
-31: User with max friends sent friend request.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed
-2: The user is banned from performing operation.
-3: The user is blocked from performing this action.
-14: The user has not passed the captcha.`,
-        },
-        {
-            status: 429,
-            description: `9: The flood limit has been exceeded.`,
-        },
-    ],
+const Roblox_Friends_Api_CaptchaStatusResponseModel = zod_1.z.object({
+    success: zod_1.z.boolean(),
+    isCaptchaRequired: zod_1.z.boolean(),
 });
+const Roblox_Web_WebAPI_ApiEmptyResponseModel = zod_1.z.object({});
 /**
  * @api GET https://friends.roblox.com/v1/metadata
  * @param targetUserId
@@ -360,26 +295,6 @@ exports.getMyFriendsRequests = (0, __1.endpoint)({
         },
     ],
 });
-/**
- * @api DELETE https://friends.roblox.com/v1/my/new-friend-requests
- */
-exports.deleteMyNewFriendRequests = (0, __1.endpoint)({
-    method: 'DELETE',
-    path: '/v1/my/new-friend-requests',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    response: zod_1.z.object({ status: zod_1.z.boolean() }),
-    errors: [
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed`,
-        },
-    ],
-});
 /**
  * @api GET https://friends.roblox.com/v1/my/new-friend-requests/count
  */
@@ -498,143 +413,6 @@ exports.getUserFriendRequestsCount = (0, __1.endpoint)({
         },
     ],
 });
-/**
- * @api POST https://friends.roblox.com/v1/user/friend-requests/decline-all
- * @summary Decline all pending friend requests for the authenticated user.
- */
-exports.postUserFriendRequestsDeclineAll = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/user/friend-requests/decline-all',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    response: zod_1.z.object({ backgrounded: zod_1.z.boolean() }),
-    errors: [
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed`,
-        },
-    ],
-});
-/**
- * @api POST https://friends.roblox.com/v1/users/:requesterUserId/accept-friend-request
- * @summary Accept a friend request.
- * @param requesterUserId The user Id of the requester
- */
-exports.postUsersRequesteruseridAcceptFriendRequest = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/users/:requesterUserId/accept-friend-request',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        requesterUserId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        requesterUserId: zod_1.z.number().int(),
-    },
-    response: zod_1.z.object({}),
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.
-10: The friend request does not exist.
-11: The current users friends limit has been exceeded.
-12: The target users friends limit has been exceeded.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed
-3: The user is blocked from performing this action.`,
-        },
-    ],
-});
-/**
- * @api POST https://friends.roblox.com/v1/users/:requesterUserId/decline-friend-request
- * @summary Decline a friend request.
- * @param requesterUserId The user Id of the requester
- */
-exports.postUsersRequesteruseridDeclineFriendRequest = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/users/:requesterUserId/decline-friend-request',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        requesterUserId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        requesterUserId: zod_1.z.number().int(),
-    },
-    response: zod_1.z.object({}),
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.
-10: The friend request does not exist.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed`,
-        },
-    ],
-});
-/**
- * @api POST https://friends.roblox.com/v1/users/:senderUserId/accept-friend-request-with-token
- * @summary Accept a friend request with an Off Network Friending token.
- * @param body
- * @param senderUserId The user id of the sender of the off network friend request
- */
-exports.postUsersSenderuseridAcceptFriendRequestWithToken = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/users/:senderUserId/accept-friend-request-with-token',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        body: {},
-        senderUserId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        senderUserId: zod_1.z.number().int(),
-    },
-    body: zod_1.z.object({ friendingToken: zod_1.z.string() }),
-    response: zod_1.z.object({}),
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.
-3: The user is blocked from performing this action.
-5: The target user is already a friend.
-6: Invalid parameters.
-7: The user cannot be friends with itself.
-11: The current users friends limit has been exceeded.
-12: The target users friends limit has been exceeded.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed`,
-        },
-    ],
-});
 /**
  * @api POST https://friends.roblox.com/v1/users/:targetUserId/follow
  * @summary Creates the following between a user and user with targetUserId
@@ -847,57 +625,6 @@ exports.getUsersTargetuseridFollowingsCount = (0, __1.endpoint)({
         },
     ],
 });
-/**
- * @api POST https://friends.roblox.com/v1/users/:targetUserId/request-friendship
- * @summary Send a friend request to target user
- * @param body The source which the friend request originated from
- * @param targetUserId The target user Id for friend request
- */
-exports.postUsersTargetuseridRequestFriendship = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/users/:targetUserId/request-friendship',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        body: {},
-        targetUserId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        targetUserId: zod_1.z.number().int(),
-    },
-    body: Roblox_Friends_Api_FriendshipRequestModel,
-    response: Roblox_Friends_Api_CaptchaStatusResponseModel,
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.
-5: The target user is already a friend.
-6: Invalid parameters.
-7: The user cannot be friends with itself.
-10: The friend request does not exist.
-13: The users are not in the same game.
-31: User with max friends sent friend request.
-35: Invalid nickname.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed
-2: The user is banned from performing operation.
-3: The user is blocked from performing this action.
-14: The user has not passed the captcha.`,
-        },
-        {
-            status: 429,
-            description: `9: The flood limit has been exceeded.`,
-        },
-    ],
-});
 /**
  * @api POST https://friends.roblox.com/v1/users/:targetUserId/unfollow
  * @summary Deletes the following between a user and user with targetUserId
@@ -941,40 +668,6 @@ exports.postUsersTargetuseridUnfollow = (0, __1.endpoint)({
         },
     ],
 });
-/**
- * @api POST https://friends.roblox.com/v1/users/:targetUserId/unfriend
- * @summary Unfriend a user
- * @param targetUserId The target user id to unfriend
- */
-exports.postUsersTargetuseridUnfriend = (0, __1.endpoint)({
-    method: 'POST',
-    path: '/v1/users/:targetUserId/unfriend',
-    baseUrl: 'https://friends.roblox.com',
-    requestFormat: 'json',
-    serializationMethod: {
-        targetUserId: {
-            style: 'simple',
-        },
-    },
-    parameters: {
-        targetUserId: zod_1.z.number().int(),
-    },
-    response: zod_1.z.object({}),
-    errors: [
-        {
-            status: 400,
-            description: `1: The target user is invalid or does not exist.`,
-        },
-        {
-            status: 401,
-            description: `0: Authorization has been denied for this request.`,
-        },
-        {
-            status: 403,
-            description: `0: Token Validation Failed`,
-        },
-    ],
-});
 /**
  * @api GET https://friends.roblox.com/v1/users/:userId/friends
  * @summary Get list of all friends for the specified user.
@@ -1299,3 +992,210 @@ exports.getUserUseridMultigetAreTrustedFriends = (0, __1.endpoint)({
     response: Patch_MultigetAreTrustedFriendsResponse,
     errors: [{ status: 400, description: `1: The target user is invalid or does not exist.` }],
 });
+// Friend-management write endpoints Roblox removed from its published API docs but
+// which remain functional. Not on the official deprecated-endpoints list; the docs
+// only list the older /api/friends/* and api.roblox.com/user/* variants as removed.
+const Patch_FriendshipRequestModel = zod_1.z.object({
+    friendshipOriginSourceType: zod_1.z.enum([
+        'Unknown',
+        'PlayerSearch',
+        'QrCode',
+        'InGame',
+        'UserProfile',
+        'QqContactImporter',
+        'WeChatContactImporter',
+        'ProfileShare',
+        'PhoneContactImporter',
+        'FriendRecommendations',
+        'UserCommunities',
+    ]),
+    senderNickname: zod_1.z.string(),
+});
+exports.postContactsTargetcontactidRequestFriendship = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/contacts/:targetContactId/request-friendship',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        targetContactId: { style: 'simple' },
+    },
+    parameters: {
+        targetContactId: zod_1.z.string(),
+    },
+    response: Roblox_Friends_Api_CaptchaStatusResponseModel,
+    errors: [
+        {
+            status: 400,
+            description: `1: The target user is invalid or does not exist.
+5: The target user is already a friend.
+6: Invalid parameters.
+7: The user cannot be friends with itself.
+31: User with max friends sent friend request.`,
+        },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        {
+            status: 403,
+            description: `0: Token Validation Failed
+2: The user is banned from performing operation.
+3: The user is blocked from performing this action.
+14: The user has not passed the captcha.`,
+        },
+        { status: 429, description: `9: The flood limit has been exceeded.` },
+    ],
+});
+exports.deleteMyNewFriendRequests = (0, __1.endpoint)({
+    method: 'DELETE',
+    path: '/v1/my/new-friend-requests',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    response: zod_1.z.object({ status: zod_1.z.boolean() }),
+    errors: [
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        { status: 403, description: `0: Token Validation Failed` },
+    ],
+});
+exports.postUserFriendRequestsDeclineAll = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/user/friend-requests/decline-all',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    response: zod_1.z.object({ backgrounded: zod_1.z.boolean() }),
+    errors: [
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        { status: 403, description: `0: Token Validation Failed` },
+    ],
+});
+exports.postUsersRequesteruseridAcceptFriendRequest = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/users/:requesterUserId/accept-friend-request',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        requesterUserId: { style: 'simple' },
+    },
+    parameters: {
+        requesterUserId: zod_1.z.number().int(),
+    },
+    response: zod_1.z.object({}),
+    errors: [
+        {
+            status: 400,
+            description: `1: The target user is invalid or does not exist.
+10: The friend request does not exist.
+11: The current users friends limit has been exceeded.
+12: The target users friends limit has been exceeded.`,
+        },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        {
+            status: 403,
+            description: `0: Token Validation Failed
+3: The user is blocked from performing this action.`,
+        },
+    ],
+});
+exports.postUsersRequesteruseridDeclineFriendRequest = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/users/:requesterUserId/decline-friend-request',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        requesterUserId: { style: 'simple' },
+    },
+    parameters: {
+        requesterUserId: zod_1.z.number().int(),
+    },
+    response: zod_1.z.object({}),
+    errors: [
+        {
+            status: 400,
+            description: `1: The target user is invalid or does not exist.
+10: The friend request does not exist.`,
+        },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        { status: 403, description: `0: Token Validation Failed` },
+    ],
+});
+exports.postUsersSenderuseridAcceptFriendRequestWithToken = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/users/:senderUserId/accept-friend-request-with-token',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+        senderUserId: { style: 'simple' },
+    },
+    parameters: {
+        senderUserId: zod_1.z.number().int(),
+    },
+    body: zod_1.z.object({ friendingToken: zod_1.z.string() }),
+    response: zod_1.z.object({}),
+    errors: [
+        {
+            status: 400,
+            description: `1: The target user is invalid or does not exist.
+3: The user is blocked from performing this action.
+5: The target user is already a friend.
+6: Invalid parameters.
+7: The user cannot be friends with itself.
+11: The current users friends limit has been exceeded.
+12: The target users friends limit has been exceeded.`,
+        },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        { status: 403, description: `0: Token Validation Failed` },
+    ],
+});
+exports.postUsersTargetuseridRequestFriendship = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/users/:targetUserId/request-friendship',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        body: {},
+        targetUserId: { style: 'simple' },
+    },
+    parameters: {
+        targetUserId: zod_1.z.number().int(),
+    },
+    body: Patch_FriendshipRequestModel,
+    response: Roblox_Friends_Api_CaptchaStatusResponseModel,
+    errors: [
+        {
+            status: 400,
+            description: `1: The target user is invalid or does not exist.
+5: The target user is already a friend.
+6: Invalid parameters.
+7: The user cannot be friends with itself.
+10: The friend request does not exist.
+13: The users are not in the same game.
+31: User with max friends sent friend request.
+35: Invalid nickname.`,
+        },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        {
+            status: 403,
+            description: `0: Token Validation Failed
+2: The user is banned from performing operation.
+3: The user is blocked from performing this action.
+14: The user has not passed the captcha.`,
+        },
+        { status: 429, description: `9: The flood limit has been exceeded.` },
+    ],
+});
+exports.postUsersTargetuseridUnfriend = (0, __1.endpoint)({
+    method: 'POST',
+    path: '/v1/users/:targetUserId/unfriend',
+    baseUrl: 'https://friends.roblox.com',
+    requestFormat: 'json',
+    serializationMethod: {
+        targetUserId: { style: 'simple' },
+    },
+    parameters: {
+        targetUserId: zod_1.z.number().int(),
+    },
+    response: zod_1.z.object({}),
+    errors: [
+        { status: 400, description: `1: The target user is invalid or does not exist.` },
+        { status: 401, description: `0: Authorization has been denied for this request.` },
+        { status: 403, description: `0: Token Validation Failed` },
+    ],
+});